polish raven.d.ts

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+***Status:***
+- [ ] ready
+- [ ] work in progress
+- [ ] hold
+
+
+**What is the purpose of this PR?**
+
+
+**Is this related to an Issue? (If so, please link to it)**
+
+
+**How should this be manually tested?**
+
+
+***Checklist:***
+- [ ] I have included appropriate Tests and have run `npm test` without errors
+- [ ] I have updated the Documentation accordingly
+- [ ] I updated typings/raven.d.ts if I added to or changed the API and have run `tsc --noEmit --noImplicitAny typescript/raven-tests.ts` without errors
+
+Please note: If you are not able to fulfill these points by yourself, leave them unchecked. We are happy to help you with them.
+
+
+***Release Type:***
+- [ ] Major
+- [ ] Minor
+- [X] Patch

typescript/raven-tests.ts

@@ -1,6 +1,6 @@
-import Raven from "./raven"
-
+import Raven, {RavenOutgoingData} from "./raven"
 
+// configuring:
 Raven.config('https://[email protected]/1').install();
 
 Raven.config(
@@ -20,32 +20,54 @@ Raven.config(
     }
 ).install();
 
-var throwsError = () => {
-    throw new Error('broken');
-};
+Raven.setDataCallback((data: RavenOutgoingData) => {return data});
+Raven.setDataCallback(function (data: RavenOutgoingData, original: string) {return data});
+
+Raven.setShouldSendCallback((data: RavenOutgoingData)  => {return data});
+Raven.setShouldSendCallback(function (data: RavenOutgoingData, original: string) {return data});
 
-try {
-    throwsError();
-} catch(e) {
-    Raven.captureException(e);
-    Raven.captureException(e, {tags: { key: "value" }});
-}
 
+// context:
 Raven.context(throwsError);
 Raven.context({tags: { key: "value" }}, throwsError);
 Raven.context({extra: {planet: {name: 'Earth'}}}, throwsError);
 
-setTimeout(Raven.wrap(throwsError), 1000);
-Raven.wrap({logger: "my.module"}, throwsError)();
-Raven.wrap({tags: {git_commit: 'c0deb10c4'}}, throwsError)();
-
 Raven.setUserContext({
     email: '[email protected]',
     id: '123'
 });
 
+Raven.setExtraContext({foo: 'bar'});
+
+Raven.setTagsContext({env: 'prod'});
+
+Raven.clearContext();
+
+var obj:Object = Raven.getContext();
+
+Raven.setRelease('abc123');
+Raven.setEnvironment('production');
+
+setTimeout(Raven.wrap(throwsError), 1000);
+Raven.wrap({logger: "my.module"}, throwsError)();
+Raven.wrap({tags: {git_commit: 'c0deb10c4'}}, throwsError)();
+
+
+// reporting:
+var throwsError = () => {
+    throw new Error('broken');
+};
+
+try {
+    throwsError();
+} catch(e) {
+    Raven.captureException(e);
+    Raven.captureException(e, {tags: { key: "value" }});
+}
+
 Raven.captureMessage('Broken!');
 Raven.captureMessage('Broken!', {tags: { key: "value" }});
+Raven.captureMessage('Broken!', { stacktrace: true });
 
 Raven.showReportDialog({
     eventId: 0815,
@@ -56,6 +78,5 @@ Raven.showReportDialog({
     }
 });
 
-Raven.setTagsContext({ key: "value" });
 
-Raven.setExtraContext({ foo: "bar" });
+var err:Error = Raven.lastException();

typescript/raven.d.ts

@@ -152,19 +152,19 @@ interface RavenStatic {
      * Specify a callback function that can mutate or filter breadcrumbs when they are captured.
      * @param callback The function which applies the filter
      */
-    setBreadcrumbCallback(callback :(data: RavenBreadcrumb, orig?: string) => RavenBreadcrumb):RavenStatic;
+    setBreadcrumbCallback(callback: (data: RavenBreadcrumb, original?: string) => RavenBreadcrumb):RavenStatic;
 
     /**
      * Specify a function that can mutate the payload right before it is being sent to Sentry.
      * @param callback The function which can mutate the data
      */
-    setDataCallback(callback: (data: RavenOutgoingData, orig?: string) => RavenOutgoingData): RavenStatic;
+    setDataCallback(callback: (data: RavenOutgoingData, original?: string) => RavenOutgoingData): RavenStatic;
 
     /**
      * Specify a callback function that determines if the given message should be sent to Sentry.
      * @param callback The function which determines if the given blob should be sent
      */
-    setShouldSendCallback(callback: (data: RavenOutgoingData, orig?: string) => RavenOutgoingData): RavenStatic;
+    setShouldSendCallback(callback: (data: RavenOutgoingData, original?: string) => RavenOutgoingData): RavenStatic;
 
     /**
      * Override the default HTTP data transport handler.
@@ -196,7 +196,7 @@ interface RavenStatic {
 
 
 // --- Helper Interfaces for Options --------------
-export interface RavenBreadcrumOptions {
+export interface RavenBreadcrumbOptions {
     /** Whether to collect XHR calls, defaults to true */
     xhr?: boolean;
 
@@ -254,7 +254,7 @@ export interface RavenGlobalOptions extends CommonRavenOptions  {
     serverName?: string;
 
     /** Configures which breadcrumbs are collected automatically */
-    autoBreadcrumbs?: boolean | RavenBreadcrumOptions;
+    autoBreadcrumbs?: boolean | RavenBreadcrumbOptions;
 
     /** Whether to collect errors on the window via TraceKit.collectWindowErrors. Default: true. */
     collectWindowErrors?: boolean;