UNPKG

992 BTypeScriptView Raw
1import type { DsnComponents, DsnLike } from '@sentry/types';
2/**
3 * Renders the string representation of this Dsn.
4 *
5 * By default, this will render the public representation without the password
6 * component. To get the deprecated private representation, set `withPassword`
7 * to true.
8 *
9 * @param withPassword When set to true, the password will be included.
10 */
11export declare function dsnToString(dsn: DsnComponents, withPassword?: boolean): string;
12/**
13 * Parses a Dsn from a given string.
14 *
15 * @param str A Dsn as string
16 * @returns Dsn as DsnComponents or undefined if @param str is not a valid DSN string
17 */
18export declare function dsnFromString(str: string): DsnComponents | undefined;
19/**
20 * Creates a valid Sentry Dsn object, identifying a Sentry instance and project.
21 * @returns a valid DsnComponents object or `undefined` if @param from is an invalid DSN source
22 */
23export declare function makeDsn(from: DsnLike): DsnComponents | undefined;
24//# sourceMappingURL=dsn.d.ts.map
\No newline at end of file