UNPKG

1.32 kBTypeScriptView Raw
1/** Supported Sentry transport protocols in a Dsn. */
2export declare type DsnProtocol = 'http' | 'https';
3/** Primitive components of a Dsn. */
4export interface DsnComponents {
5 /** Protocol used to connect to Sentry. */
6 protocol: DsnProtocol;
7 /** Public authorization key (deprecated, renamed to publicKey). */
8 user?: string;
9 /** Public authorization key. */
10 publicKey?: string;
11 /** Private authorization key (deprecated, optional). */
12 pass?: string;
13 /** Hostname of the Sentry instance. */
14 host: string;
15 /** Port of the Sentry instance. */
16 port?: string;
17 /** Sub path/ */
18 path?: string;
19 /** Project ID */
20 projectId: string;
21}
22/** Anything that can be parsed into a Dsn. */
23export declare type DsnLike = string | DsnComponents;
24/** The Sentry Dsn, identifying a Sentry instance and project. */
25export interface Dsn extends DsnComponents {
26 /**
27 * Renders the string representation of this Dsn.
28 *
29 * By default, this will render the public representation without the password
30 * component. To get the deprecated private representation, set `withPassword`
31 * to true.
32 *
33 * @param withPassword When set to true, the password will be included.
34 */
35 toString(withPassword: boolean): string;
36}
37//# sourceMappingURL=dsn.d.ts.map
\No newline at end of file