UNPKG

1.4 kBTypeScriptView Raw
1import { DsnComponents, DsnLike, DsnProtocol } from '@sentry/types';
2/** The Sentry Dsn, identifying a Sentry instance and project. */
3export declare class Dsn implements DsnComponents {
4 /** Protocol used to connect to Sentry. */
5 protocol: DsnProtocol;
6 /** Public authorization key (deprecated, renamed to publicKey). */
7 user: string;
8 /** Public authorization key. */
9 publicKey: string;
10 /** Private authorization key (deprecated, optional). */
11 pass: string;
12 /** Hostname of the Sentry instance. */
13 host: string;
14 /** Port of the Sentry instance. */
15 port: string;
16 /** Path */
17 path: string;
18 /** Project ID */
19 projectId: string;
20 /** Creates a new Dsn component */
21 constructor(from: DsnLike);
22 /**
23 * Renders the string representation of this Dsn.
24 *
25 * By default, this will render the public representation without the password
26 * component. To get the deprecated private representation, set `withPassword`
27 * to true.
28 *
29 * @param withPassword When set to true, the password will be included.
30 */
31 toString(withPassword?: boolean): string;
32 /** Parses a string into this Dsn. */
33 private _fromString;
34 /** Maps Dsn components into this instance. */
35 private _fromComponents;
36 /** Validates this Dsn and throws on error. */
37 private _validate;
38}
39//# sourceMappingURL=dsn.d.ts.map
\No newline at end of file