init

node_modules/@microsoft/tsdoc/lib/beta/DeclarationReference.d.ts

@@ -0,0 +1,200 @@
+/**
+ * Represents a reference to a declaration.
+ * @beta
+ */
+export declare class DeclarationReference {
+    private _source;
+    private _navigation;
+    private _symbol;
+    constructor(source?: ModuleSource | GlobalSource, navigation?: Navigation.Locals | Navigation.Exports, symbol?: SymbolReference);
+    get source(): ModuleSource | GlobalSource | undefined;
+    get navigation(): Navigation.Locals | Navigation.Exports | undefined;
+    get symbol(): SymbolReference | undefined;
+    get isEmpty(): boolean;
+    static parse(text: string): DeclarationReference;
+    static parseComponent(text: string): Component;
+    /**
+     * Determines whether the provided string is a well-formed symbol navigation component string.
+     */
+    static isWellFormedComponentString(text: string): boolean;
+    /**
+     * Escapes a string for use as a symbol navigation component. If the string contains any of `!.#~:,"{}()@` or starts
+     * with `[`, it is enclosed in quotes.
+     */
+    static escapeComponentString(text: string): string;
+    /**
+     * Unescapes a string used as a symbol navigation component.
+     */
+    static unescapeComponentString(text: string): string;
+    /**
+     * Determines whether the provided string is a well-formed module source string. The string may not
+     * have a trailing `!` character.
+     */
+    static isWellFormedModuleSourceString(text: string): boolean;
+    /**
+     * Escapes a string for use as a module source. If the string contains any of `!"` it is enclosed in quotes.
+     */
+    static escapeModuleSourceString(text: string): string;
+    /**
+     * Unescapes a string used as a module source. The string may not have a trailing `!` character.
+     */
+    static unescapeModuleSourceString(text: string): string;
+    static empty(): DeclarationReference;
+    static package(packageName: string, importPath?: string): DeclarationReference;
+    static module(path: string, userEscaped?: boolean): DeclarationReference;
+    static global(): DeclarationReference;
+    static from(base: DeclarationReference | undefined): DeclarationReference;
+    withSource(source: ModuleSource | GlobalSource | undefined): DeclarationReference;
+    withNavigation(navigation: Navigation.Locals | Navigation.Exports | undefined): DeclarationReference;
+    withSymbol(symbol: SymbolReference | undefined): DeclarationReference;
+    withComponentPath(componentPath: ComponentPath): DeclarationReference;
+    withMeaning(meaning: Meaning | undefined): DeclarationReference;
+    withOverloadIndex(overloadIndex: number | undefined): DeclarationReference;
+    addNavigationStep(navigation: Navigation, component: ComponentLike): DeclarationReference;
+    toString(): string;
+}
+/**
+ * Indicates the symbol table from which to resolve the next symbol component.
+ * @beta
+ */
+export declare const enum Navigation {
+    Exports = ".",
+    Members = "#",
+    Locals = "~"
+}
+/**
+ * Represents a module.
+ * @beta
+ */
+export declare class ModuleSource {
+    readonly escapedPath: string;
+    private _path;
+    private _pathComponents;
+    constructor(path: string, userEscaped?: boolean);
+    get path(): string;
+    get packageName(): string;
+    get scopeName(): string;
+    get unscopedPackageName(): string;
+    get importPath(): string;
+    static fromScopedPackage(scopeName: string | undefined, unscopedPackageName: string, importPath?: string): ModuleSource;
+    static fromPackage(packageName: string, importPath?: string): ModuleSource;
+    private static _fromPackageName;
+    toString(): string;
+    private _getOrParsePathComponents;
+}
+/**
+ * Represents the global scope.
+ * @beta
+ */
+export declare class GlobalSource {
+    static readonly instance: GlobalSource;
+    private constructor();
+    toString(): string;
+}
+/**
+ * @beta
+ */
+export declare type Component = ComponentString | ComponentReference;
+/**
+ * @beta
+ */
+export declare namespace Component {
+    function from(value: ComponentLike): Component;
+}
+/**
+ * @beta
+ */
+export declare type ComponentLike = Component | DeclarationReference | string;
+/**
+ * @beta
+ */
+export declare class ComponentString {
+    readonly text: string;
+    constructor(text: string, userEscaped?: boolean);
+    toString(): string;
+}
+/**
+ * @beta
+ */
+export declare class ComponentReference {
+    readonly reference: DeclarationReference;
+    constructor(reference: DeclarationReference);
+    static parse(text: string): ComponentReference;
+    withReference(reference: DeclarationReference): ComponentReference;
+    toString(): string;
+}
+/**
+ * @beta
+ */
+export declare type ComponentPath = ComponentRoot | ComponentNavigation;
+/**
+ * @beta
+ */
+export declare abstract class ComponentPathBase {
+    readonly component: Component;
+    constructor(component: Component);
+    addNavigationStep(this: ComponentPath, navigation: Navigation, component: ComponentLike): ComponentPath;
+    abstract toString(): string;
+}
+/**
+ * @beta
+ */
+export declare class ComponentRoot extends ComponentPathBase {
+    withComponent(component: ComponentLike): ComponentRoot;
+    toString(): string;
+}
+/**
+ * @beta
+ */
+export declare class ComponentNavigation extends ComponentPathBase {
+    readonly parent: ComponentPath;
+    readonly navigation: Navigation;
+    constructor(parent: ComponentPath, navigation: Navigation, component: Component);
+    withParent(parent: ComponentPath): ComponentNavigation;
+    withNavigation(navigation: Navigation): ComponentNavigation;
+    withComponent(component: ComponentLike): ComponentNavigation;
+    toString(): string;
+}
+/**
+ * @beta
+ */
+export declare const enum Meaning {
+    Class = "class",
+    Interface = "interface",
+    TypeAlias = "type",
+    Enum = "enum",
+    Namespace = "namespace",
+    Function = "function",
+    Variable = "var",
+    Constructor = "constructor",
+    Member = "member",
+    Event = "event",
+    CallSignature = "call",
+    ConstructSignature = "new",
+    IndexSignature = "index",
+    ComplexType = "complex"
+}
+/**
+ * @beta
+ */
+export interface ISymbolReferenceOptions {
+    meaning?: Meaning;
+    overloadIndex?: number;
+}
+/**
+ * Represents a reference to a TypeScript symbol.
+ * @beta
+ */
+export declare class SymbolReference {
+    readonly componentPath: ComponentPath | undefined;
+    readonly meaning: Meaning | undefined;
+    readonly overloadIndex: number | undefined;
+    constructor(component: ComponentPath | undefined, { meaning, overloadIndex }?: ISymbolReferenceOptions);
+    static empty(): SymbolReference;
+    withComponentPath(componentPath: ComponentPath | undefined): SymbolReference;
+    withMeaning(meaning: Meaning | undefined): SymbolReference;
+    withOverloadIndex(overloadIndex: number | undefined): SymbolReference;
+    addNavigationStep(navigation: Navigation, component: ComponentLike): SymbolReference;
+    toString(): string;
+}
+//# sourceMappingURL=DeclarationReference.d.ts.map

node_modules/@microsoft/tsdoc/lib/beta/DeclarationReference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclarationReference.d.ts","sourceRoot":"","sources":["../../src/beta/DeclarationReference.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,OAAO,CAA0C;IACzD,OAAO,CAAC,WAAW,CAAqD;IACxE,OAAO,CAAC,OAAO,CAA8B;gBAG3C,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,EACpC,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,EACnD,MAAM,CAAC,EAAE,eAAe;IAO1B,IAAW,MAAM,IAAI,YAAY,GAAG,YAAY,GAAG,SAAS,CAE3D;IAED,IAAW,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,GAAG,SAAS,CAW1E;IAED,IAAW,MAAM,IAAI,eAAe,GAAG,SAAS,CAE/C;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;WAEa,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB;WAYzC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAQrD;;OAEG;WACW,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAShE;;;OAGG;WACW,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAWzD;;OAEG;WACW,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAc3D;;;OAGG;WACW,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAUnE;;OAEG;WACW,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAW5D;;OAEG;WACW,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;WAchD,KAAK,IAAI,oBAAoB;WAI7B,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,oBAAoB;WAIvE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,oBAAoB;WAIjE,MAAM,IAAI,oBAAoB;WAI9B,IAAI,CAAC,IAAI,EAAE,oBAAoB,GAAG,SAAS,GAAG,oBAAoB;IAIzE,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,GAAG,oBAAoB;IAIjF,cAAc,CACnB,UAAU,EAAE,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,GAAG,SAAS,GAC7D,oBAAoB;IAMhB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,GAAG,oBAAoB;IAIrE,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,oBAAoB;IAMrE,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,oBAAoB;IAU/D,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,oBAAoB;IAU1E,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,GAAG,oBAAoB;IAWzF,QAAQ,IAAI,MAAM;CAO1B;AAED;;;GAGG;AACH,0BAAkB,UAAU;IAC1B,OAAO,MAAM;IACb,OAAO,MAAM;IACb,MAAM,MAAM;CACb;AAED;;;GAGG;AACH,qBAAa,YAAY;IACvB,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,OAAO,CAAC,KAAK,CAAqB;IAElC,OAAO,CAAC,eAAe,CAA6B;gBAEjC,IAAI,EAAE,MAAM,EAAE,WAAW,GAAE,OAAc;IAK5D,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,SAAS,IAAI,MAAM,CAG7B;IAED,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;WAEa,iBAAiB,CAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,mBAAmB,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,GAClB,YAAY;WAaD,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY;IAIjF,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA4BxB,QAAQ,IAAI,MAAM;IAIzB,OAAO,CAAC,yBAAyB;CAiBlC;AA2CD;;;GAGG;AACH,qBAAa,YAAY;IACvB,gBAAuB,QAAQ,EAAE,YAAY,CAAsB;IAEnE,OAAO;IAEA,QAAQ,IAAI,MAAM;CAG1B;AAED;;GAEG;AACH,oBAAY,SAAS,GAAG,eAAe,GAAG,kBAAkB,CAAC;AAE7D;;GAEG;AAEH,yBAAiB,SAAS,CAAC;IACzB,SAAgB,IAAI,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,CAQpD;CACF;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,SAAS,GAAG,oBAAoB,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,qBAAa,eAAe;IAC1B,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO;IAI/C,QAAQ,IAAI,MAAM;CAG1B;AAID;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,SAAgB,SAAS,EAAE,oBAAoB,CAAC;gBAE7B,SAAS,EAAE,oBAAoB;WAIpC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB;IAO9C,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,kBAAkB;IAIlE,QAAQ,IAAI,MAAM;CAG1B;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,mBAAmB,CAAC;AAEhE;;GAEG;AACH,8BAAsB,iBAAiB;IACrC,SAAgB,SAAS,EAAE,SAAS,CAAC;gBAElB,SAAS,EAAE,SAAS;IAIhC,iBAAiB,CACtB,IAAI,EAAE,aAAa,EACnB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,aAAa,GACvB,aAAa;aAKA,QAAQ,IAAI,MAAM;CACnC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAC3C,aAAa,CAAC,SAAS,EAAE,aAAa,GAAG,aAAa;IAItD,QAAQ,IAAI,MAAM;CAG1B;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,SAAgB,MAAM,EAAE,aAAa,CAAC;IACtC,SAAgB,UAAU,EAAE,UAAU,CAAC;gBAEpB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS;IAM/E,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,mBAAmB;IAItD,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,mBAAmB;IAM3D,aAAa,CAAC,SAAS,EAAE,aAAa,GAAG,mBAAmB;IAM5D,QAAQ,IAAI,MAAM;CAG1B;AAED;;GAEG;AACH,0BAAkB,OAAO;IACvB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,SAAS,SAAS;IAClB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,QAAQ,QAAQ;IAChB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,aAAa,SAAS;IACtB,kBAAkB,QAAQ;IAC1B,cAAc,UAAU;IACxB,WAAW,YAAY;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,SAAgB,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IACzD,SAAgB,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,SAAgB,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;gBAGhD,SAAS,EAAE,aAAa,GAAG,SAAS,EACpC,EAAE,OAAO,EAAE,aAAa,EAAE,GAAE,uBAA4B;WAO5C,KAAK,IAAI,eAAe;IAI/B,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,eAAe;IAS5E,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,eAAe;IAS1D,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,eAAe;IASrE,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,GAAG,eAAe;IAOpF,QAAQ,IAAI,MAAM;CAW1B"}

node_modules/@microsoft/tsdoc/lib/beta/__tests__/DeclarationReference.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DeclarationReference.test.d.ts.map

node_modules/@microsoft/tsdoc/lib/beta/__tests__/DeclarationReference.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclarationReference.test.d.ts","sourceRoot":"","sources":["../../../src/beta/__tests__/DeclarationReference.test.ts"],"names":[],"mappings":""}