Class PullSymbol

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(name: string, declKind: PullElementKind): PullSymbol

Parameters

Returns

PullSymbol

Properties

private _container: any

private _declarations: any

private _docComments: any

private _enclosingSignature: any

public inResolution: boolean

public isOptional: boolean

public isPrinting: boolean

public isResolved: boolean

private isSynthesized: any

public isVarArg: boolean

public kind: PullElementKind

public name: string

public pullSymbolID: number

private rootSymbol: any

public type: PullTypeSymbol

Methods

public _getResolver(): PullTypeResolver

Returns

PullTypeResolver

public static _isExternalModuleReferenceAlias(aliasSymbol: PullTypeAliasSymbol): boolean

Parameters

Returns

boolean

public _resolveDeclaredSymbol(): PullSymbol

Returns

PullSymbol

public addDeclaration(decl: PullDecl)

Parameters

public allDeclsHaveFlag(flag: PullElementFlags): boolean

Parameters

Returns

boolean

public anyDeclHasFlag(flag: PullElementFlags): boolean

Parameters

Returns

boolean

private cleanDocCommentLine(line: any, jsDocStyleComment: any, jsDocLineSpaceToRemove?: any): any

Parameters

  • line: any
  • jsDocStyleComment: any
  • jsDocLineSpaceToRemove?: any optional

Returns

any

private cleanJSDocComment(content: any, spacesToRemove?: any): any

Parameters

  • content: any
  • spacesToRemove?: any optional

Returns

any

private consumeLeadingSpace(line: any, startIndex: any, maxSpacesToRemove?: any): any

Parameters

  • line: any
  • startIndex: any
  • maxSpacesToRemove?: any optional

Returns

any

public docComments(useConstructorAsClass?: boolean): string

Parameters

  • useConstructorAsClass?: boolean optional

Returns

string

private findAliasedTypeSymbols(scopeSymbol: any, skipScopeSymbolAliasesLookIn?: any, lookIntoOnlyExportedAlias?: any, aliasSymbols?: any, visitedScopeDeclarations?: any): any

Parameters

  • scopeSymbol: any
  • skipScopeSymbolAliasesLookIn?: any optional
  • lookIntoOnlyExportedAlias?: any optional
  • aliasSymbols?: any optional
  • visitedScopeDeclarations?: any optional

Returns

any

private findQualifyingSymbolPathInScopeSymbol(scopeSymbol: any): any

Parameters

  • scopeSymbol: any

Returns

any

public fullName(scopeSymbol?: PullSymbol): string

Parameters

Returns

string

public getAliasSymbolName(scopeSymbol: PullSymbol, aliasNameGetter: (symbol: TypeScript.PullTypeAliasSymbol) => string, aliasPartsNameGetter: (symbol: TypeScript.PullTypeAliasSymbol) => string, skipInternalAlias?: boolean): string

Parameters

  • scopeSymbol: PullSymbol
  • aliasNameGetter: (symbol: TypeScript.PullTypeAliasSymbol) => string
  • aliasPartsNameGetter: (symbol: TypeScript.PullTypeAliasSymbol) => string
  • skipInternalAlias?: boolean optional

Returns

string

public getContainer(): PullTypeSymbol

Returns

PullTypeSymbol

public getDeclarations(): PullDecl[]

Returns

PullDecl[]

private static getDefaultConstructorSymbolForDocComments(classSymbol: any): any

Parameters

  • classSymbol: any

Returns

any

public getDisplayName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string

Parameters

  • scopeSymbol?: PullSymbol optional
  • useConstraintInName?: boolean optional
  • skipInternalAliasName?: boolean optional

Returns

string

private getDocCommentArray(symbol: any): any

Parameters

  • symbol: any

Returns

any

private getDocCommentText(comments: any): any

Parameters

  • comments: any

Returns

any

private getDocCommentTextValue(comment: any): any

Parameters

  • comment: any

Returns

any

private getDocCommentsOfDecl(decl: any): any

Parameters

  • decl: any

Returns

any

public getEnclosingSignature(): PullSignatureSymbol

Returns

PullSignatureSymbol

private getExportedInternalAliasSymbol(scopeSymbol: any): any

Parameters

  • scopeSymbol: any

Returns

any

public getExternalAliasedSymbols(scopeSymbol: PullSymbol): PullTypeAliasSymbol[]

Parameters

Returns

PullTypeAliasSymbol[]

public static getIsExternallyVisible(symbol: PullSymbol, fromIsExternallyVisibleSymbol: PullSymbol, inIsExternallyVisibleSymbols: PullSymbol[]): boolean

Parameters

Returns

boolean

public getIsSpecialized(): boolean

Returns

boolean

public getIsSynthesized(): any

Returns

any

public getName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string

Parameters

  • scopeSymbol?: PullSymbol optional
  • useConstraintInName?: boolean optional

Returns

string

public getNameAndTypeName(scopeSymbol?: PullSymbol): string

Parameters

Returns

string

public getNameAndTypeNameEx(scopeSymbol?: PullSymbol): MemberName

Parameters

Returns

MemberName

public getNamePartForFullName(): string

Returns

string

private getParameterDocCommentText(param: any, fncDocComments: any): any

Parameters

  • param: any
  • fncDocComments: any

Returns

any

public getRootSymbol(): PullSymbol

Returns

PullSymbol

public getScopedName(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string

Parameters

  • scopeSymbol?: PullSymbol optional
  • skipTypeParametersInName?: boolean optional
  • useConstraintInName?: boolean optional
  • skipInternalAliasName?: boolean optional

Returns

string

public getScopedNameEx(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, getPrettyTypeName?: boolean, getTypeParamMarkerInfo?: boolean, skipInternalAliasName?: boolean): MemberName

Parameters

  • scopeSymbol?: PullSymbol optional
  • skipTypeParametersInName?: boolean optional
  • useConstraintInName?: boolean optional
  • getPrettyTypeName?: boolean optional
  • getTypeParamMarkerInfo?: boolean optional
  • skipInternalAliasName?: boolean optional

Returns

MemberName

public getTypeName(scopeSymbol?: PullSymbol, getPrettyTypeName?: boolean): string

Parameters

  • scopeSymbol?: PullSymbol optional
  • getPrettyTypeName?: boolean optional

Returns

string

public getTypeNameEx(scopeSymbol?: PullSymbol, getPrettyTypeName?: boolean): MemberName

Parameters

  • scopeSymbol?: PullSymbol optional
  • getPrettyTypeName?: boolean optional

Returns

MemberName

private getTypeNameForFunctionSignature(prefix: any, scopeSymbol?: any, getPrettyTypeName?: any): any

Parameters

  • prefix: any
  • scopeSymbol?: any optional
  • getPrettyTypeName?: any optional

Returns

any

public static getTypeParameterString(typars: PullTypeSymbol[], scopeSymbol?: PullSymbol, useContraintInName?: boolean): string

Parameters

Returns

string

public static getTypeParameterStringEx(typeParameters: PullTypeSymbol[], scopeSymbol?: PullSymbol, getTypeParamMarkerInfo?: boolean, useContraintInName?: boolean): MemberNameArray

Parameters

  • typeParameters: PullTypeSymbol[]
  • scopeSymbol?: PullSymbol optional
  • getTypeParamMarkerInfo?: boolean optional
  • useContraintInName?: boolean optional

Returns

MemberNameArray

public hasDeclaration(decl: PullDecl): boolean

Parameters

Returns

boolean

public isAccessor(): boolean

Returns

boolean

public isAlias(): boolean

Returns

boolean

public isAny(): boolean

Returns

boolean

public isArrayNamedTypeReference(): boolean

Returns

boolean

public isContainer(): boolean

Returns

boolean

public isError(): boolean

Returns

boolean

public isExternallyVisible(inIsExternallyVisibleSymbols?: PullSymbol[]): boolean

Parameters

  • inIsExternallyVisibleSymbols?: PullSymbol[] optional

Returns

boolean

public isInterface(): boolean

Returns

boolean

public isMethod(): boolean

Returns

boolean

public isPrimitive(): boolean

Returns

boolean

public isProperty(): boolean

Returns

boolean

public isSignature(): boolean

Returns

boolean

private isSpaceChar(line: any, index: any): any

Parameters

  • line: any
  • index: any

Returns

any

public isType(): boolean

Returns

boolean

public isTypeReference(): boolean

Returns

boolean

public pathToRoot(): PullSymbol[]

Returns

PullSymbol[]

public setContainer(containerSymbol: PullTypeSymbol)

Parameters

public setEnclosingSignature(signature: PullSignatureSymbol)

Parameters

public setIsSynthesized(value?: boolean)

Parameters

  • value?: boolean optional

public setResolved()

public setRootSymbol(symbol: PullSymbol)

Parameters

public setUnresolved()

public startResolving()

public toString(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string

Parameters

  • scopeSymbol?: PullSymbol optional
  • useConstraintInName?: boolean optional

Returns

string

private static unqualifiedNameReferencesDifferentSymbolInScope(symbol: any, scopePath: any, endScopePathIndex: any): any

Parameters

  • symbol: any
  • scopePath: any
  • endScopePathIndex: any

Returns

any