UNPKG

1.99 kBTypeScriptView Raw
1import * as ts from "typescript";
2import { LogLevel } from "simplr-logger";
3import { ApiItem, ApiItemOptions } from "./abstractions/api-item";
4import { ApiItemReferenceTuple } from "./contracts/api-item-reference-tuple";
5import { TypeDto } from "./contracts/type-dto";
6import { AccessModifier } from "./contracts/access-modifier";
7import { ApiItemLocationDto } from "./contracts/api-item-location-dto";
8import { ApiSourceFile } from "./definitions/api-source-file";
9export declare namespace ApiHelpers {
10 function VisitApiItem(declaration: ts.Declaration, symbol: ts.Symbol, options: ApiItemOptions): ApiItem | ApiSourceFile | undefined;
11 function ShouldVisit(declaration: ts.Declaration, options: ApiItemOptions): boolean;
12 function GetItemId(declaration: ts.Declaration, symbol: ts.Symbol, options: ApiItemOptions): string | undefined;
13 function GetItemsIdsFromSymbols(symbols: ts.UnderscoreEscapedMap<ts.Symbol> | undefined, options: ApiItemOptions): ApiItemReferenceTuple;
14 function GetItemsIdsFromDeclarations(declarations: ts.NodeArray<ts.Declaration>, options: ApiItemOptions): ApiItemReferenceTuple;
15 type HeritageKinds = ts.SyntaxKind.ImplementsKeyword | ts.SyntaxKind.ExtendsKeyword;
16 function GetHeritageList(heritageClauses: ts.NodeArray<ts.HeritageClause>, kind: HeritageKinds, options: ApiItemOptions): TypeDto[];
17 function TypeToApiTypeDto(type: ts.Type, options: ApiItemOptions): TypeDto;
18 function ResolveAccessModifierFromModifiers(modifiers?: ts.NodeArray<ts.Modifier>): AccessModifier;
19 function ModifierKindExistsInModifiers(modifiers: ts.NodeArray<ts.Modifier> | undefined, kind: ts.SyntaxKind): boolean;
20 function LogWithDeclarationPosition(logLevel: LogLevel, declaration: ts.Declaration, message: string): void;
21 function StandardizeRelativePath(location: string, options: ApiItemOptions): string;
22 function GetApiItemLocationDtoFromDeclaration(declaration: ts.Declaration, options: ApiItemOptions): ApiItemLocationDto;
23}