vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update raygun definition (#16187)

Browse Source
This commit is contained in:
Benjamin 2017-04-29 05:48:29 +12:00 committed by Sheetal Nandi
parent 44b6460fec
commit b96c594235
2 changed files with 45 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
types/raygun4js/index.d.ts vendored
View File

@ -1,4 +1,4 @@
// Type definitions for raygun4js 2.4.2
// Type definitions for raygun4js 2.6.0
// Project: https://github.com/MindscapeHQ/raygun4js
// Definitions by: Brian Surowiec <https://github.com/xt0rted>, Benjamin Harding <https://github.com/BenjaminHarding>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@ -104,6 +104,11 @@ interface RaygunOptions {
* A string URI containing the protocol, domain and port (optional) where all payloads will be sent to. This can be used to proxy payloads to the Raygun API through your own server. When not set this defaults internally to the Raygun API, and for most usages you won't need to set this.
*/
apiEndpoint?: string;
/**
* String which can be optionally set "onLoad" which will then boot the RealUserMonitoring side instead of waiting for the `load` event.
*/
from?: string|"onLoad";
}
interface RaygunPayload {
@ -250,6 +255,26 @@ interface RaygunStatic {
* Track Single Page Application route events.
*/
trackEvent(type: "pageView", options: { path: string }): void;
/**
* Records a manual breadcrumb with the given message and metadata passed.
*/
recordBreadcrumb(message:string,metadata?:any): void;
/**
* Enables all breadcrumbs level or a type can be passed which will enable only that passed one.
*/
enableAutoBreadcrumbs(type?:"XHR"|"Clicks"|"Console"|"Navigation"): void;
/**
* Disables all breadcrumbs or a type can be passed to disable only that one.
*/
disableAutoBreadcrumbs(type?:"XHR"|"Clicks"|"Console"|"Navigation"): void;
/**
* Pass "breadcrumbsLevel" alongside a valid breadcrumbs level to set the current level. Passing options other than "breadcrumbsLevel" will set xhr hosts to ignore being
*/
setBreadcrumbOption(option?:string|"breadcrumbsLevel", value?:string|"debug"|"info"|"warning"|"error"): void;
}
interface RaygunV2UserDetails {
@ -298,6 +323,19 @@ interface RaygunV2 {
(key: "send"|"withCustomData", value: any): void;
(key: "getRaygunInstance"):RaygunStatic;
(key: "detach"): void;
(key: "disableAutoBreadcrumbs"): void;
(key: "enableAutoBreadcrumbs"): void;
(key: "disableAutoBreadcrumbsConsole"): void;
(key: "enableAutoBreadcrumbsConsole"): void;
(key: "disableAutoBreadcrumbsNavigation"): void;
(key: "enableAutoBreadcrumbsNavigation"): void;
(key: "disableAutoBreadcrumbsClicks"): void;
(key: "enableAutoBreadcrumbsClicks"): void;
(key: "disableAutoBreadcrumbsXHR"): void;
(key: "enableAutoBreadcrumbsXHR"): void;
(key: "setAutoBreadcrumbsXHRIgnoredHosts"): void;
(key: "setBreadcrumbLevel"): void;
(key: "recordBreadcrumb", message:string|{message:string,metadata:any,level:string|"debug"|"info"|"warning"|"error",location:string}, metadata:any): void;
(key: string):void;
}

6
types/raygun4js/raygun4js-tests.ts
View File

@ -79,3 +79,9 @@ client.endSession();
client.trackEvent('pageView', {
path: '/url'
});
client.disableAutoBreadcrumbs();
client.enableAutoBreadcrumbs();
client.recordBreadcrumb("Breadcrumb Message", { custom: "data" });