-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add TypeScript type definitions (from DefinitelyTyped) #610
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
dc03a30
5cca6b3
fa413be
2bbe46e
c6ce3dc
cf23cd6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
import Raven, {RavenOptions} from '..'; | ||
|
||
Raven.config('https://public@getsentry.com/1').install(); | ||
|
||
var options: RavenOptions = { | ||
logger: 'my-logger', | ||
ignoreUrls: [ | ||
/graph\.facebook\.com/i, | ||
'graph.facebook.com' | ||
], | ||
ignoreErrors: [ | ||
/fb_xd_fragment/, | ||
'fb_xd_fragment' | ||
], | ||
includePaths: [ | ||
/https?:\/\/(www\.)?getsentry\.com/, | ||
'https://www.getsentry.com' | ||
], | ||
whitelistUrls: [ | ||
/https?:\/\/google\.com/, | ||
'https://www.google.com' | ||
] | ||
}; | ||
|
||
Raven.config('https://public@getsentry.com/1', 1).install(); | ||
|
||
var throwsError = () => { | ||
throw new Error('broken'); | ||
}; | ||
|
||
try { | ||
throwsError(); | ||
} catch(e) { | ||
Raven.captureException(e); | ||
Raven.captureException(e, {tags: { key: "value" }}); | ||
} | ||
|
||
Raven.context(throwsError); | ||
Raven.context({tags: { key: "value" }}, throwsError); | ||
|
||
setTimeout(Raven.wrap(throwsError), 1000); | ||
Raven.wrap({logger: "my.module"}, throwsError)(); | ||
|
||
Raven.setUserContext({ | ||
email: 'matt@example.com', | ||
id: '123' | ||
}); | ||
|
||
Raven.captureMessage('Broken!'); | ||
Raven.captureMessage('Broken!', {tags: { key: "value" }}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,195 @@ | ||
// Type definitions for Raven.js | ||
// Project: https://github.com/getsentry/raven-js | ||
// Definitions by: Santi Albo <https://github.com/santialbo/>, Benjamin Pannell <http://github.com/spartan563> | ||
|
||
declare var Raven: RavenStatic; | ||
|
||
export default Raven; | ||
|
||
export interface RavenOptions { | ||
/** The log level associated with this event. Default: error */ | ||
level?: string; | ||
|
||
/** The name of the logger used by Sentry. Default: javascript */ | ||
logger?: string; | ||
|
||
/** The release version of the application you are monitoring with Sentry */ | ||
release?: string; | ||
|
||
/** The name of the server or device that the client is running on */ | ||
serverName?: string; | ||
|
||
/** List of messages to be fitlered out before being sent to Sentry. */ | ||
ignoreErrors?: (RegExp | string)[]; | ||
|
||
/** Similar to ignoreErrors, but will ignore errors from whole urls patching a regex pattern. */ | ||
ignoreUrls?: (RegExp | string)[]; | ||
|
||
/** The inverse of ignoreUrls. Only report errors from whole urls matching a regex pattern. */ | ||
whitelistUrls?: (RegExp | string)[]; | ||
|
||
/** An array of regex patterns to indicate which urls are a part of your app. */ | ||
includePaths?: (RegExp | string)[]; | ||
|
||
/** Additional data to be tagged onto the error. */ | ||
tags?: { | ||
[id: string]: string; | ||
}; | ||
|
||
extra?: any; | ||
|
||
/** In some cases you may see issues where Sentry groups multiple events together when they should be separate entities. In other cases, Sentry simply doesn’t group events together because they’re so sporadic that they never look the same. */ | ||
fingerprint?: string[]; | ||
|
||
/** A function which allows mutation of the data payload right before being sent to Sentry */ | ||
dataCallback?: (data: any) => any; | ||
|
||
/** A callback function that allows you to apply your own filters to determine if the message should be sent to Sentry. */ | ||
shouldSendCallback?: (data: any) => boolean; | ||
|
||
/** By default, Raven does not truncate messages. If you need to truncate characters for whatever reason, you may set this to limit the length. */ | ||
maxMessageLength?: number; | ||
|
||
/** Override the default HTTP data transport handler. */ | ||
transport?: (options: RavenTransportOptions) => void; | ||
} | ||
|
||
export interface RavenStatic { | ||
|
||
/** Raven.js version. */ | ||
VERSION: string; | ||
|
||
Plugins: { [id: string]: RavenPlugin }; | ||
|
||
/* | ||
* Allow Raven to be configured as soon as it is loaded | ||
* It uses a global RavenConfig = {dsn: '...', config: {}} | ||
* | ||
* @return undefined | ||
*/ | ||
afterLoad(): void; | ||
|
||
/* | ||
* Allow multiple versions of Raven to be installed. | ||
* Strip Raven from the global context and returns the instance. | ||
* | ||
* @return {Raven} | ||
*/ | ||
noConflict(): RavenStatic; | ||
|
||
/* | ||
* Configure Raven with a DSN and extra options | ||
* | ||
* @param {string} dsn The public Sentry DSN | ||
* @param {object} options Optional set of of global options [optional] | ||
* @return {Raven} | ||
*/ | ||
config(dsn: string, options?: RavenOptions): RavenStatic; | ||
|
||
/* | ||
* Installs a global window.onerror error handler | ||
* to capture and report uncaught exceptions. | ||
* At this point, install() is required to be called due | ||
* to the way TraceKit is set up. | ||
* | ||
* @return {Raven} | ||
*/ | ||
install(): RavenStatic; | ||
|
||
/* | ||
* Adds a plugin to Raven | ||
* | ||
* @return {Raven} | ||
*/ | ||
addPlugin(plugin: RavenPlugin, ...pluginArgs: any[]): RavenStatic; | ||
|
||
/* | ||
* Wrap code within a context so Raven can capture errors | ||
* reliably across domains that is executed immediately. | ||
* | ||
* @param {object} options A specific set of options for this context [optional] | ||
* @param {function} func The callback to be immediately executed within the context | ||
* @param {array} args An array of arguments to be called with the callback [optional] | ||
*/ | ||
context(func: Function, ...args: any[]): void; | ||
context(options: RavenOptions, func: Function, ...args: any[]): void; | ||
|
||
/* | ||
* Wrap code within a context and returns back a new function to be executed | ||
* | ||
* @param {object} options A specific set of options for this context [optional] | ||
* @param {function} func The function to be wrapped in a new context | ||
* @return {function} The newly wrapped functions with a context | ||
*/ | ||
wrap(func: Function): Function; | ||
wrap(options: RavenOptions, func: Function): Function; | ||
wrap<T extends Function>(func: T): T; | ||
wrap<T extends Function>(options: RavenOptions, func: T): T; | ||
|
||
/* | ||
* Uninstalls the global error handler. | ||
* | ||
* @return {Raven} | ||
*/ | ||
uninstall(): RavenStatic; | ||
|
||
/* | ||
* Manually capture an exception and send it over to Sentry | ||
* | ||
* @param {error} ex An exception to be logged | ||
* @param {object} options A specific set of options for this error [optional] | ||
* @return {Raven} | ||
*/ | ||
captureException(ex: Error, options?: RavenOptions): RavenStatic; | ||
|
||
/* | ||
* Manually send a message to Sentry | ||
* | ||
* @param {string} msg A plain message to be captured in Sentry | ||
* @param {object} options A specific set of options for this message [optional] | ||
* @return {Raven} | ||
*/ | ||
captureMessage(msg: string, options?: RavenOptions): RavenStatic; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We allow anything as the first argument, and we just coerce it to a string. Again, similar vain as last comment, we might just want to enforce this in the type definition. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's better this way. You should do the coercion yourself, if you know what it is (and you do if TypeScript is complaining). |
||
|
||
/** | ||
* Clear the user context, removing the user data that would be sent to Sentry. | ||
*/ | ||
setUserContext(): RavenStatic; | ||
|
||
/* | ||
* Set a user to be sent along with the payload. | ||
* | ||
* @param {object} user An object representing user data [optional] | ||
* @return {Raven} | ||
*/ | ||
setUserContext(user: { | ||
id?: string; | ||
username?: string; | ||
email?: string; | ||
}): RavenStatic; | ||
|
||
/** Override the default HTTP data transport handler. */ | ||
setTransport(transportFunction: (options: RavenTransportOptions) => void): RavenStatic; | ||
|
||
/** An event id is a globally unique id for the event that was just sent. This event id can be used to find the exact event from within Sentry. */ | ||
lastEventId(): string; | ||
|
||
/** If you need to conditionally check if raven needs to be initialized or not, you can use the isSetup function. It will return true if Raven is already initialized. */ | ||
isSetup(): boolean; | ||
} | ||
|
||
interface RavenTransportOptions { | ||
url: string; | ||
data: any; | ||
auth: { | ||
sentry_version: string; | ||
sentry_client: string; | ||
sentry_key: string; | ||
}; | ||
onSuccess: () => void; | ||
onFailure: () => void; | ||
} | ||
|
||
interface RavenPlugin { | ||
(raven: RavenStatic, ...args: any[]): RavenStatic; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
captureException technically allows a string as first argument as well, and we fall back to captureMessage.
BUT this might be a good thing to enforce in the type definition. The fallback was done because things can throw strings and whatnot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll keep it as is. All this means is that the TypeScript type checker will stop you from writing
Raven.captureException('derp')
. It could still happen at run time and gracefully fallback as intended.