Options
All
  • Public
  • Public/Protected
  • All
Menu

@etclabscore/dl-github-releases

Index

Modules

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AST

AST: any

ArrayBufferLike

ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

ArrayKeys

ArrayKeys<T>: {}[keyof T]

Type parameters

  • T

Binary

Binary: BinaryExpression | LogicalExpression

BlobPart

BlobPart: ArrayBuffer | ArrayBufferView | Blob | string

Block

Block: BlockStatement | Program | TSModuleBlock

BlockParent

BlockParent: BlockStatement | CatchClause | DoWhileStatement | ForInStatement | ForStatement | FunctionDeclaration | FunctionExpression | Program | ObjectMethod | SwitchStatement | WhileStatement | ArrowFunctionExpression | ForOfStatement | ClassMethod | ClassPrivateMethod | TSModuleBlock

BodyInit

BodyInit: ArrayBuffer | ArrayBufferView | ReadableStream | string | URLSearchParams | FormData

BufferEncoding

BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"

BuiltInParser

BuiltInParser: (text: string, options?: any) => AST

Type declaration

    • (text: string, options?: any): AST

    • Parameters

      • text: string
      • Optional options: any

      Returns AST

BuiltInParserName

BuiltInParserName: "babel" | "babel-flow" | "babel-ts" | "flow" | "typescript" | "css" | "less" | "scss" | "json" | "json5" | "json-stringify" | "graphql" | "markdown" | "vue" | "html" | "angular" | "mdx" | "yaml" | "lwc"

BuiltInParsers

BuiltInParsers: Record<BuiltInParserName, BuiltInParser>

ChangeCounts

ChangeCounts: { a: number; b: number }

Type declaration

  • a: number
  • b: number

Class

Class: ClassExpression | ClassDeclaration

ClassDecorator

ClassDecorator: <TFunction>(target: TFunction) => TFunction | void

Type declaration

    • <TFunction>(target: TFunction): TFunction | void

    • Type parameters

      Parameters

      • target: TFunction

      Returns TFunction | void

Colors

Colors: { comment: { close: string; open: string }; content: { close: string; open: string }; prop: { close: string; open: string }; tag: { close: string; open: string }; value: { close: string; open: string } }

Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Type declaration

  • comment: { close: string; open: string }
    • close: string
    • open: string
  • content: { close: string; open: string }
    • close: string
    • open: string
  • prop: { close: string; open: string }
    • close: string
    • open: string
  • tag: { close: string; open: string }
    • close: string
    • open: string
  • value: { close: string; open: string }
    • close: string
    • open: string

Comment

Comment: CommentBlock | CommentLine

CommentTypeShorthand

CommentTypeShorthand: "leading" | "inner" | "trailing"

CompletionStatement

CompletionStatement: BreakStatement | ContinueStatement | ReturnStatement | ThrowStatement

Conditional

Conditional: ConditionalExpression | IfStatement

Config

Config: { callToJSON: boolean; colors: Colors; escapeRegex: boolean; escapeString: boolean; indent: string; maxDepth: number; min: boolean; plugins: Plugins; printFunctionName: boolean; spacingInner: string; spacingOuter: string }

Type declaration

  • callToJSON: boolean
  • colors: Colors
  • escapeRegex: boolean
  • escapeString: boolean
  • indent: string
  • maxDepth: number
  • min: boolean
  • plugins: Plugins
  • printFunctionName: boolean
  • spacingInner: string
  • spacingOuter: string

ConfigFunction

ConfigFunction: (api: ConfigAPI) => TransformOptions

Type declaration

ConstructorParameters

ConstructorParameters<T>: T extends {} ? P : never

Obtain the parameters of a constructor function type in a tuple

Type parameters

  • T: {}

CopyFilterAsync

CopyFilterAsync: (src: string, dest: string) => Promise<boolean>

Type declaration

    • (src: string, dest: string): Promise<boolean>

    • Parameters

      • src: string
      • dest: string

      Returns Promise<boolean>

CopyFilterSync

CopyFilterSync: (src: string, dest: string) => boolean

Type declaration

    • (src: string, dest: string): boolean

    • Parameters

      • src: string
      • dest: string

      Returns boolean

CustomParser

CustomParser: (text: string, parsers: BuiltInParsers, options: Options) => AST

Type declaration

Declaration

Declaration: FunctionDeclaration | VariableDeclaration | ClassDeclaration | ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration | ImportDeclaration | DeclareClass | DeclareFunction | DeclareInterface | DeclareModule | DeclareModuleExports | DeclareTypeAlias | DeclareOpaqueType | DeclareVariable | DeclareExportDeclaration | DeclareExportAllDeclaration | InterfaceDeclaration | OpaqueType | TypeAlias | EnumDeclaration | TSDeclareFunction | TSInterfaceDeclaration | TSTypeAliasDeclaration | TSEnumDeclaration | TSModuleDeclaration

DefaultTemplateBuilder

DefaultTemplateBuilder: typeof smart & { ast: typeof ast; expression: typeof expression; program: typeof program; smart: typeof smart; statement: typeof statement; statements: typeof statements }

DiffOptions

DiffOptions: { aAnnotation?: undefined | string; aColor?: DiffOptionsColor; aIndicator?: undefined | string; bAnnotation?: undefined | string; bColor?: DiffOptionsColor; bIndicator?: undefined | string; changeColor?: DiffOptionsColor; changeLineTrailingSpaceColor?: DiffOptionsColor; commonColor?: DiffOptionsColor; commonIndicator?: undefined | string; commonLineTrailingSpaceColor?: DiffOptionsColor; contextLines?: undefined | number; emptyFirstOrLastLinePlaceholder?: undefined | string; expand?: undefined | false | true; includeChangeCounts?: undefined | false | true; omitAnnotationLines?: undefined | false | true; patchColor?: DiffOptionsColor }

Type declaration

  • Optional aAnnotation?: undefined | string
  • Optional aColor?: DiffOptionsColor
  • Optional aIndicator?: undefined | string
  • Optional bAnnotation?: undefined | string
  • Optional bColor?: DiffOptionsColor
  • Optional bIndicator?: undefined | string
  • Optional changeColor?: DiffOptionsColor
  • Optional changeLineTrailingSpaceColor?: DiffOptionsColor
  • Optional commonColor?: DiffOptionsColor
  • Optional commonIndicator?: undefined | string
  • Optional commonLineTrailingSpaceColor?: DiffOptionsColor
  • Optional contextLines?: undefined | number
  • Optional emptyFirstOrLastLinePlaceholder?: undefined | string
  • Optional expand?: undefined | false | true
  • Optional includeChangeCounts?: undefined | false | true
  • Optional omitAnnotationLines?: undefined | false | true
  • Optional patchColor?: DiffOptionsColor

DiffOptionsColor

DiffOptionsColor: (arg: string) => string

Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Type declaration

    • (arg: string): string

    • Parameters

      • arg: string

      Returns string

DiffOptionsNormalized

DiffOptionsNormalized: { aAnnotation: string; aColor: DiffOptionsColor; aIndicator: string; bAnnotation: string; bColor: DiffOptionsColor; bIndicator: string; changeColor: DiffOptionsColor; changeLineTrailingSpaceColor: DiffOptionsColor; commonColor: DiffOptionsColor; commonIndicator: string; commonLineTrailingSpaceColor: DiffOptionsColor; contextLines: number; emptyFirstOrLastLinePlaceholder: string; expand: boolean; includeChangeCounts: boolean; omitAnnotationLines: boolean; patchColor: DiffOptionsColor }

Type declaration

Doc

Doc: Doc

EnumBody

EnumBody: EnumBooleanBody | EnumNumberBody | EnumStringBody | EnumSymbolBody

EnumMember

EnumMember: EnumBooleanMember | EnumNumberMember | EnumStringMember | EnumDefaultedMember

Exclude

Exclude<T, U>: T extends U ? never : T

Exclude from T those types that are assignable to U

Type parameters

  • T

  • U

ExportDeclaration

ExportDeclaration: ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration

Expression

Expression: ArrayExpression | AssignmentExpression | BinaryExpression | CallExpression | ConditionalExpression | FunctionExpression | Identifier | StringLiteral | NumericLiteral | NullLiteral | BooleanLiteral | RegExpLiteral | LogicalExpression | MemberExpression | NewExpression | ObjectExpression | SequenceExpression | ParenthesizedExpression | ThisExpression | UnaryExpression | UpdateExpression | ArrowFunctionExpression | ClassExpression | MetaProperty | Super | TaggedTemplateExpression | TemplateLiteral | YieldExpression | AwaitExpression | Import | BigIntLiteral | OptionalMemberExpression | OptionalCallExpression | TypeCastExpression | JSXElement | JSXFragment | BindExpression | PipelinePrimaryTopicReference | DoExpression | RecordExpression | TupleExpression | DecimalLiteral | TSAsExpression | TSTypeAssertion | TSNonNullExpression

ExpressionWrapper

ExpressionWrapper: ExpressionStatement | ParenthesizedExpression | TypeCastExpression

Extract

Extract<T, U>: T extends U ? T : never

Extract from T those types that are assignable to U

Type parameters

  • T

  • U

ExtractEachCallbackArgs

ExtractEachCallbackArgs<T>: { 1: [T[0]]; 10: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], T[8], T[9]]; 2: [T[0], T[1]]; 3: [T[0], T[1], T[2]]; 4: [T[0], T[1], T[2], T[3]]; 5: [T[0], T[1], T[2], T[3], T[4]]; 6: [T[0], T[1], T[2], T[3], T[4], T[5]]; 7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6]]; 8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7]]; 9: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], T[8]]; fallback: Array<T extends ReadonlyArray<infer U> ? U : any> }[T extends Readonly<[any]> ? 1 : T extends Readonly<[any, any]> ? 2 : T extends Readonly<[any, any, any]> ? 3 : T extends Readonly<[any, any, any, any]> ? 4 : T extends Readonly<[any, any, any, any, any]> ? 5 : T extends Readonly<[any, any, any, any, any, any]> ? 6 : T extends Readonly<[any, any, any, any, any, any, any]> ? 7 : T extends Readonly<[any, any, any, any, any, any, any, any]> ? 8 : T extends Readonly<[any, any, any, any, any, any, any, any, any]> ? 9 : T extends Readonly<[any, any, any, any, any, any, any, any, any, any]> ? 10 : "fallback"]

Type parameters

FileParseCallback

FileParseCallback: (err: Error | null, result: ParseResult | null) => any

Type declaration

FileResultCallback

FileResultCallback: (err: Error | null, result: BabelFileResult | null) => any

Type declaration

Flow

Flow: AnyTypeAnnotation | ArrayTypeAnnotation | BooleanTypeAnnotation | BooleanLiteralTypeAnnotation | NullLiteralTypeAnnotation | ClassImplements | DeclareClass | DeclareFunction | DeclareInterface | DeclareModule | DeclareModuleExports | DeclareTypeAlias | DeclareOpaqueType | DeclareVariable | DeclareExportDeclaration | DeclareExportAllDeclaration | DeclaredPredicate | ExistsTypeAnnotation | FunctionTypeAnnotation | FunctionTypeParam | GenericTypeAnnotation | InferredPredicate | InterfaceExtends | InterfaceDeclaration | InterfaceTypeAnnotation | IntersectionTypeAnnotation | MixedTypeAnnotation | EmptyTypeAnnotation | NullableTypeAnnotation | NumberLiteralTypeAnnotation | NumberTypeAnnotation | ObjectTypeAnnotation | ObjectTypeInternalSlot | ObjectTypeCallProperty | ObjectTypeIndexer | ObjectTypeProperty | ObjectTypeSpreadProperty | OpaqueType | QualifiedTypeIdentifier | StringLiteralTypeAnnotation | StringTypeAnnotation | SymbolTypeAnnotation | ThisTypeAnnotation | TupleTypeAnnotation | TypeofTypeAnnotation | TypeAlias | TypeAnnotation | TypeCastExpression | TypeParameter | TypeParameterDeclaration | TypeParameterInstantiation | UnionTypeAnnotation | Variance | VoidTypeAnnotation

FlowBaseAnnotation

FlowBaseAnnotation: AnyTypeAnnotation | BooleanTypeAnnotation | NullLiteralTypeAnnotation | MixedTypeAnnotation | EmptyTypeAnnotation | NumberTypeAnnotation | StringTypeAnnotation | SymbolTypeAnnotation | ThisTypeAnnotation | VoidTypeAnnotation

FlowDeclaration

FlowDeclaration: DeclareClass | DeclareFunction | DeclareInterface | DeclareModule | DeclareModuleExports | DeclareTypeAlias | DeclareOpaqueType | DeclareVariable | DeclareExportDeclaration | DeclareExportAllDeclaration | InterfaceDeclaration | OpaqueType | TypeAlias

FlowPredicate

FlowPredicate: DeclaredPredicate | InferredPredicate

FlowType

FlowType: AnyTypeAnnotation | ArrayTypeAnnotation | BooleanTypeAnnotation | BooleanLiteralTypeAnnotation | NullLiteralTypeAnnotation | ExistsTypeAnnotation | FunctionTypeAnnotation | GenericTypeAnnotation | InterfaceTypeAnnotation | IntersectionTypeAnnotation | MixedTypeAnnotation | EmptyTypeAnnotation | NullableTypeAnnotation | NumberLiteralTypeAnnotation | NumberTypeAnnotation | ObjectTypeAnnotation | StringLiteralTypeAnnotation | StringTypeAnnotation | SymbolTypeAnnotation | ThisTypeAnnotation | TupleTypeAnnotation | TypeofTypeAnnotation | UnionTypeAnnotation | VoidTypeAnnotation

For

For: ForInStatement | ForStatement | ForOfStatement

ForXStatement

ForXStatement: ForInStatement | ForOfStatement

FsSymlinkType

FsSymlinkType: "dir" | "file" | "junction"

FunctionParent

FunctionParent: FunctionDeclaration | FunctionExpression | ObjectMethod | ArrowFunctionExpression | ClassMethod | ClassPrivateMethod

GlobalFunction

GlobalFunction: Function

GlobalPartial

GlobalPartial<T>: Partial<T>

Type parameters

  • T

HeaderInit

HeaderInit: HeadersInit

HeadersInit

HeadersInit: Headers | string[][] | {}

Immutable

Immutable: StringLiteral | NumericLiteral | NullLiteral | BooleanLiteral | BigIntLiteral | JSXAttribute | JSXClosingElement | JSXElement | JSXExpressionContainer | JSXSpreadChild | JSXOpeningElement | JSXText | JSXFragment | JSXOpeningFragment | JSXClosingFragment | DecimalLiteral

Indent

Indent: (arg0: string) => string

Type declaration

    • (arg0: string): string

    • Parameters

      • arg0: string

      Returns string

InstanceType

InstanceType<T>: T extends {} ? R : any

Obtain the return type of a constructor function type

Type parameters

  • T: {}

IteratorResult

IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type parameters

  • T

  • TReturn = any

JSX

JSX: JSXAttribute | JSXClosingElement | JSXElement | JSXEmptyExpression | JSXExpressionContainer | JSXSpreadChild | JSXIdentifier | JSXMemberExpression | JSXNamespacedName | JSXOpeningElement | JSXSpreadAttribute | JSXText | JSXFragment | JSXOpeningFragment | JSXClosingFragment

LVal

LVal: Identifier | MemberExpression | RestElement | AssignmentPattern | ArrayPattern | ObjectPattern | TSParameterProperty

Literal

Literal: StringLiteral | NumericLiteral | NullLiteral | BooleanLiteral | RegExpLiteral | TemplateLiteral | BigIntLiteral | DecimalLiteral

Loop

Loop: DoWhileStatement | ForInStatement | ForStatement | WhileStatement | ForOfStatement

MatchPattern

MatchPattern: string | RegExp | ((filename: string | undefined, context: MatchPatternContext) => boolean)

Method

Method: ObjectMethod | ClassMethod | ClassPrivateMethod

MethodDecorator

MethodDecorator: <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void

Type declaration

ModuleDeclaration

ModuleDeclaration: ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration | ImportDeclaration

ModuleSpecifier

ModuleSpecifier: ExportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier | ImportSpecifier | ExportNamespaceSpecifier | ExportDefaultSpecifier

NewPlugin

NewPlugin: { serialize: (val: any, config: Config, indentation: string, depth: number, refs: Refs, printer: Printer) => string; test: Test }

Type declaration

  • serialize: (val: any, config: Config, indentation: string, depth: number, refs: Refs, printer: Printer) => string
      • (val: any, config: Config, indentation: string, depth: number, refs: Refs, printer: Printer): string

      • Parameters

        • val: any
        • config: Config
        • indentation: string
        • depth: number
        • refs: Refs
        • printer: Printer

        Returns string

  • test: Test

Node

Node: t.Node

isRoot

  • isRoot(): boolean

  • Returns boolean

visit

  • visit(visitor: Visitor, state: any): void

  • Parameters

    • visitor: Visitor
    • state: any

    Returns void

NodePaths

NodePaths<T>: T extends readonly Node[] ? {} : T extends Node ? [NodePath<T>] : never

Type parameters

NonNullable

NonNullable<T>: T extends null | undefined ? never : T

Exclude null and undefined from T

Type parameters

  • T

NumberLiteral

NumberLiteral: NumericLiteral
deprecated

Use NumericLiteral

ObjectMember

ObjectMember: ObjectMethod | ObjectProperty

OldPlugin

OldPlugin: { print: (val: unknown, print: Print, indent: Indent, options: PluginOptions, colors: Colors) => string; test: Test }

Type declaration

Omit

Omit<T, K>: Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type parameters

  • T

  • K: keyof any

OmitThisParameter

OmitThisParameter<T>: unknown extends ThisParameterType<T> ? T : T extends (...args: infer A) => infer R ? (...args: A) => R : T

Removes the 'this' parameter from a function type.

Type parameters

  • T

OptionsReceived

OptionsReceived: { callToJSON?: undefined | false | true; escapeRegex?: undefined | false | true; escapeString?: undefined | false | true; highlight?: undefined | false | true; indent?: undefined | number; maxDepth?: undefined | number; min?: undefined | false | true; plugins?: Plugins; printFunctionName?: undefined | false | true; theme?: ThemeReceived }

Type declaration

  • Optional callToJSON?: undefined | false | true
  • Optional escapeRegex?: undefined | false | true
  • Optional escapeString?: undefined | false | true
  • Optional highlight?: undefined | false | true
  • Optional indent?: undefined | number
  • Optional maxDepth?: undefined | number
  • Optional min?: undefined | false | true
  • Optional plugins?: Plugins
  • Optional printFunctionName?: undefined | false | true
  • Optional theme?: ThemeReceived

ParameterDecorator

ParameterDecorator: (target: Object, propertyKey: string | symbol, parameterIndex: number) => void

Type declaration

    • (target: Object, propertyKey: string | symbol, parameterIndex: number): void

    • Parameters

      • target: Object
      • propertyKey: string | symbol
      • parameterIndex: number

      Returns void

Parameters

Parameters<T>: T extends (...args: infer P) => any ? P : never

Obtain the parameters of a function type in a tuple

Type parameters

  • T: (...args: any) => any

ParseResult

ParseResult: File | Program

ParserPlugin

ParserPlugin: "asyncGenerators" | "bigInt" | "classPrivateMethods" | "classPrivateProperties" | "classProperties" | "decimal" | "decorators" | "decorators-legacy" | "doExpressions" | "dynamicImport" | "estree" | "exportDefaultFrom" | "exportNamespaceFrom" | "flow" | "flowComments" | "functionBind" | "functionSent" | "importMeta" | "jsx" | "logicalAssignment" | "moduleAttributes" | "nullishCoalescingOperator" | "numericSeparator" | "objectRestSpread" | "optionalCatchBinding" | "optionalChaining" | "partialApplication" | "pipelineOperator" | "placeholders" | "privateIn" | "throwExpressions" | "topLevelAwait" | "typescript" | "v8intrinsic" | ParserPluginWithOptions

ParserPluginWithOptions

ParserPluginWithOptions: ["decorators", DecoratorsPluginOptions] | ["pipelineOperator", PipelineOperatorPluginOptions] | ["flow", FlowPluginOptions]

Partial

Partial<T>: {}

Make all properties in T optional

Type parameters

  • T

Type declaration

Pattern

Pattern: AssignmentPattern | ArrayPattern | ObjectPattern

PatternLike

PatternLike: Identifier | RestElement | AssignmentPattern | ArrayPattern | ObjectPattern

Pick

Pick<T, K>: {}

From T, pick a set of properties whose keys are in the union K

Type parameters

  • T

  • K: keyof T

Type declaration

Plugin

Plugin: NewPlugin | OldPlugin

Optional defaultOptions

defaultOptions: Partial<RequiredOptions>

Optional languages

languages: SupportLanguage[]

Optional options

options: SupportOption[]

Optional parsers

parsers: undefined | {}

Optional printers

printers: undefined | {}

PluginItem

PluginItem: ConfigItem | PluginObj<any> | PluginTarget | [PluginTarget, PluginOptions] | [PluginTarget, PluginOptions, string | undefined]

PluginOptions

PluginOptions: { edgeSpacing: string; min: boolean; spacing: string }

Type declaration

  • edgeSpacing: string
  • min: boolean
  • spacing: string

PluginTarget

PluginTarget: string | object | ((...args: any[]) => any)

Plugins

Plugins: Array<Plugin>

Print

Print: (arg0: unknown) => string

Type declaration

    • (arg0: unknown): string

    • Parameters

      • arg0: unknown

      Returns string

Printer

Printer: (val: unknown, config: Config, indentation: string, depth: number, refs: Refs, hasCalledToJSON?: undefined | false | true) => string

Type declaration

    • (val: unknown, config: Config, indentation: string, depth: number, refs: Refs, hasCalledToJSON?: undefined | false | true): string

    • Parameters

      • val: unknown
      • config: Config
      • indentation: string
      • depth: number
      • refs: Refs
      • Optional hasCalledToJSON: undefined | false | true

      Returns string

Optional canAttachComment

canAttachComment: undefined | ((node: any) => boolean)

Optional embed

embed: undefined | ((path: FastPath, print: (path: FastPath) => Doc, textToDoc: (text: string, options: Options) => Doc, options: ParserOptions) => Doc | null)

Optional handleComments

handleComments: undefined | { endOfLine?: undefined | ((commentNode: any, text: string, options: ParserOptions, ast: any, isLastComment: boolean) => boolean); ownLine?: undefined | ((commentNode: any, text: string, options: ParserOptions, ast: any, isLastComment: boolean) => boolean); remaining?: undefined | ((commentNode: any, text: string, options: ParserOptions, ast: any, isLastComment: boolean) => boolean) }

Optional hasPrettierIgnore

hasPrettierIgnore: undefined | ((path: FastPath) => boolean)

Optional insertPragma

insertPragma: undefined | ((text: string) => string)

Optional massageAstNode

massageAstNode: undefined | ((node: any, newNode: any, parent: any) => any)
returns

null if you want to remove this node

returns

void if you want to use modified newNode

returns

anything if you want to replace the node with it

Optional printComments

printComments: undefined | ((path: FastPath, print: (path: FastPath) => Doc, options: ParserOptions, needsSemi: boolean) => Doc)

Optional willPrintOwnComments

willPrintOwnComments: undefined | ((path: FastPath) => boolean)

print

Private

Private: ClassPrivateProperty | ClassPrivateMethod | PrivateName

PromiseConstructorLike

PromiseConstructorLike: {}

Type declaration

Property

Property: ObjectProperty | ClassProperty | ClassPrivateProperty

PropertyDecorator

PropertyDecorator: (target: Object, propertyKey: string | symbol) => void

Type declaration

    • (target: Object, propertyKey: string | symbol): void

    • Parameters

      • target: Object
      • propertyKey: string | symbol

      Returns void

PropertyKey

PropertyKey: string | number | symbol

PublicReplacements

PublicReplacements: {} | any[]

Pureish

Pureish: FunctionDeclaration | FunctionExpression | StringLiteral | NumericLiteral | NullLiteral | BooleanLiteral | RegExpLiteral | ArrowFunctionExpression | BigIntLiteral | DecimalLiteral

RGB

RGB: [number, number, number]

Tuple of Red, Green, and Blue

example

// Red = 55, Green = 70, Blue = 0 const rgb: RGB = [55, 70, 0];

Readonly

Readonly<T>: {}

Make all properties in T readonly

Type parameters

  • T

Type declaration

Record

Record<K, T>: {}

Construct a type with a set of properties K of type T

Type parameters

  • K: keyof any

  • T

Type declaration

Refs

Refs: Array<unknown>

RegexLiteral

RegexLiteral: RegExpLiteral
deprecated

Use RegExpLiteral

Releases

Releases: Release[]

ReportType

ReportType: keyof ReportOptions

RequestCache

RequestCache: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload"

RequestContext

RequestContext: "audio" | "beacon" | "cspreport" | "download" | "embed" | "eventsource" | "favicon" | "fetch" | "font" | "form" | "frame" | "hyperlink" | "iframe" | "image" | "imageset" | "import" | "internal" | "location" | "manifest" | "object" | "ping" | "plugin" | "prefetch" | "script" | "serviceworker" | "sharedworker" | "style" | "subresource" | "track" | "video" | "worker" | "xmlhttprequest" | "xslt"

RequestCredentials

RequestCredentials: "omit" | "include" | "same-origin"

RequestInfo

RequestInfo: string | URLLike | Request

RequestMode

RequestMode: "cors" | "no-cors" | "same-origin"

RequestRedirect

RequestRedirect: "error" | "follow" | "manual"

Required

Required<T>: {}

Make all properties in T required

Type parameters

  • T

Type declaration

ResponseType

ResponseType: "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect"

RestProperty

RestProperty: RestElement
deprecated

Use RestElement

ReturnType

ReturnType<T>: T extends (...args: any) => infer R ? R : any

Obtain the return type of a function type

Type parameters

  • T: (...args: any) => any

Scopable

Scopable: BlockStatement | CatchClause | DoWhileStatement | ForInStatement | ForStatement | FunctionDeclaration | FunctionExpression | Program | ObjectMethod | SwitchStatement | WhileStatement | ArrowFunctionExpression | ClassExpression | ClassDeclaration | ForOfStatement | ClassMethod | ClassPrivateMethod | TSModuleBlock

SimpleCacheCallback

SimpleCacheCallback<T>: () => T

Type parameters

Type declaration

    • (): T

    • Returns T

SimpleCacheKey

SimpleCacheKey: string | boolean | number | null | undefined

SpreadProperty

SpreadProperty: SpreadElement
deprecated

Use SpreadElement

Statement

Statement: BlockStatement | BreakStatement | ContinueStatement | DebuggerStatement | DoWhileStatement | EmptyStatement | ExpressionStatement | ForInStatement | ForStatement | FunctionDeclaration | IfStatement | LabeledStatement | ReturnStatement | SwitchStatement | ThrowStatement | TryStatement | VariableDeclaration | WhileStatement | WithStatement | ClassDeclaration | ExportAllDeclaration | ExportDefaultDeclaration | ExportNamedDeclaration | ForOfStatement | ImportDeclaration | DeclareClass | DeclareFunction | DeclareInterface | DeclareModule | DeclareModuleExports | DeclareTypeAlias | DeclareOpaqueType | DeclareVariable | DeclareExportDeclaration | DeclareExportAllDeclaration | InterfaceDeclaration | OpaqueType | TypeAlias | EnumDeclaration | TSDeclareFunction | TSInterfaceDeclaration | TSTypeAliasDeclaration | TSEnumDeclaration | TSModuleDeclaration | TSImportEqualsDeclaration | TSExportAssignment | TSNamespaceExportDeclaration

Summarizers

Summarizers: "flat" | "nested" | "pkg" | "defaultSummarizer"

SupportOptionValue

SupportOptionValue: number | boolean | string

SymlinkType

SymlinkType: "dir" | "file"

TSBaseType

TSBaseType: TSAnyKeyword | TSBooleanKeyword | TSBigIntKeyword | TSNeverKeyword | TSNullKeyword | TSNumberKeyword | TSObjectKeyword | TSStringKeyword | TSSymbolKeyword | TSUndefinedKeyword | TSUnknownKeyword | TSVoidKeyword | TSThisType | TSLiteralType

TSEntityName

TSEntityName: Identifier | TSQualifiedName

TSType

TSType: TSAnyKeyword | TSBooleanKeyword | TSBigIntKeyword | TSNeverKeyword | TSNullKeyword | TSNumberKeyword | TSObjectKeyword | TSStringKeyword | TSSymbolKeyword | TSUndefinedKeyword | TSUnknownKeyword | TSVoidKeyword | TSThisType | TSFunctionType | TSConstructorType | TSTypeReference | TSTypePredicate | TSTypeQuery | TSTypeLiteral | TSArrayType | TSTupleType | TSOptionalType | TSRestType | TSUnionType | TSIntersectionType | TSConditionalType | TSInferType | TSParenthesizedType | TSTypeOperator | TSIndexedAccessType | TSMappedType | TSLiteralType | TSExpressionWithTypeArguments | TSImportType

TSTypeElement

TSTypeElement: TSCallSignatureDeclaration | TSConstructSignatureDeclaration | TSPropertySignature | TSMethodSignature | TSIndexSignature

Terminatorless

Terminatorless: BreakStatement | ContinueStatement | ReturnStatement | ThrowStatement | YieldExpression | AwaitExpression

Test

Test: (arg0: any) => boolean

Type declaration

    • (arg0: any): boolean

    • Parameters

      • arg0: any

      Returns boolean

Theme

Theme: { comment: string; content: string; prop: string; tag: string; value: string }

Type declaration

  • comment: string
  • content: string
  • prop: string
  • tag: string
  • value: string

ThemeReceived

ThemeReceived: { comment?: undefined | string; content?: undefined | string; prop?: undefined | string; tag?: undefined | string; value?: undefined | string }

Type declaration

  • Optional comment?: undefined | string
  • Optional content?: undefined | string
  • Optional prop?: undefined | string
  • Optional tag?: undefined | string
  • Optional value?: undefined | string

ThisParameterType

ThisParameterType<T>: T extends (this: infer U, ...args: any[]) => any ? U : unknown

Extracts the type of the 'this' parameter of a function type, or 'unknown' if the function type has no 'this' parameter.

Type parameters

  • T

TraversalAncestors

TraversalAncestors: ReadonlyArray<{ index?: undefined | number; key: string; node: Node }>

TraversalHandler

TraversalHandler<T>: (this: undefined, node: Node, parent: TraversalAncestors, type: T) => void

Type parameters

  • T

Type declaration

TraversalHandlers

TraversalHandlers<T>: { enter?: TraversalHandler<T>; exit?: TraversalHandler<T> }

Type parameters

  • T

Type declaration

UnaryLike

UnaryLike: UnaryExpression | SpreadElement

UserWhitespacable

UserWhitespacable: ObjectMethod | ObjectProperty | ObjectTypeInternalSlot | ObjectTypeCallProperty | ObjectTypeIndexer | ObjectTypeProperty | ObjectTypeSpreadProperty

VisitNode

VisitNode<S, P>: VisitNodeFunction<S, P> | VisitNodeObject<S, P>

Type parameters

VisitNodeFunction

VisitNodeFunction<S, P>: (this: S, path: NodePath<P>, state: S) => void

Type parameters

Type declaration

    • (this: S, path: NodePath<P>, state: S): void

    • Parameters

      Returns void

Visitor

Visitor<S, N>: VisitNodeObject<S, Node> & {} & {}

Type parameters

  • S = {}

  • N: Node = Node

onDetail

  • onDetail(root: N, state: any): void

  • Parameters

    • root: N
    • state: any

    Returns void

onEnd

  • onEnd(root: N, state: any): void

  • Parameters

    • root: N
    • state: any

    Returns void

onStart

  • onStart(root: N, state: any): void

  • Parameters

    • root: N
    • state: any

    Returns void

onSummary

  • onSummary(root: N, state: any): void

  • Parameters

    • root: N
    • state: any

    Returns void

onSummaryEnd

  • onSummaryEnd(root: N, state: any): void

  • Parameters

    • root: N
    • state: any

    Returns void

Watermark

Watermark: [number, number]

While

While: DoWhileStatement | WhileStatement

Variables

Array

Array: ArrayConstructor

ArrayBuffer

ArrayBuffer: ArrayBufferConstructor

Atomics

Atomics: Atomics

BigInt

BigInt: BigIntConstructor

BigInt64Array

BigInt64Array: BigInt64ArrayConstructor

BigUint64Array

BigUint64Array: BigUint64ArrayConstructor

Boolean

Boolean: BooleanConstructor

Const DEFAULT_EXTENSIONS

DEFAULT_EXTENSIONS: [".js", ".jsx", ".es6", ".es", ".mjs"]

DIFF_DELETE

DIFF_DELETE: number

The data structure representing a diff is an array of tuples: [[DIFF_DELETE, 'Hello'], [DIFF_INSERT, 'Goodbye'], [DIFF_EQUAL, ' world.']] which means: delete 'Hello', add 'Goodbye' and keep ' world.'

DIFF_EQUAL

DIFF_EQUAL: number

DIFF_INSERT

DIFF_INSERT: number

DataView

DataView: DataViewConstructor

Date

Date: DateConstructor

Error

Error: ErrorConstructor

EvalError

EvalError: EvalErrorConstructor

Float32Array

Float32Array: Float32ArrayConstructor

Float64Array

Float64Array: Float64ArrayConstructor

Function

Function: FunctionConstructor

Infinity

Infinity: number

Int16Array

Int16Array: Int16ArrayConstructor

Int32Array

Int32Array: Int32ArrayConstructor

Int8Array

Int8Array: Int8ArrayConstructor

JSON

JSON: JSON

An intrinsic object that provides functions to convert JavaScript values to and from the JavaScript Object Notation (JSON) format.

Map

Map: MapConstructor

Math

Math: Math

An intrinsic object that provides basic mathematics functionality and constants.

NaN

NaN: number

Node

Node: any

Number

Number: NumberConstructor

An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers.

Object

Object: ObjectConstructor

Provides functionality common to all JavaScript objects.

Promise

Promise: PromiseConstructor

Proxy

Proxy: ProxyConstructor

RangeError

RangeError: RangeErrorConstructor

ReferenceError

ReferenceError: ReferenceErrorConstructor

RegExp

RegExp: RegExpConstructor

Set

Set: SetConstructor

SharedArrayBuffer

SharedArrayBuffer: SharedArrayBufferConstructor

Stats

Stats: Stats

String

String: StringConstructor

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Symbol

Symbol: SymbolConstructor

SyntaxError

SyntaxError: SyntaxErrorConstructor

TypeError

TypeError: TypeErrorConstructor

URIError

URIError: URIErrorConstructor

Uint16Array

Uint16Array: Uint16ArrayConstructor

Uint32Array

Uint32Array: Uint32ArrayConstructor

Uint8Array

Uint8Array: Uint8ArrayConstructor

Uint8ClampedArray

Uint8ClampedArray: Uint8ClampedArrayConstructor

WeakMap

WeakMap: WeakMapConstructor

WeakSet

WeakSet: WeakSetConstructor

__dirname

__dirname: string

__filename

__filename: string

afterAll

afterAll: Lifecycle

afterEach

afterEach: Lifecycle

Const aliceblue

aliceblue: RGB

Const antiquewhite

antiquewhite: RGB

Const aqua

aqua: RGB

Const aquamarine

aquamarine: RGB

Const azure

azure: RGB

beforeAll

beforeAll: Lifecycle

beforeEach

beforeEach: Lifecycle

Const beige

beige: RGB

Const bisque

bisque: RGB

Const black

black: RGB

Const blanchedalmond

blanchedalmond: RGB

Const blue

blue: RGB

Const blueviolet

blueviolet: RGB

Const brown

brown: RGB

Const burlywood

burlywood: RGB

Const cadetblue

cadetblue: RGB

Const chartreuse

chartreuse: RGB

Const chocolate

chocolate: RGB

Const classes

classes: { FileCoverage: FileCoverage }

Type declaration

Export assignment console

console: Console

Const coral

coral: RGB

Const cornflowerblue

cornflowerblue: RGB

Const cornsilk

cornsilk: RGB

Const countChanges

countChanges: (diffs: Diff[]) => ChangeCounts

Type declaration

Const createLink

createLink: typeof ensureLink

Const createLinkSync

createLinkSync: typeof ensureLinkSync

Const createPatchMark

createPatchMark: (aStart: number, aEnd: number, bStart: number, bEnd: number, __namedParameters: { patchColor: DiffOptionsColor }) => string

Type declaration

    • (aStart: number, aEnd: number, bStart: number, bEnd: number, __namedParameters: { patchColor: DiffOptionsColor }): string

    • Parameters

      Returns string

Const crimson

crimson: RGB

Const cyan

cyan: RGB

Const darkblue

darkblue: RGB

Const darkcyan

darkcyan: RGB

Const darkgoldenrod

darkgoldenrod: RGB

Const darkgray

darkgray: RGB

Const darkgreen

darkgreen: RGB

Const darkgrey

darkgrey: RGB

Const darkkhaki

darkkhaki: RGB

Const darkmagenta

darkmagenta: RGB

Const darkolivegreen

darkolivegreen: RGB

Const darkorange

darkorange: RGB

Const darkorchid

darkorchid: RGB

Const darkred

darkred: RGB

Const darksalmon

darksalmon: RGB

Const darkseagreen

darkseagreen: RGB

Const darkslateblue

darkslateblue: RGB

Const darkslategray

darkslategray: RGB

Const darkslategrey

darkslategrey: RGB

Const darkturquoise

darkturquoise: RGB

Const darkviolet

darkviolet: RGB

Const deeppink

deeppink: RGB

Const deepskyblue

deepskyblue: RGB

describe

describe: Describe

Const diffLinesRaw

diffLinesRaw: (aLines: string[], bLines: string[]) => Diff[]

Type declaration

    • (aLines: string[], bLines: string[]): Diff[]

    • Parameters

      • aLines: string[]
      • bLines: string[]

      Returns Diff[]

Const diffLinesUnified

diffLinesUnified: (aLines: string[], bLines: string[], options?: DiffOptions | undefined) => string

Type declaration

    • (aLines: string[], bLines: string[], options?: DiffOptions | undefined): string

    • Parameters

      • aLines: string[]
      • bLines: string[]
      • Optional options: DiffOptions | undefined

      Returns string

Const diffLinesUnified2

diffLinesUnified2: (aLinesDisplay: string[], bLinesDisplay: string[], aLinesCompare: string[], bLinesCompare: string[], options?: DiffOptions | undefined) => string

Type declaration

    • (aLinesDisplay: string[], bLinesDisplay: string[], aLinesCompare: string[], bLinesCompare: string[], options?: DiffOptions | undefined): string

    • Parameters

      • aLinesDisplay: string[]
      • bLinesDisplay: string[]
      • aLinesCompare: string[]
      • bLinesCompare: string[]
      • Optional options: DiffOptions | undefined

      Returns string

Const diffStringsRaw

diffStringsRaw: (a: string, b: string, cleanup: boolean) => Diff[]

Type declaration

    • (a: string, b: string, cleanup: boolean): Diff[]

    • Parameters

      • a: string
      • b: string
      • cleanup: boolean

      Returns Diff[]

Const diffStringsUnified

diffStringsUnified: (a: string, b: string, options?: DiffOptions | undefined) => string

Type declaration

    • (a: string, b: string, options?: DiffOptions | undefined): string

    • Parameters

      • a: string
      • b: string
      • Optional options: DiffOptions | undefined

      Returns string

diff_cleanupSemantic

diff_cleanupSemantic: (diffs: Diff[]) => void

Reduce the number of edits by eliminating semantically trivial equalities.

param

Array of diff tuples.

Type declaration

    • (diffs: Diff[]): void

    • Parameters

      Returns void

Const dimgray

dimgray: RGB

Const dimgrey

dimgrey: RGB

Const dodgerblue

dodgerblue: RGB

Const expect

expect: Expect

exports

exports: any

Const expression

expression: TemplateBuilder<Expression>

fdescribe

fdescribe: Describe

Const firebrick

firebrick: RGB

fit

fit: It

Const floralwhite

floralwhite: RGB

Const forestgreen

forestgreen: RGB

Const fuchsia

fuchsia: RGB

Const gainsboro

gainsboro: RGB

Const ghostwhite

ghostwhite: RGB

global

global: Global & typeof globalThis

Const gold

gold: RGB

Const goldenrod

goldenrod: RGB

Const gray

gray: RGB

Const green

green: RGB

Const greenyellow

greenyellow: RGB

Const grey

grey: RGB

Const hasCommonDiff

hasCommonDiff: (diffs: Diff[], isMultiline: boolean) => boolean

Type declaration

    • (diffs: Diff[], isMultiline: boolean): boolean

    • Parameters

      • diffs: Diff[]
      • isMultiline: boolean

      Returns boolean

Const honeydew

honeydew: RGB

Const hotpink

hotpink: RGB

Const indianred

indianred: RGB

Const indigo

indigo: RGB

it

it: It

Const ivory

ivory: RGB

Const khaki

khaki: RGB

Const lavender

lavender: RGB

Const lavenderblush

lavenderblush: RGB

Const lawngreen

lawngreen: RGB

Const lemonchiffon

lemonchiffon: RGB

Const lightblue

lightblue: RGB

Const lightcoral

lightcoral: RGB

Const lightcyan

lightcyan: RGB

Const lightgoldenrodyellow

lightgoldenrodyellow: RGB

Const lightgray

lightgray: RGB

Const lightgreen

lightgreen: RGB

Const lightgrey

lightgrey: RGB

Const lightpink

lightpink: RGB

Const lightsalmon

lightsalmon: RGB

Const lightseagreen

lightseagreen: RGB

Const lightskyblue

lightskyblue: RGB

Const lightslategray

lightslategray: RGB

Const lightslategrey

lightslategrey: RGB

Const lightsteelblue

lightsteelblue: RGB

Const lightyellow

lightyellow: RGB

Const lime

lime: RGB

Const limegreen

limegreen: RGB

Const linen

linen: RGB

Const magenta

magenta: RGB

Const maroon

maroon: RGB

Const mediumaquamarine

mediumaquamarine: RGB

Const mediumblue

mediumblue: RGB

Const mediumorchid

mediumorchid: RGB

Const mediumpurple

mediumpurple: RGB

Const mediumseagreen

mediumseagreen: RGB

Const mediumslateblue

mediumslateblue: RGB

Const mediumspringgreen

mediumspringgreen: RGB

Const mediumturquoise

mediumturquoise: RGB

Const mediumvioletred

mediumvioletred: RGB

Const midnightblue

midnightblue: RGB

Const mintcream

mintcream: RGB

Const mistyrose

mistyrose: RGB

Const moccasin

moccasin: RGB

module

module: NodeModule

Const navajowhite

navajowhite: RGB

Const navy

navy: RGB

Const oldlace

oldlace: RGB

Const olive

olive: RGB

Const olivedrab

olivedrab: RGB

Const orange

orange: RGB

Const orangered

orangered: RGB

Const orchid

orchid: RGB

Const palegoldenrod

palegoldenrod: RGB

Const palegreen

palegreen: RGB

Const paleturquoise

paleturquoise: RGB

Const palevioletred

palevioletred: RGB

Const papayawhip

papayawhip: RGB

Const peachpuff

peachpuff: RGB

Const peru

peru: RGB

Const pink

pink: RGB

Const plum

plum: RGB

Const powderblue

powderblue: RGB

Const printAnnotation

printAnnotation: (__namedParameters: { aAnnotation: string; aColor: DiffOptionsColor; aIndicator: string; bAnnotation: string; bColor: DiffOptionsColor; bIndicator: string; includeChangeCounts: boolean; omitAnnotationLines: boolean }, changeCounts: ChangeCounts) => string

Type declaration

    • (__namedParameters: { aAnnotation: string; aColor: DiffOptionsColor; aIndicator: string; bAnnotation: string; bColor: DiffOptionsColor; bIndicator: string; includeChangeCounts: boolean; omitAnnotationLines: boolean }, changeCounts: ChangeCounts): string

    • Parameters

      • __namedParameters: { aAnnotation: string; aColor: DiffOptionsColor; aIndicator: string; bAnnotation: string; bColor: DiffOptionsColor; bIndicator: string; includeChangeCounts: boolean; omitAnnotationLines: boolean }
        • aAnnotation: string
        • aColor: DiffOptionsColor
        • aIndicator: string
        • bAnnotation: string
        • bColor: DiffOptionsColor
        • bIndicator: string
        • includeChangeCounts: boolean
        • omitAnnotationLines: boolean
      • changeCounts: ChangeCounts

      Returns string

Const printCommonLine

printCommonLine: (line: string, isFirstOrLast: boolean, __namedParameters: { commonColor: DiffOptionsColor; commonIndicator: string; commonLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }) => string

Type declaration

    • (line: string, isFirstOrLast: boolean, __namedParameters: { commonColor: DiffOptionsColor; commonIndicator: string; commonLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }): string

    • Parameters

      • line: string
      • isFirstOrLast: boolean
      • __namedParameters: { commonColor: DiffOptionsColor; commonIndicator: string; commonLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }

      Returns string

Const printDeleteLine

printDeleteLine: (line: string, isFirstOrLast: boolean, __namedParameters: { aColor: DiffOptionsColor; aIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }) => string

Type declaration

    • (line: string, isFirstOrLast: boolean, __namedParameters: { aColor: DiffOptionsColor; aIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }): string

    • Parameters

      • line: string
      • isFirstOrLast: boolean
      • __namedParameters: { aColor: DiffOptionsColor; aIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }

      Returns string

Const printDiffLines

printDiffLines: (diffs: Diff[], options: DiffOptionsNormalized) => string

Type declaration

Const printInsertLine

printInsertLine: (line: string, isFirstOrLast: boolean, __namedParameters: { bColor: DiffOptionsColor; bIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }) => string

Type declaration

    • (line: string, isFirstOrLast: boolean, __namedParameters: { bColor: DiffOptionsColor; bIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }): string

    • Parameters

      • line: string
      • isFirstOrLast: boolean
      • __namedParameters: { bColor: DiffOptionsColor; bIndicator: string; changeLineTrailingSpaceColor: DiffOptionsColor; emptyFirstOrLastLinePlaceholder: string }

      Returns string

Export assignment process

process: Process

Const purple

purple: RGB

Const rebeccapurple

rebeccapurple: RGB

Const red

red: RGB

require

require: NodeRequire

Const rosybrown

rosybrown: RGB

Const royalblue

royalblue: RGB

Const saddlebrown

saddlebrown: RGB

Const salmon

salmon: RGB

Const sandybrown

sandybrown: RGB

Const seagreen

seagreen: RGB

Const seashell

seashell: RGB

Const sienna

sienna: RGB

Const silver

silver: RGB

Const skyblue

skyblue: RGB

Const slateblue

slateblue: RGB

Const slategray

slategray: RGB

Const slategrey

slategrey: RGB

Const smart

smart: TemplateBuilder<Statement | Statement[]>

Const snow

snow: RGB

Const springgreen

springgreen: RGB

Const statement

statement: TemplateBuilder<Statement>

Const statements

statements: TemplateBuilder<Statement[]>

Const steelblue

steelblue: RGB

Const tan

tan: RGB

Const teal

teal: RGB

Const templateBuilder

templateBuilder: DefaultTemplateBuilder

test

test: It

Const thistle

thistle: RGB

Const tomato

tomato: RGB

Const turquoise

turquoise: RGB

Const version

version: string

version field in package.json

Const violet

violet: RGB

Const wheat

wheat: RGB

Const white

white: RGB

Const whitesmoke

whitesmoke: RGB

xdescribe

xdescribe: Describe

xit

xit: It

xtest

xtest: It

Const yellow

yellow: RGB

Const yellowgreen

yellowgreen: RGB

Functions

_import

  • Returns Import

_super

  • Returns Super

access

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional mode: undefined | number

    Returns Promise<void>

addComment

  • addComment<T>(node: T, type: CommentTypeShorthand, content: string, line?: undefined | false | true): T

  • Type parameters

    Parameters

    Returns T

addComments

anyTypeAnnotation

appendFile

  • appendFile(file: string | Buffer | number, data: any, options: { encoding?: undefined | string; flag?: undefined | string; mode?: number | string }, callback: (err: ErrnoException) => void): void
  • appendFile(file: string | Buffer | number, data: any, callback: (err: ErrnoException) => void): void
  • appendFile(file: string | Buffer | number, data: any, options?: undefined | { encoding?: undefined | string; flag?: undefined | string; mode?: number | string }): Promise<void>

  • Parameters

    • file: string | Buffer | number
    • data: any
    • options: { encoding?: undefined | string; flag?: undefined | string; mode?: number | string }
      • Optional encoding?: undefined | string
      • Optional flag?: undefined | string
      • Optional mode?: number | string
    • callback: (err: ErrnoException) => void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • file: string | Buffer | number
    • data: any
    • Optional options: undefined | { encoding?: undefined | string; flag?: undefined | string; mode?: number | string }

    Returns Promise<void>

appendToMemberExpression

  • appendToMemberExpression<T>(member: T, append: MemberExpression["property"], computed?: undefined | false | true): T

  • Type parameters

    Parameters

    • member: T
    • append: MemberExpression["property"]
    • Optional computed: undefined | false | true

    Returns T

argumentPlaceholder

arrayExpression

arrayPattern

arrayTypeAnnotation

arrowFunctionExpression

assignmentExpression

assignmentPattern

awaitExpression

bigIntLiteral

  • Parameters

    • value: string

    Returns BigIntLiteral

binaryExpression

  • binaryExpression(operator: "+" | "-" | "/" | "%" | "*" | "**" | "&" | "|" | ">>" | ">>>" | "<<" | "^" | "==" | "===" | "!=" | "!==" | "in" | "instanceof" | ">" | "<" | ">=" | "<=", left: Expression | PrivateName, right: Expression): BinaryExpression

  • Parameters

    • operator: "+" | "-" | "/" | "%" | "*" | "**" | "&" | "|" | ">>" | ">>>" | "<<" | "^" | "==" | "===" | "!=" | "!==" | "in" | "instanceof" | ">" | "<" | ">=" | "<="
    • left: Expression | PrivateName
    • right: Expression

    Returns BinaryExpression

bindExpression

blockStatement

booleanLiteral

  • Parameters

    • value: boolean

    Returns BooleanLiteral

booleanLiteralTypeAnnotation

booleanTypeAnnotation

breakStatement

  • Parameters

    Returns BreakStatement

buildChildren

buildMatchMemberExpression

  • buildMatchMemberExpression(match: string, allowPartial?: undefined | false | true): (node: Node | null | undefined) => node is MemberExpression

  • Parameters

    • match: string
    • Optional allowPartial: undefined | false | true

    Returns (node: Node | null | undefined) => node is MemberExpression

      • (node: Node | null | undefined): node is MemberExpression

      • Parameters

        • node: Node | null | undefined

        Returns node is MemberExpression

callExpression

catchClause

check

  • check(source: string, options?: Options): boolean

  • check checks to see if the file has been formatted with Prettier given those options and returns a Boolean. This is similar to the --list-different parameter in the CLI and is useful for running Prettier in CI scenarios.

    Parameters

    • source: string
    • Optional options: Options

    Returns boolean

chmod

  • chmod(path: string | Buffer, mode: string | number, callback: (err: ErrnoException) => void): void
  • chmod(path: string | Buffer, mode: string | number): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • mode: string | number

    Returns Promise<void>

chown

  • chown(path: string | Buffer, uid: number, gid: number): Promise<void>
  • chown(path: string | Buffer, uid: number, gid: number, callback: (err: ErrnoException) => void): void

  • Parameters

    • path: string | Buffer
    • uid: number
    • gid: number

    Returns Promise<void>

  • Parameters

    Returns void

classBody

classDeclaration

classExpression

classImplements

classMethod

classPrivateMethod

classPrivateProperty

classProperty

clearConfigCache

  • clearConfigCache(): void

  • As you repeatedly call resolveConfig, the file system structure will be cached for performance. This function will clear the cache. Generally this is only needed for editor integrations that know that the file system has changed since the last format took place.

    Returns void

clearImmediate

  • clearImmediate(immediateId: Immediate): void

  • Parameters

    Returns void

clearInterval

  • clearInterval(intervalId: Timeout): void

  • Parameters

    Returns void

clearTimeout

  • clearTimeout(timeoutId: Timeout): void

  • Parameters

    Returns void

clone

  • clone<T>(n: T): T

  • Type parameters

    Parameters

    • n: T

    Returns T

cloneDeep

  • cloneDeep<T>(n: T): T

  • Type parameters

    Parameters

    • n: T

    Returns T

cloneDeepWithoutLoc

  • cloneDeepWithoutLoc<T>(n: T): T

  • Type parameters

    Parameters

    • n: T

    Returns T

cloneNode

  • cloneNode<T>(n: T, deep?: undefined | false | true, withoutLoc?: undefined | false | true): T

  • Type parameters

    Parameters

    • n: T
    • Optional deep: undefined | false | true
    • Optional withoutLoc: undefined | false | true

    Returns T

cloneWithoutLoc

  • cloneWithoutLoc<T>(n: T): T

  • Type parameters

    Parameters

    • n: T

    Returns T

close

  • Parameters

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

conditionalExpression

continueStatement

copy

  • copy(src: string, dest: string, options?: CopyOptions): Promise<void>
  • copy(src: string, dest: string, callback: (err: Error) => void): void
  • copy(src: string, dest: string, options: CopyOptions, callback: (err: Error) => void): void

  • Parameters

    • src: string
    • dest: string
    • Optional options: CopyOptions

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • options: CopyOptions
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

copyFile

  • copyFile(src: string, dest: string, flags?: undefined | number): Promise<void>
  • copyFile(src: string, dest: string, callback: (err: Error) => void): void
  • copyFile(src: string, dest: string, flags: number, callback: (err: Error) => void): void

  • Parameters

    • src: string
    • dest: string
    • Optional flags: undefined | number

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • flags: number
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

copySync

  • Parameters

    Returns void

create

  • create<T>(name: T, options?: Partial<ReportOptions[T]>): Visitor

  • Type parameters

    Parameters

    • name: T
    • Optional options: Partial<ReportOptions[T]>

    Returns Visitor

createConfigItem

  • Allows build tooling to create and cache config items up front. If this function is called multiple times for a given plugin, Babel will call the plugin's function itself multiple times. If you have a clear set of expected plugins and presets to inject, pre-constructing the config items would be recommended.

    Parameters

    Returns ConfigItem

createContext

  • returns a reporting context for the supplied options

    Parameters

    Returns Context

createCoverageMap

createCoverageSummary

createFile

  • createFile(file: string): Promise<void>
  • createFile(file: string, callback: (err: Error) => void): void

  • Parameters

    • file: string

    Returns Promise<void>

  • Parameters

    • file: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

createFileCoverage

createFileSync

  • createFileSync(file: string): void

  • Parameters

    • file: string

    Returns void

createFlowUnionType

  • Type parameters

    Parameters

    • types: [T]

    Returns T

  • Parameters

    Returns UnionTypeAnnotation

createSymlink

  • createSymlink(src: string, dest: string, type: SymlinkType): Promise<void>
  • createSymlink(src: string, dest: string, type: SymlinkType, callback?: undefined | ((err: Error) => void)): void

  • Parameters

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • type: SymlinkType
    • Optional callback: undefined | ((err: Error) => void)

    Returns void

createSymlinkSync

  • createSymlinkSync(src: string, dest: string, type: SymlinkType): void

  • Parameters

    Returns void

createTypeAnnotationBasedOnTypeof

createUnionTypeAnnotation

  • Type parameters

    Parameters

    • types: [T]

    Returns T

  • Parameters

    Returns UnionTypeAnnotation

debuggerStatement

decimalLiteral

  • Parameters

    • value: string

    Returns DecimalLiteral

declareClass

declareExportAllDeclaration

declareExportDeclaration

declareFunction

declareInterface

declareModule

declareModuleExports

declareOpaqueType

declareTypeAlias

declareVariable

declaredPredicate

  • Parameters

    Returns DeclaredPredicate

decodeURI

  • decodeURI(encodedURI: string): string

  • Gets the unencoded version of an encoded Uniform Resource Identifier (URI).

    Parameters

    • encodedURI: string

      A value representing an encoded URI.

    Returns string

decodeURIComponent

  • decodeURIComponent(encodedURIComponent: string): string

  • Gets the unencoded version of an encoded component of a Uniform Resource Identifier (URI).

    Parameters

    • encodedURIComponent: string

      A value representing an encoded URI component.

    Returns string

decorator

  • Parameters

    Returns Decorator

diff

  • diff(a: any, b: any, options?: DiffOptions): string | null

  • Parameters

    Returns string | null

directive

directiveLiteral

  • Parameters

    • value: string

    Returns DirectiveLiteral

doExpression

doWhileStatement

dosDateTimeToDate

  • dosDateTimeToDate(date: number, time: number): Date

  • Parameters

    • date: number
    • time: number

    Returns Date

downloadReleases

  • downloadReleases(user: string, repo: string, outputDir: string, filterRelease?: pass, filterAsset?: pass, unzip?: boolean): Promise<string[]>

  • Downloads the releases for a particular repo, optionally filtered by release and/or based on inclusion of a particular asset.

    Parameters

    • user: string

      the name of the user or organization that owns the repo

    • repo: string

      the name of the repository that you want to list releases of

    • outputDir: string

      the relative path to a directory to write the downloaded releases to

    • Default value filterRelease: pass = pass

      the release filter function

    • Default value filterAsset: pass = pass

      the asset filter function

    • Default value unzip: boolean = false

      pass true if you want it the result to be unzipped as well.

    Returns Promise<string[]>

emptyDir

  • emptyDir(path: string): Promise<void>
  • emptyDir(path: string, callback: (err: Error) => void): void

  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

emptyDirSync

  • emptyDirSync(path: string): void

  • Parameters

    • path: string

    Returns void

emptyStatement

  • Returns EmptyStatement

emptyTypeAnnotation

encodeURI

  • encodeURI(uri: string): string

  • Encodes a text string as a valid Uniform Resource Identifier (URI)

    Parameters

    • uri: string

      A value representing an encoded URI.

    Returns string

encodeURIComponent

  • encodeURIComponent(uriComponent: string | number | boolean): string

  • Encodes a text string as a valid component of a Uniform Resource Identifier (URI).

    Parameters

    • uriComponent: string | number | boolean

      A value representing an encoded URI component.

    Returns string

ensureBlock

ensureDir

  • Parameters

    Returns Promise<void>

  • Parameters

    • path: string
    • Optional options: EnsureOptions | number
    • Optional callback: undefined | ((err: Error) => void)

    Returns void

ensureDirSync

  • ensureDirSync(path: string, options?: EnsureOptions | number): void

  • Parameters

    Returns void

ensureFile

  • ensureFile(path: string): Promise<void>
  • ensureFile(path: string, callback: (err: Error) => void): void

  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

ensureFileSync

  • ensureFileSync(path: string): void

  • Parameters

    • path: string

    Returns void

ensureLink

  • ensureLink(src: string, dest: string): Promise<void>
  • ensureLink(src: string, dest: string, callback: (err: Error) => void): void

  • Parameters

    • src: string
    • dest: string

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

ensureLinkSync

  • ensureLinkSync(src: string, dest: string): void

  • Parameters

    • src: string
    • dest: string

    Returns void

ensureSymlink

  • ensureSymlink(src: string, dest: string, type?: SymlinkType): Promise<void>
  • ensureSymlink(src: string, dest: string, type: SymlinkType, callback: (err: Error) => void): void
  • ensureSymlink(src: string, dest: string, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    • src: string
    • dest: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

ensureSymlinkSync

  • ensureSymlinkSync(src: string, dest: string, type?: SymlinkType): void

  • Parameters

    Returns void

enumBooleanBody

enumBooleanMember

enumDeclaration

enumDefaultedMember

enumNumberBody

enumNumberMember

enumStringBody

enumStringMember

enumSymbolBody

escape

  • escape(string: string): string

  • Computes a new string in which certain characters have been replaced by a hexadecimal escape sequence.

    Parameters

    • string: string

      A string value

    Returns string

eval

  • eval(x: string): any

  • Evaluates JavaScript code and executes it.

    Parameters

    • x: string

      A String value that contains valid JavaScript code.

    Returns any

existsTypeAnnotation

exportAllDeclaration

exportDefaultDeclaration

exportDefaultSpecifier

exportNamedDeclaration

exportNamespaceSpecifier

exportSpecifier

expressionStatement

fail

  • fail(error?: any): never

  • Fails a test when called within one.

    Parameters

    • Optional error: any

    Returns never

fchmod

  • fchmod(fd: number, mode: string | number, callback: (err: ErrnoException) => void): void
  • fchmod(fd: number, mode: string | number): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • mode: string | number

    Returns Promise<void>

fchown

  • fchown(fd: number, uid: number, gid: number, callback: (err: ErrnoException) => void): void
  • fchown(fd: number, uid: number, gid: number): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns Promise<void>

fdatasync

  • fdatasync(fd: number, callback: () => void): void
  • fdatasync(fd: number): Promise<void>

  • Parameters

    • fd: number
    • callback: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

file

forInStatement

forOfStatement

forStatement

format

  • format(source: string, options?: Options): string

  • format is used to format text using Prettier. Options may be provided to override the defaults.

    Parameters

    • source: string
    • Optional options: Options

    Returns string

formatWithCursor

  • formatWithCursor both formats the code, and translates a cursor position from unformatted code to formatted code. This is useful for editor integrations, to prevent the cursor from moving when code is formatted.

    The cursorOffset option should be provided, to specify where the cursor is. This option cannot be used with rangeStart and rangeEnd.

    Parameters

    Returns CursorResult

fromBuffer

  • fromBuffer(buffer: Buffer, options: Options, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void
  • fromBuffer(buffer: Buffer, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void

  • Parameters

    • buffer: Buffer
    • options: Options
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

  • Parameters

    • buffer: Buffer
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

fromFd

  • fromFd(fd: number, options: Options, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void
  • fromFd(fd: number, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void

  • Parameters

    • fd: number
    • options: Options
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

  • Parameters

    • fd: number
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

fromRandomAccessReader

  • Parameters

    Returns void

  • Parameters

    Returns void

fstat

fsync

  • Parameters

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

ftruncate

  • ftruncate(fd: number, callback: (err: ErrnoException) => void): void
  • ftruncate(fd: number, len: number, callback: (err: ErrnoException) => void): void
  • ftruncate(fd: number, len?: undefined | number): Promise<void>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • Optional len: undefined | number

    Returns Promise<void>

functionDeclaration

functionExpression

functionTypeAnnotation

functionTypeParam

futimes

  • futimes(fd: number, atime: number, mtime: number, callback: (err: ErrnoException) => void): void
  • futimes(fd: number, atime: Date, mtime: Date, callback: (err: ErrnoException) => void): void
  • futimes(fd: number, atime: number, mtime: number): Promise<void>
  • futimes(fd: number, atime: Date, mtime: Date): Promise<void>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

generate

  • Turns an AST into code, maintaining sourcemaps, user preferences, and valid output.

    Parameters

    • ast: t.Node

      the abstract syntax tree from which to generate output code.

    • Optional opts: GeneratorOptions

      used for specifying options for code generation.

    • Optional code: string | {}

      the original source code, used for source maps.

    Returns GeneratorResult

    • an object containing the output code and source map.

genericTypeAnnotation

getBindingIdentifiers

  • Parameters

    • node: Node
    • duplicates: true
    • Optional outerOnly: undefined | false | true

    Returns Record<string, Array<Identifier>>

  • Parameters

    • node: Node
    • Optional duplicates: undefined | false
    • Optional outerOnly: undefined | false | true

    Returns Record<string, Identifier>

  • Parameters

    • node: Node
    • duplicates: boolean
    • Optional outerOnly: undefined | false | true

    Returns Record<string, Identifier | Array<Identifier>>

getDefaultWatermarks

  • returns the default watermarks that would be used when not overridden

    Returns Watermarks

Const getFilteredReleases

getOuterBindingIdentifiers

  • Parameters

    • node: Node
    • duplicates: true

    Returns Record<string, Array<Identifier>>

  • Parameters

    • node: Node
    • Optional duplicates: undefined | false

    Returns Record<string, Identifier>

  • Parameters

    • node: Node
    • duplicates: boolean

    Returns Record<string, Identifier | Array<Identifier>>

getSupportInfo

  • Returns an object representing the parsers, languages and file types Prettier supports for the current version.

    Returns SupportInfo

gracefulify

  • gracefulify<T>(fsModule: T): T & Lutimes

  • Use this method to patch the global fs module (or any other fs-like module). NOTE: This should only ever be done at the top-level application layer, in order to delay on EMFILE errors from any fs-using dependencies. You should not do this in a library, because it can cause unexpected delays in other parts of the program.

    Type parameters

    • T

    Parameters

    • fsModule: T

      The reference to the fs module or an fs-like module.

    Returns T & Lutimes

identifier

  • Parameters

    • name: string

    Returns Identifier

ifStatement

importAttribute

importDeclaration

importDefaultSpecifier

importNamespaceSpecifier

importSpecifier

inferredPredicate

inheritInnerComments

  • inheritInnerComments(node: Node, parent: Node): void

  • Parameters

    Returns void

inheritLeadingComments

  • inheritLeadingComments(node: Node, parent: Node): void

  • Parameters

    Returns void

inheritTrailingComments

  • inheritTrailingComments(node: Node, parent: Node): void

  • Parameters

    Returns void

inherits

  • inherits<T>(child: T, parent: Node | null | undefined): T

  • Type parameters

    • T: Node | null | undefined

    Parameters

    • child: T
    • parent: Node | null | undefined

    Returns T

inheritsComments

  • inheritsComments<T>(node: T, parent: Node): void

  • Type parameters

    Parameters

    • node: T
    • parent: Node

    Returns void

interfaceDeclaration

interfaceExtends

interfaceTypeAnnotation

interpreterDirective

  • Parameters

    • value: string

    Returns InterpreterDirective

intersectionTypeAnnotation

is

  • is<T>(type: T, n: Node | null | undefined, required?: undefined): n is Extract<Node, { type: T }>
  • is<T, P>(type: T, n: Node | null | undefined, required: Partial<P>): n is P
  • is<P>(type: string, n: Node | null | undefined, required: Partial<P>): n is P
  • is(type: string, n: Node | null | undefined, required?: Partial<Node>): n is Node

  • Type parameters

    • T: Node["type"]

    Parameters

    • type: T
    • n: Node | null | undefined
    • Optional required: undefined

    Returns n is Extract<Node, { type: T }>

  • Type parameters

    Parameters

    • type: T
    • n: Node | null | undefined
    • required: Partial<P>

    Returns n is P

  • Type parameters

    Parameters

    • type: string
    • n: Node | null | undefined
    • required: Partial<P>

    Returns n is P

  • Parameters

    Returns n is Node

isAnyTypeAnnotation

  • isAnyTypeAnnotation(node: object | null | undefined, opts?: object | null): node is AnyTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is AnyTypeAnnotation

isArgumentPlaceholder

  • isArgumentPlaceholder(node: object | null | undefined, opts?: object | null): node is ArgumentPlaceholder

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ArgumentPlaceholder

isArrayExpression

  • isArrayExpression(node: object | null | undefined, opts?: object | null): node is ArrayExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ArrayExpression

isArrayPattern

  • isArrayPattern(node: object | null | undefined, opts?: object | null): node is ArrayPattern

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ArrayPattern

isArrayTypeAnnotation

  • isArrayTypeAnnotation(node: object | null | undefined, opts?: object | null): node is ArrayTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ArrayTypeAnnotation

isArrowFunctionExpression

  • isArrowFunctionExpression(node: object | null | undefined, opts?: object | null): node is ArrowFunctionExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ArrowFunctionExpression

isAssignmentExpression

  • isAssignmentExpression(node: object | null | undefined, opts?: object | null): node is AssignmentExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is AssignmentExpression

isAssignmentPattern

  • isAssignmentPattern(node: object | null | undefined, opts?: object | null): node is AssignmentPattern

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is AssignmentPattern

isAwaitExpression

  • isAwaitExpression(node: object | null | undefined, opts?: object | null): node is AwaitExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is AwaitExpression

isBigIntLiteral

  • isBigIntLiteral(node: object | null | undefined, opts?: object | null): node is BigIntLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BigIntLiteral

isBinary

  • isBinary(node: object | null | undefined, opts?: object | null): node is Binary

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Binary

isBinaryExpression

  • isBinaryExpression(node: object | null | undefined, opts?: object | null): node is BinaryExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BinaryExpression

isBindExpression

  • isBindExpression(node: object | null | undefined, opts?: object | null): node is BindExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BindExpression

isBinding

  • isBinding(node: Node, parent: Node, grandparent?: Node): boolean

  • Parameters

    Returns boolean

isBlock

  • isBlock(node: object | null | undefined, opts?: object | null): node is Block

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Block

isBlockParent

  • isBlockParent(node: object | null | undefined, opts?: object | null): node is BlockParent

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BlockParent

isBlockScoped

  • isBlockScoped(node: Node): node is FunctionDeclaration | ClassDeclaration | VariableDeclaration

  • Parameters

    Returns node is FunctionDeclaration | ClassDeclaration | VariableDeclaration

isBlockStatement

  • isBlockStatement(node: object | null | undefined, opts?: object | null): node is BlockStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BlockStatement

isBooleanLiteral

  • isBooleanLiteral(node: object | null | undefined, opts?: object | null): node is BooleanLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BooleanLiteral

isBooleanLiteralTypeAnnotation

  • isBooleanLiteralTypeAnnotation(node: object | null | undefined, opts?: object | null): node is BooleanLiteralTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BooleanLiteralTypeAnnotation

isBooleanTypeAnnotation

  • isBooleanTypeAnnotation(node: object | null | undefined, opts?: object | null): node is BooleanTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BooleanTypeAnnotation

isBreakStatement

  • isBreakStatement(node: object | null | undefined, opts?: object | null): node is BreakStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is BreakStatement

isCallExpression

  • isCallExpression(node: object | null | undefined, opts?: object | null): node is CallExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is CallExpression

isCatchClause

  • isCatchClause(node: object | null | undefined, opts?: object | null): node is CatchClause

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is CatchClause

isClass

  • isClass(node: object | null | undefined, opts?: object | null): node is Class

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Class

isClassBody

  • isClassBody(node: object | null | undefined, opts?: object | null): node is ClassBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassBody

isClassDeclaration

  • isClassDeclaration(node: object | null | undefined, opts?: object | null): node is ClassDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassDeclaration

isClassExpression

  • isClassExpression(node: object | null | undefined, opts?: object | null): node is ClassExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassExpression

isClassImplements

  • isClassImplements(node: object | null | undefined, opts?: object | null): node is ClassImplements

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassImplements

isClassMethod

  • isClassMethod(node: object | null | undefined, opts?: object | null): node is ClassMethod

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassMethod

isClassPrivateMethod

  • isClassPrivateMethod(node: object | null | undefined, opts?: object | null): node is ClassPrivateMethod

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassPrivateMethod

isClassPrivateProperty

  • isClassPrivateProperty(node: object | null | undefined, opts?: object | null): node is ClassPrivateProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassPrivateProperty

isClassProperty

  • isClassProperty(node: object | null | undefined, opts?: object | null): node is ClassProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ClassProperty

isCompletionStatement

  • isCompletionStatement(node: object | null | undefined, opts?: object | null): node is CompletionStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is CompletionStatement

isConditional

  • isConditional(node: object | null | undefined, opts?: object | null): node is Conditional

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Conditional

isConditionalExpression

  • isConditionalExpression(node: object | null | undefined, opts?: object | null): node is ConditionalExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ConditionalExpression

isContinueStatement

  • isContinueStatement(node: object | null | undefined, opts?: object | null): node is ContinueStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ContinueStatement

isDebuggerStatement

  • isDebuggerStatement(node: object | null | undefined, opts?: object | null): node is DebuggerStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DebuggerStatement

isDecimalLiteral

  • isDecimalLiteral(node: object | null | undefined, opts?: object | null): node is DecimalLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DecimalLiteral

isDeclaration

  • isDeclaration(node: object | null | undefined, opts?: object | null): node is Declaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Declaration

isDeclareClass

  • isDeclareClass(node: object | null | undefined, opts?: object | null): node is DeclareClass

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareClass

isDeclareExportAllDeclaration

  • isDeclareExportAllDeclaration(node: object | null | undefined, opts?: object | null): node is DeclareExportAllDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareExportAllDeclaration

isDeclareExportDeclaration

  • isDeclareExportDeclaration(node: object | null | undefined, opts?: object | null): node is DeclareExportDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareExportDeclaration

isDeclareFunction

  • isDeclareFunction(node: object | null | undefined, opts?: object | null): node is DeclareFunction

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareFunction

isDeclareInterface

  • isDeclareInterface(node: object | null | undefined, opts?: object | null): node is DeclareInterface

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareInterface

isDeclareModule

  • isDeclareModule(node: object | null | undefined, opts?: object | null): node is DeclareModule

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareModule

isDeclareModuleExports

  • isDeclareModuleExports(node: object | null | undefined, opts?: object | null): node is DeclareModuleExports

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareModuleExports

isDeclareOpaqueType

  • isDeclareOpaqueType(node: object | null | undefined, opts?: object | null): node is DeclareOpaqueType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareOpaqueType

isDeclareTypeAlias

  • isDeclareTypeAlias(node: object | null | undefined, opts?: object | null): node is DeclareTypeAlias

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareTypeAlias

isDeclareVariable

  • isDeclareVariable(node: object | null | undefined, opts?: object | null): node is DeclareVariable

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclareVariable

isDeclaredPredicate

  • isDeclaredPredicate(node: object | null | undefined, opts?: object | null): node is DeclaredPredicate

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DeclaredPredicate

isDecorator

  • isDecorator(node: object | null | undefined, opts?: object | null): node is Decorator

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Decorator

isDirective

  • isDirective(node: object | null | undefined, opts?: object | null): node is Directive

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Directive

isDirectiveLiteral

  • isDirectiveLiteral(node: object | null | undefined, opts?: object | null): node is DirectiveLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DirectiveLiteral

isDoExpression

  • isDoExpression(node: object | null | undefined, opts?: object | null): node is DoExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DoExpression

isDoWhileStatement

  • isDoWhileStatement(node: object | null | undefined, opts?: object | null): node is DoWhileStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is DoWhileStatement

isEmptyStatement

  • isEmptyStatement(node: object | null | undefined, opts?: object | null): node is EmptyStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EmptyStatement

isEmptyTypeAnnotation

  • isEmptyTypeAnnotation(node: object | null | undefined, opts?: object | null): node is EmptyTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EmptyTypeAnnotation

isEnumBody

  • isEnumBody(node: object | null | undefined, opts?: object | null): node is EnumBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumBody

isEnumBooleanBody

  • isEnumBooleanBody(node: object | null | undefined, opts?: object | null): node is EnumBooleanBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumBooleanBody

isEnumBooleanMember

  • isEnumBooleanMember(node: object | null | undefined, opts?: object | null): node is EnumBooleanMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumBooleanMember

isEnumDeclaration

  • isEnumDeclaration(node: object | null | undefined, opts?: object | null): node is EnumDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumDeclaration

isEnumDefaultedMember

  • isEnumDefaultedMember(node: object | null | undefined, opts?: object | null): node is EnumDefaultedMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumDefaultedMember

isEnumMember

  • isEnumMember(node: object | null | undefined, opts?: object | null): node is EnumMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumMember

isEnumNumberBody

  • isEnumNumberBody(node: object | null | undefined, opts?: object | null): node is EnumNumberBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumNumberBody

isEnumNumberMember

  • isEnumNumberMember(node: object | null | undefined, opts?: object | null): node is EnumNumberMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumNumberMember

isEnumStringBody

  • isEnumStringBody(node: object | null | undefined, opts?: object | null): node is EnumStringBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumStringBody

isEnumStringMember

  • isEnumStringMember(node: object | null | undefined, opts?: object | null): node is EnumStringMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumStringMember

isEnumSymbolBody

  • isEnumSymbolBody(node: object | null | undefined, opts?: object | null): node is EnumSymbolBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is EnumSymbolBody

isExistsTypeAnnotation

  • isExistsTypeAnnotation(node: object | null | undefined, opts?: object | null): node is ExistsTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExistsTypeAnnotation

isExportAllDeclaration

  • isExportAllDeclaration(node: object | null | undefined, opts?: object | null): node is ExportAllDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportAllDeclaration

isExportDeclaration

  • isExportDeclaration(node: object | null | undefined, opts?: object | null): node is ExportDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportDeclaration

isExportDefaultDeclaration

  • isExportDefaultDeclaration(node: object | null | undefined, opts?: object | null): node is ExportDefaultDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportDefaultDeclaration

isExportDefaultSpecifier

  • isExportDefaultSpecifier(node: object | null | undefined, opts?: object | null): node is ExportDefaultSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportDefaultSpecifier

isExportNamedDeclaration

  • isExportNamedDeclaration(node: object | null | undefined, opts?: object | null): node is ExportNamedDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportNamedDeclaration

isExportNamespaceSpecifier

  • isExportNamespaceSpecifier(node: object | null | undefined, opts?: object | null): node is ExportNamespaceSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportNamespaceSpecifier

isExportSpecifier

  • isExportSpecifier(node: object | null | undefined, opts?: object | null): node is ExportSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExportSpecifier

isExpression

  • isExpression(node: object | null | undefined, opts?: object | null): node is Expression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Expression

isExpressionStatement

  • isExpressionStatement(node: object | null | undefined, opts?: object | null): node is ExpressionStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExpressionStatement

isExpressionWrapper

  • isExpressionWrapper(node: object | null | undefined, opts?: object | null): node is ExpressionWrapper

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ExpressionWrapper

isFile

  • isFile(node: object | null | undefined, opts?: object | null): node is File

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is File

isFinite

  • isFinite(number: number): boolean

  • Determines whether a supplied number is finite.

    Parameters

    • number: number

      Any numeric value.

    Returns boolean

isFlow

  • isFlow(node: object | null | undefined, opts?: object | null): node is Flow

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Flow

isFlowBaseAnnotation

  • isFlowBaseAnnotation(node: object | null | undefined, opts?: object | null): node is FlowBaseAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FlowBaseAnnotation

isFlowDeclaration

  • isFlowDeclaration(node: object | null | undefined, opts?: object | null): node is FlowDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FlowDeclaration

isFlowPredicate

  • isFlowPredicate(node: object | null | undefined, opts?: object | null): node is FlowPredicate

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FlowPredicate

isFlowType

  • isFlowType(node: object | null | undefined, opts?: object | null): node is FlowType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FlowType

isFor

  • isFor(node: object | null | undefined, opts?: object | null): node is For

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is For

isForInStatement

  • isForInStatement(node: object | null | undefined, opts?: object | null): node is ForInStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ForInStatement

isForOfStatement

  • isForOfStatement(node: object | null | undefined, opts?: object | null): node is ForOfStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ForOfStatement

isForStatement

  • isForStatement(node: object | null | undefined, opts?: object | null): node is ForStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ForStatement

isForXStatement

  • isForXStatement(node: object | null | undefined, opts?: object | null): node is ForXStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ForXStatement

isFunction

  • isFunction(node: object | null | undefined, opts?: object | null): node is Function

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Function

isFunctionDeclaration

  • isFunctionDeclaration(node: object | null | undefined, opts?: object | null): node is FunctionDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FunctionDeclaration

isFunctionExpression

  • isFunctionExpression(node: object | null | undefined, opts?: object | null): node is FunctionExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FunctionExpression

isFunctionParent

  • isFunctionParent(node: object | null | undefined, opts?: object | null): node is FunctionParent

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FunctionParent

isFunctionTypeAnnotation

  • isFunctionTypeAnnotation(node: object | null | undefined, opts?: object | null): node is FunctionTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FunctionTypeAnnotation

isFunctionTypeParam

  • isFunctionTypeParam(node: object | null | undefined, opts?: object | null): node is FunctionTypeParam

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is FunctionTypeParam

isGenericTypeAnnotation

  • isGenericTypeAnnotation(node: object | null | undefined, opts?: object | null): node is GenericTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is GenericTypeAnnotation

isIdentifier

  • isIdentifier(node: object | null | undefined, opts?: object | null): node is Identifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Identifier

isIfStatement

  • isIfStatement(node: object | null | undefined, opts?: object | null): node is IfStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is IfStatement

isImmutable

  • isImmutable(node: object | null | undefined, opts?: object | null): node is Immutable
  • isImmutable(node: Node): node is Immutable

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Immutable

  • Parameters

    Returns node is Immutable

isImport

  • isImport(node: object | null | undefined, opts?: object | null): node is Import

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Import

isImportAttribute

  • isImportAttribute(node: object | null | undefined, opts?: object | null): node is ImportAttribute

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ImportAttribute

isImportDeclaration

  • isImportDeclaration(node: object | null | undefined, opts?: object | null): node is ImportDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ImportDeclaration

isImportDefaultSpecifier

  • isImportDefaultSpecifier(node: object | null | undefined, opts?: object | null): node is ImportDefaultSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ImportDefaultSpecifier

isImportNamespaceSpecifier

  • isImportNamespaceSpecifier(node: object | null | undefined, opts?: object | null): node is ImportNamespaceSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ImportNamespaceSpecifier

isImportSpecifier

  • isImportSpecifier(node: object | null | undefined, opts?: object | null): node is ImportSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ImportSpecifier

isInferredPredicate

  • isInferredPredicate(node: object | null | undefined, opts?: object | null): node is InferredPredicate

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is InferredPredicate

isInterfaceDeclaration

  • isInterfaceDeclaration(node: object | null | undefined, opts?: object | null): node is InterfaceDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is InterfaceDeclaration

isInterfaceExtends

  • isInterfaceExtends(node: object | null | undefined, opts?: object | null): node is InterfaceExtends

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is InterfaceExtends

isInterfaceTypeAnnotation

  • isInterfaceTypeAnnotation(node: object | null | undefined, opts?: object | null): node is InterfaceTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is InterfaceTypeAnnotation

isInterpreterDirective

  • isInterpreterDirective(node: object | null | undefined, opts?: object | null): node is InterpreterDirective

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is InterpreterDirective

isIntersectionTypeAnnotation

  • isIntersectionTypeAnnotation(node: object | null | undefined, opts?: object | null): node is IntersectionTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is IntersectionTypeAnnotation

isJSX

  • isJSX(node: object | null | undefined, opts?: object | null): node is JSX

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSX

isJSXAttribute

  • isJSXAttribute(node: object | null | undefined, opts?: object | null): node is JSXAttribute

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXAttribute

isJSXClosingElement

  • isJSXClosingElement(node: object | null | undefined, opts?: object | null): node is JSXClosingElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXClosingElement

isJSXClosingFragment

  • isJSXClosingFragment(node: object | null | undefined, opts?: object | null): node is JSXClosingFragment

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXClosingFragment

isJSXElement

  • isJSXElement(node: object | null | undefined, opts?: object | null): node is JSXElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXElement

isJSXEmptyExpression

  • isJSXEmptyExpression(node: object | null | undefined, opts?: object | null): node is JSXEmptyExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXEmptyExpression

isJSXExpressionContainer

  • isJSXExpressionContainer(node: object | null | undefined, opts?: object | null): node is JSXExpressionContainer

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXExpressionContainer

isJSXFragment

  • isJSXFragment(node: object | null | undefined, opts?: object | null): node is JSXFragment

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXFragment

isJSXIdentifier

  • isJSXIdentifier(node: object | null | undefined, opts?: object | null): node is JSXIdentifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXIdentifier

isJSXMemberExpression

  • isJSXMemberExpression(node: object | null | undefined, opts?: object | null): node is JSXMemberExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXMemberExpression

isJSXNamespacedName

  • isJSXNamespacedName(node: object | null | undefined, opts?: object | null): node is JSXNamespacedName

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXNamespacedName

isJSXOpeningElement

  • isJSXOpeningElement(node: object | null | undefined, opts?: object | null): node is JSXOpeningElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXOpeningElement

isJSXOpeningFragment

  • isJSXOpeningFragment(node: object | null | undefined, opts?: object | null): node is JSXOpeningFragment

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXOpeningFragment

isJSXSpreadAttribute

  • isJSXSpreadAttribute(node: object | null | undefined, opts?: object | null): node is JSXSpreadAttribute

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXSpreadAttribute

isJSXSpreadChild

  • isJSXSpreadChild(node: object | null | undefined, opts?: object | null): node is JSXSpreadChild

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXSpreadChild

isJSXText

  • isJSXText(node: object | null | undefined, opts?: object | null): node is JSXText

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is JSXText

isLVal

  • isLVal(node: object | null | undefined, opts?: object | null): node is LVal

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is LVal

isLabeledStatement

  • isLabeledStatement(node: object | null | undefined, opts?: object | null): node is LabeledStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is LabeledStatement

isLet

  • isLet(node: Node): node is VariableDeclaration

  • Parameters

    Returns node is VariableDeclaration

isLiteral

  • isLiteral(node: object | null | undefined, opts?: object | null): node is Literal

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Literal

isLogicalExpression

  • isLogicalExpression(node: object | null | undefined, opts?: object | null): node is LogicalExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is LogicalExpression

isLoop

  • isLoop(node: object | null | undefined, opts?: object | null): node is Loop

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Loop

isMemberExpression

  • isMemberExpression(node: object | null | undefined, opts?: object | null): node is MemberExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is MemberExpression

isMetaProperty

  • isMetaProperty(node: object | null | undefined, opts?: object | null): node is MetaProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is MetaProperty

isMethod

  • isMethod(node: object | null | undefined, opts?: object | null): node is Method

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Method

isMixedTypeAnnotation

  • isMixedTypeAnnotation(node: object | null | undefined, opts?: object | null): node is MixedTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is MixedTypeAnnotation

isModuleDeclaration

  • isModuleDeclaration(node: object | null | undefined, opts?: object | null): node is ModuleDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ModuleDeclaration

isModuleSpecifier

  • isModuleSpecifier(node: object | null | undefined, opts?: object | null): node is ModuleSpecifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ModuleSpecifier

isNaN

  • isNaN(number: number): boolean

  • Returns a Boolean value that indicates whether a value is the reserved value NaN (not a number).

    Parameters

    • number: number

      A numeric value.

    Returns boolean

isNewExpression

  • isNewExpression(node: object | null | undefined, opts?: object | null): node is NewExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NewExpression

isNode

  • isNode(node: object | null | undefined): node is Node

  • Parameters

    • node: object | null | undefined

    Returns node is Node

isNodesEquivalent

  • isNodesEquivalent<T>(a: T, b: any): b is T
  • isNodesEquivalent(a: any, b: any): boolean

  • Type parameters

    Parameters

    • a: T
    • b: any

    Returns b is T

  • Parameters

    • a: any
    • b: any

    Returns boolean

isNoop

  • isNoop(node: object | null | undefined, opts?: object | null): node is Noop

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Noop

isNullLiteral

  • isNullLiteral(node: object | null | undefined, opts?: object | null): node is NullLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NullLiteral

isNullLiteralTypeAnnotation

  • isNullLiteralTypeAnnotation(node: object | null | undefined, opts?: object | null): node is NullLiteralTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NullLiteralTypeAnnotation

isNullableTypeAnnotation

  • isNullableTypeAnnotation(node: object | null | undefined, opts?: object | null): node is NullableTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NullableTypeAnnotation

isNumberLiteral

  • isNumberLiteral(node: object | null | undefined, opts?: object | null): boolean

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns boolean

isNumberLiteralTypeAnnotation

  • isNumberLiteralTypeAnnotation(node: object | null | undefined, opts?: object | null): node is NumberLiteralTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NumberLiteralTypeAnnotation

isNumberTypeAnnotation

  • isNumberTypeAnnotation(node: object | null | undefined, opts?: object | null): node is NumberTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NumberTypeAnnotation

isNumericLiteral

  • isNumericLiteral(node: object | null | undefined, opts?: object | null): node is NumericLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is NumericLiteral

isObjectExpression

  • isObjectExpression(node: object | null | undefined, opts?: object | null): node is ObjectExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectExpression

isObjectMember

  • isObjectMember(node: object | null | undefined, opts?: object | null): node is ObjectMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectMember

isObjectMethod

  • isObjectMethod(node: object | null | undefined, opts?: object | null): node is ObjectMethod

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectMethod

isObjectPattern

  • isObjectPattern(node: object | null | undefined, opts?: object | null): node is ObjectPattern

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectPattern

isObjectProperty

  • isObjectProperty(node: object | null | undefined, opts?: object | null): node is ObjectProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectProperty

isObjectTypeAnnotation

  • isObjectTypeAnnotation(node: object | null | undefined, opts?: object | null): node is ObjectTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeAnnotation

isObjectTypeCallProperty

  • isObjectTypeCallProperty(node: object | null | undefined, opts?: object | null): node is ObjectTypeCallProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeCallProperty

isObjectTypeIndexer

  • isObjectTypeIndexer(node: object | null | undefined, opts?: object | null): node is ObjectTypeIndexer

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeIndexer

isObjectTypeInternalSlot

  • isObjectTypeInternalSlot(node: object | null | undefined, opts?: object | null): node is ObjectTypeInternalSlot

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeInternalSlot

isObjectTypeProperty

  • isObjectTypeProperty(node: object | null | undefined, opts?: object | null): node is ObjectTypeProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeProperty

isObjectTypeSpreadProperty

  • isObjectTypeSpreadProperty(node: object | null | undefined, opts?: object | null): node is ObjectTypeSpreadProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ObjectTypeSpreadProperty

isOpaqueType

  • isOpaqueType(node: object | null | undefined, opts?: object | null): node is OpaqueType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is OpaqueType

isOptionalCallExpression

  • isOptionalCallExpression(node: object | null | undefined, opts?: object | null): node is OptionalCallExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is OptionalCallExpression

isOptionalMemberExpression

  • isOptionalMemberExpression(node: object | null | undefined, opts?: object | null): node is OptionalMemberExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is OptionalMemberExpression

isParenthesizedExpression

  • isParenthesizedExpression(node: object | null | undefined, opts?: object | null): node is ParenthesizedExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ParenthesizedExpression

isPattern

  • isPattern(node: object | null | undefined, opts?: object | null): node is Pattern

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Pattern

isPatternLike

  • isPatternLike(node: object | null | undefined, opts?: object | null): node is PatternLike

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is PatternLike

isPipelineBareFunction

  • isPipelineBareFunction(node: object | null | undefined, opts?: object | null): node is PipelineBareFunction

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is PipelineBareFunction

isPipelinePrimaryTopicReference

  • isPipelinePrimaryTopicReference(node: object | null | undefined, opts?: object | null): node is PipelinePrimaryTopicReference

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is PipelinePrimaryTopicReference

isPipelineTopicExpression

  • isPipelineTopicExpression(node: object | null | undefined, opts?: object | null): node is PipelineTopicExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is PipelineTopicExpression

isPlaceholder

  • isPlaceholder(node: object | null | undefined, opts?: object | null): node is Placeholder

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Placeholder

isPlaceholderType

  • isPlaceholderType(placeholderType: Node["type"], targetType: Node["type"]): boolean

  • Parameters

    • placeholderType: Node["type"]
    • targetType: Node["type"]

    Returns boolean

isPrivate

  • isPrivate(node: object | null | undefined, opts?: object | null): node is Private

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Private

isPrivateName

  • isPrivateName(node: object | null | undefined, opts?: object | null): node is PrivateName

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is PrivateName

isProgram

  • isProgram(node: object | null | undefined, opts?: object | null): node is Program

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Program

isProperty

  • isProperty(node: object | null | undefined, opts?: object | null): node is Property

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Property

isPureish

  • isPureish(node: object | null | undefined, opts?: object | null): node is Pureish

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Pureish

isQualifiedTypeIdentifier

  • isQualifiedTypeIdentifier(node: object | null | undefined, opts?: object | null): node is QualifiedTypeIdentifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is QualifiedTypeIdentifier

isRecordExpression

  • isRecordExpression(node: object | null | undefined, opts?: object | null): node is RecordExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is RecordExpression

isReferenced

  • isReferenced(node: Node, parent: Node, grandparent?: Node): boolean

  • Parameters

    Returns boolean

isRegExpLiteral

  • isRegExpLiteral(node: object | null | undefined, opts?: object | null): node is RegExpLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is RegExpLiteral

isRegexLiteral

  • isRegexLiteral(node: object | null | undefined, opts?: object | null): boolean

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns boolean

isRestElement

  • isRestElement(node: object | null | undefined, opts?: object | null): node is RestElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is RestElement

isRestProperty

  • isRestProperty(node: object | null | undefined, opts?: object | null): boolean

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns boolean

isReturnStatement

  • isReturnStatement(node: object | null | undefined, opts?: object | null): node is ReturnStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ReturnStatement

isScopable

  • isScopable(node: object | null | undefined, opts?: object | null): node is Scopable

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Scopable

isScope

  • isScope(node: Node, parent: Node): node is Scopable

  • Parameters

    Returns node is Scopable

isSequenceExpression

  • isSequenceExpression(node: object | null | undefined, opts?: object | null): node is SequenceExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is SequenceExpression

isSpecifierDefault

  • Parameters

    Returns boolean

isSpreadElement

  • isSpreadElement(node: object | null | undefined, opts?: object | null): node is SpreadElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is SpreadElement

isSpreadProperty

  • isSpreadProperty(node: object | null | undefined, opts?: object | null): boolean

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns boolean

isStatement

  • isStatement(node: object | null | undefined, opts?: object | null): node is Statement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Statement

isStringLiteral

  • isStringLiteral(node: object | null | undefined, opts?: object | null): node is StringLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is StringLiteral

isStringLiteralTypeAnnotation

  • isStringLiteralTypeAnnotation(node: object | null | undefined, opts?: object | null): node is StringLiteralTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is StringLiteralTypeAnnotation

isStringTypeAnnotation

  • isStringTypeAnnotation(node: object | null | undefined, opts?: object | null): node is StringTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is StringTypeAnnotation

isSuper

  • isSuper(node: object | null | undefined, opts?: object | null): node is Super

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Super

isSwitchCase

  • isSwitchCase(node: object | null | undefined, opts?: object | null): node is SwitchCase

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is SwitchCase

isSwitchStatement

  • isSwitchStatement(node: object | null | undefined, opts?: object | null): node is SwitchStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is SwitchStatement

isSymbolTypeAnnotation

  • isSymbolTypeAnnotation(node: object | null | undefined, opts?: object | null): node is SymbolTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is SymbolTypeAnnotation

isTSAnyKeyword

  • isTSAnyKeyword(node: object | null | undefined, opts?: object | null): node is TSAnyKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSAnyKeyword

isTSArrayType

  • isTSArrayType(node: object | null | undefined, opts?: object | null): node is TSArrayType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSArrayType

isTSAsExpression

  • isTSAsExpression(node: object | null | undefined, opts?: object | null): node is TSAsExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSAsExpression

isTSBaseType

  • isTSBaseType(node: object | null | undefined, opts?: object | null): node is TSBaseType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSBaseType

isTSBigIntKeyword

  • isTSBigIntKeyword(node: object | null | undefined, opts?: object | null): node is TSBigIntKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSBigIntKeyword

isTSBooleanKeyword

  • isTSBooleanKeyword(node: object | null | undefined, opts?: object | null): node is TSBooleanKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSBooleanKeyword

isTSCallSignatureDeclaration

  • isTSCallSignatureDeclaration(node: object | null | undefined, opts?: object | null): node is TSCallSignatureDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSCallSignatureDeclaration

isTSConditionalType

  • isTSConditionalType(node: object | null | undefined, opts?: object | null): node is TSConditionalType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSConditionalType

isTSConstructSignatureDeclaration

  • isTSConstructSignatureDeclaration(node: object | null | undefined, opts?: object | null): node is TSConstructSignatureDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSConstructSignatureDeclaration

isTSConstructorType

  • isTSConstructorType(node: object | null | undefined, opts?: object | null): node is TSConstructorType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSConstructorType

isTSDeclareFunction

  • isTSDeclareFunction(node: object | null | undefined, opts?: object | null): node is TSDeclareFunction

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSDeclareFunction

isTSDeclareMethod

  • isTSDeclareMethod(node: object | null | undefined, opts?: object | null): node is TSDeclareMethod

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSDeclareMethod

isTSEntityName

  • isTSEntityName(node: object | null | undefined, opts?: object | null): node is TSEntityName

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSEntityName

isTSEnumDeclaration

  • isTSEnumDeclaration(node: object | null | undefined, opts?: object | null): node is TSEnumDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSEnumDeclaration

isTSEnumMember

  • isTSEnumMember(node: object | null | undefined, opts?: object | null): node is TSEnumMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSEnumMember

isTSExportAssignment

  • isTSExportAssignment(node: object | null | undefined, opts?: object | null): node is TSExportAssignment

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSExportAssignment

isTSExpressionWithTypeArguments

  • isTSExpressionWithTypeArguments(node: object | null | undefined, opts?: object | null): node is TSExpressionWithTypeArguments

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSExpressionWithTypeArguments

isTSExternalModuleReference

  • isTSExternalModuleReference(node: object | null | undefined, opts?: object | null): node is TSExternalModuleReference

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSExternalModuleReference

isTSFunctionType

  • isTSFunctionType(node: object | null | undefined, opts?: object | null): node is TSFunctionType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSFunctionType

isTSImportEqualsDeclaration

  • isTSImportEqualsDeclaration(node: object | null | undefined, opts?: object | null): node is TSImportEqualsDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSImportEqualsDeclaration

isTSImportType

  • isTSImportType(node: object | null | undefined, opts?: object | null): node is TSImportType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSImportType

isTSIndexSignature

  • isTSIndexSignature(node: object | null | undefined, opts?: object | null): node is TSIndexSignature

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSIndexSignature

isTSIndexedAccessType

  • isTSIndexedAccessType(node: object | null | undefined, opts?: object | null): node is TSIndexedAccessType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSIndexedAccessType

isTSInferType

  • isTSInferType(node: object | null | undefined, opts?: object | null): node is TSInferType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSInferType

isTSInterfaceBody

  • isTSInterfaceBody(node: object | null | undefined, opts?: object | null): node is TSInterfaceBody

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSInterfaceBody

isTSInterfaceDeclaration

  • isTSInterfaceDeclaration(node: object | null | undefined, opts?: object | null): node is TSInterfaceDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSInterfaceDeclaration

isTSIntersectionType

  • isTSIntersectionType(node: object | null | undefined, opts?: object | null): node is TSIntersectionType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSIntersectionType

isTSLiteralType

  • isTSLiteralType(node: object | null | undefined, opts?: object | null): node is TSLiteralType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSLiteralType

isTSMappedType

  • isTSMappedType(node: object | null | undefined, opts?: object | null): node is TSMappedType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSMappedType

isTSMethodSignature

  • isTSMethodSignature(node: object | null | undefined, opts?: object | null): node is TSMethodSignature

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSMethodSignature

isTSModuleBlock

  • isTSModuleBlock(node: object | null | undefined, opts?: object | null): node is TSModuleBlock

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSModuleBlock

isTSModuleDeclaration

  • isTSModuleDeclaration(node: object | null | undefined, opts?: object | null): node is TSModuleDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSModuleDeclaration

isTSNamedTupleMember

  • isTSNamedTupleMember(node: object | null | undefined, opts?: object | null): node is TSNamedTupleMember

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNamedTupleMember

isTSNamespaceExportDeclaration

  • isTSNamespaceExportDeclaration(node: object | null | undefined, opts?: object | null): node is TSNamespaceExportDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNamespaceExportDeclaration

isTSNeverKeyword

  • isTSNeverKeyword(node: object | null | undefined, opts?: object | null): node is TSNeverKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNeverKeyword

isTSNonNullExpression

  • isTSNonNullExpression(node: object | null | undefined, opts?: object | null): node is TSNonNullExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNonNullExpression

isTSNullKeyword

  • isTSNullKeyword(node: object | null | undefined, opts?: object | null): node is TSNullKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNullKeyword

isTSNumberKeyword

  • isTSNumberKeyword(node: object | null | undefined, opts?: object | null): node is TSNumberKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSNumberKeyword

isTSObjectKeyword

  • isTSObjectKeyword(node: object | null | undefined, opts?: object | null): node is TSObjectKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSObjectKeyword

isTSOptionalType

  • isTSOptionalType(node: object | null | undefined, opts?: object | null): node is TSOptionalType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSOptionalType

isTSParameterProperty

  • isTSParameterProperty(node: object | null | undefined, opts?: object | null): node is TSParameterProperty

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSParameterProperty

isTSParenthesizedType

  • isTSParenthesizedType(node: object | null | undefined, opts?: object | null): node is TSParenthesizedType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSParenthesizedType

isTSPropertySignature

  • isTSPropertySignature(node: object | null | undefined, opts?: object | null): node is TSPropertySignature

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSPropertySignature

isTSQualifiedName

  • isTSQualifiedName(node: object | null | undefined, opts?: object | null): node is TSQualifiedName

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSQualifiedName

isTSRestType

  • isTSRestType(node: object | null | undefined, opts?: object | null): node is TSRestType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSRestType

isTSStringKeyword

  • isTSStringKeyword(node: object | null | undefined, opts?: object | null): node is TSStringKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSStringKeyword

isTSSymbolKeyword

  • isTSSymbolKeyword(node: object | null | undefined, opts?: object | null): node is TSSymbolKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSSymbolKeyword

isTSThisType

  • isTSThisType(node: object | null | undefined, opts?: object | null): node is TSThisType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSThisType

isTSTupleType

  • isTSTupleType(node: object | null | undefined, opts?: object | null): node is TSTupleType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTupleType

isTSType

  • isTSType(node: object | null | undefined, opts?: object | null): node is TSType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSType

isTSTypeAliasDeclaration

  • isTSTypeAliasDeclaration(node: object | null | undefined, opts?: object | null): node is TSTypeAliasDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeAliasDeclaration

isTSTypeAnnotation

  • isTSTypeAnnotation(node: object | null | undefined, opts?: object | null): node is TSTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeAnnotation

isTSTypeAssertion

  • isTSTypeAssertion(node: object | null | undefined, opts?: object | null): node is TSTypeAssertion

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeAssertion

isTSTypeElement

  • isTSTypeElement(node: object | null | undefined, opts?: object | null): node is TSTypeElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeElement

isTSTypeLiteral

  • isTSTypeLiteral(node: object | null | undefined, opts?: object | null): node is TSTypeLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeLiteral

isTSTypeOperator

  • isTSTypeOperator(node: object | null | undefined, opts?: object | null): node is TSTypeOperator

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeOperator

isTSTypeParameter

  • isTSTypeParameter(node: object | null | undefined, opts?: object | null): node is TSTypeParameter

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeParameter

isTSTypeParameterDeclaration

  • isTSTypeParameterDeclaration(node: object | null | undefined, opts?: object | null): node is TSTypeParameterDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeParameterDeclaration

isTSTypeParameterInstantiation

  • isTSTypeParameterInstantiation(node: object | null | undefined, opts?: object | null): node is TSTypeParameterInstantiation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeParameterInstantiation

isTSTypePredicate

  • isTSTypePredicate(node: object | null | undefined, opts?: object | null): node is TSTypePredicate

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypePredicate

isTSTypeQuery

  • isTSTypeQuery(node: object | null | undefined, opts?: object | null): node is TSTypeQuery

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeQuery

isTSTypeReference

  • isTSTypeReference(node: object | null | undefined, opts?: object | null): node is TSTypeReference

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSTypeReference

isTSUndefinedKeyword

  • isTSUndefinedKeyword(node: object | null | undefined, opts?: object | null): node is TSUndefinedKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSUndefinedKeyword

isTSUnionType

  • isTSUnionType(node: object | null | undefined, opts?: object | null): node is TSUnionType

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSUnionType

isTSUnknownKeyword

  • isTSUnknownKeyword(node: object | null | undefined, opts?: object | null): node is TSUnknownKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSUnknownKeyword

isTSVoidKeyword

  • isTSVoidKeyword(node: object | null | undefined, opts?: object | null): node is TSVoidKeyword

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TSVoidKeyword

isTaggedTemplateExpression

  • isTaggedTemplateExpression(node: object | null | undefined, opts?: object | null): node is TaggedTemplateExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TaggedTemplateExpression

isTemplateElement

  • isTemplateElement(node: object | null | undefined, opts?: object | null): node is TemplateElement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TemplateElement

isTemplateLiteral

  • isTemplateLiteral(node: object | null | undefined, opts?: object | null): node is TemplateLiteral

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TemplateLiteral

isTerminatorless

  • isTerminatorless(node: object | null | undefined, opts?: object | null): node is Terminatorless

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Terminatorless

isThisExpression

  • isThisExpression(node: object | null | undefined, opts?: object | null): node is ThisExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ThisExpression

isThisTypeAnnotation

  • isThisTypeAnnotation(node: object | null | undefined, opts?: object | null): node is ThisTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ThisTypeAnnotation

isThrowStatement

  • isThrowStatement(node: object | null | undefined, opts?: object | null): node is ThrowStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is ThrowStatement

isTryStatement

  • isTryStatement(node: object | null | undefined, opts?: object | null): node is TryStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TryStatement

isTupleExpression

  • isTupleExpression(node: object | null | undefined, opts?: object | null): node is TupleExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TupleExpression

isTupleTypeAnnotation

  • isTupleTypeAnnotation(node: object | null | undefined, opts?: object | null): node is TupleTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TupleTypeAnnotation

isType

  • isType<T>(nodetype: string, targetType: T): nodetype is T
  • isType(nodetype: string | null | undefined, targetType: string): boolean

  • Type parameters

    • T: Node["type"]

    Parameters

    • nodetype: string
    • targetType: T

    Returns nodetype is T

  • Parameters

    • nodetype: string | null | undefined
    • targetType: string

    Returns boolean

isTypeAlias

  • isTypeAlias(node: object | null | undefined, opts?: object | null): node is TypeAlias

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeAlias

isTypeAnnotation

  • isTypeAnnotation(node: object | null | undefined, opts?: object | null): node is TypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeAnnotation

isTypeCastExpression

  • isTypeCastExpression(node: object | null | undefined, opts?: object | null): node is TypeCastExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeCastExpression

isTypeParameter

  • isTypeParameter(node: object | null | undefined, opts?: object | null): node is TypeParameter

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeParameter

isTypeParameterDeclaration

  • isTypeParameterDeclaration(node: object | null | undefined, opts?: object | null): node is TypeParameterDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeParameterDeclaration

isTypeParameterInstantiation

  • isTypeParameterInstantiation(node: object | null | undefined, opts?: object | null): node is TypeParameterInstantiation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeParameterInstantiation

isTypeofTypeAnnotation

  • isTypeofTypeAnnotation(node: object | null | undefined, opts?: object | null): node is TypeofTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is TypeofTypeAnnotation

isUnaryExpression

  • isUnaryExpression(node: object | null | undefined, opts?: object | null): node is UnaryExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is UnaryExpression

isUnaryLike

  • isUnaryLike(node: object | null | undefined, opts?: object | null): node is UnaryLike

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is UnaryLike

isUnionTypeAnnotation

  • isUnionTypeAnnotation(node: object | null | undefined, opts?: object | null): node is UnionTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is UnionTypeAnnotation

isUpdateExpression

  • isUpdateExpression(node: object | null | undefined, opts?: object | null): node is UpdateExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is UpdateExpression

isUserWhitespacable

  • isUserWhitespacable(node: object | null | undefined, opts?: object | null): node is UserWhitespacable

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is UserWhitespacable

isV8IntrinsicIdentifier

  • isV8IntrinsicIdentifier(node: object | null | undefined, opts?: object | null): node is V8IntrinsicIdentifier

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is V8IntrinsicIdentifier

isValidES3Identifier

  • isValidES3Identifier(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

isValidIdentifier

  • isValidIdentifier(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

isVar

  • isVar(node: Node): node is VariableDeclaration

  • Parameters

    Returns node is VariableDeclaration

isVariableDeclaration

  • isVariableDeclaration(node: object | null | undefined, opts?: object | null): node is VariableDeclaration

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is VariableDeclaration

isVariableDeclarator

  • isVariableDeclarator(node: object | null | undefined, opts?: object | null): node is VariableDeclarator

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is VariableDeclarator

isVariance

  • isVariance(node: object | null | undefined, opts?: object | null): node is Variance

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is Variance

isVoidTypeAnnotation

  • isVoidTypeAnnotation(node: object | null | undefined, opts?: object | null): node is VoidTypeAnnotation

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is VoidTypeAnnotation

isWhile

  • isWhile(node: object | null | undefined, opts?: object | null): node is While

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is While

isWhileStatement

  • isWhileStatement(node: object | null | undefined, opts?: object | null): node is WhileStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is WhileStatement

isWithStatement

  • isWithStatement(node: object | null | undefined, opts?: object | null): node is WithStatement

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is WithStatement

isYieldExpression

  • isYieldExpression(node: object | null | undefined, opts?: object | null): node is YieldExpression

  • Parameters

    • node: object | null | undefined
    • Optional opts: object | null

    Returns node is YieldExpression

jsxAttribute

jsxClosingElement

jsxClosingFragment

jsxElement

jsxEmptyExpression

jsxExpressionContainer

jsxFragment

jsxIdentifier

  • Parameters

    • name: string

    Returns JSXIdentifier

jsxMemberExpression

jsxNamespacedName

jsxOpeningElement

jsxOpeningFragment

jsxSpreadAttribute

jsxSpreadChild

jsxText

  • Parameters

    • value: string

    Returns JSXText

labeledStatement

lchown

  • lchown(path: string | Buffer, uid: number, gid: number, callback: (err: ErrnoException) => void): void
  • lchown(path: string | Buffer, uid: number, gid: number): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • uid: number
    • gid: number

    Returns Promise<void>

link

  • Parameters

    Returns void

  • Parameters

    Returns Promise<void>

listReleases

  • listReleases(user: string, repo: string, filterRelease?: pass, filterAsset?: pass): Promise<string[]>

  • Gives a list of the releases made for a repository, optionally filtered by release and/or based on inclusion of a particular asset.

    Parameters

    • user: string

      the name of the user or organization that owns the repo

    • repo: string

      the name of the repository that you want to list releases of

    • Default value filterRelease: pass = pass

      the release filter function

    • Default value filterAsset: pass = pass

      the asset filter function

    Returns Promise<string[]>

loadOptions

  • Resolve Babel's options fully, resulting in an options object where:

    • opts.plugins is a full list of Plugin instances.
    • opts.presets is empty and all presets are flattened into opts.
    • It can be safely passed back to Babel. Fields like babelrc have been set to false so that later calls to Babel will not make a second attempt to load config files.

    Plugin instances aren't meant to be manipulated directly, but often callers will serialize this opts to JSON to use it as a cache key representing the options Babel has received. Caching on this isn't 100% guaranteed to invalidate properly, but it is the best we have at the moment.

    Parameters

    Returns object | null

loadPartialConfig

  • To allow systems to easily manipulate and validate a user's config, this function resolves the plugins and presets and proceeds no further. The expectation is that callers will take the config's .options, manipulate it as then see fit and pass it back to Babel again.

    • babelrc: string | void - The path of the .babelrc file, if there was one.
    • babelignore: string | void - The path of the .babelignore file, if there was one.
    • options: ValidatedOptions - The partially resolved options, which can be manipulated and passed back to Babel again.
      • plugins: Array<ConfigItem> - See below.
      • presets: Array<ConfigItem> - See below.
      • It can be safely passed back to Babel. Fields like babelrc have been set to false so that later calls to Babel will not make a second attempt to load config files.

    ConfigItem instances expose properties to introspect the values, but each item should be treated as immutable. If changes are desired, the item should be removed from the list and replaced with either a normal Babel config value, or with a replacement item created by babel.createConfigItem. See that function for information about ConfigItem fields.

    Parameters

    Returns Readonly<PartialConfig> | null

logicalExpression

lstat

matchesPattern

  • matchesPattern(node: Node | null | undefined, match: string | ReadonlyArray<string>, allowPartial?: undefined | false | true): node is MemberExpression

  • Parameters

    • node: Node | null | undefined
    • match: string | ReadonlyArray<string>
    • Optional allowPartial: undefined | false | true

    Returns node is MemberExpression

memberExpression

metaProperty

mixedTypeAnnotation

mkdir

  • Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.

    Parameters

    Returns void

  • Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.

    Parameters

    • path: string | Buffer
    • mode: number | string
    • callback: (err: ErrnoException) => void

      No arguments other than a possible exception are given to the completion callback.

    Returns void

  • Parameters

    Returns Promise<void>

mkdirp

  • mkdirp(dir: string): Promise<void>
  • mkdirp(dir: string, callback: (err: Error) => void): void

  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

mkdirpSync

  • mkdirpSync(dir: string): void

  • Parameters

    • dir: string

    Returns void

mkdirs

  • mkdirs(dir: string): Promise<void>
  • mkdirs(dir: string, callback: (err: Error) => void): void

  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

mkdirsSync

  • mkdirsSync(dir: string): void

  • Parameters

    • dir: string

    Returns void

mkdtemp

  • mkdtemp(prefix: string): Promise<string>
  • mkdtemp(prefix: string, callback: (err: ErrnoException, folder: string) => void): void

  • Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.

    Parameters

    • prefix: string

    Returns Promise<string>

  • Parameters

    Returns void

move

  • move(src: string, dest: string, options?: MoveOptions): Promise<void>
  • move(src: string, dest: string, callback: (err: Error) => void): void
  • move(src: string, dest: string, options: MoveOptions, callback: (err: Error) => void): void

  • Parameters

    • src: string
    • dest: string
    • Optional options: MoveOptions

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • options: MoveOptions
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

moveSync

  • moveSync(src: string, dest: string, options?: MoveOptions): void

  • Parameters

    • src: string
    • dest: string
    • Optional options: MoveOptions

    Returns void

newExpression

noop

  • Returns Noop

nullLiteral

  • Returns NullLiteral

nullLiteralTypeAnnotation

nullableTypeAnnotation

numberLiteralTypeAnnotation

numberTypeAnnotation

numericLiteral

  • Parameters

    • value: number

    Returns NumericLiteral

objectExpression

objectMethod

objectPattern

objectProperty

objectTypeAnnotation

objectTypeCallProperty

objectTypeIndexer

objectTypeInternalSlot

objectTypeProperty

objectTypeSpreadProperty

opaqueType

open

  • open(path: string, options: Options, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void
  • open(path: string, callback?: undefined | ((err?: Error, zipfile?: ZipFile) => void)): void
  • open(path: string | Buffer, flags: string | number, callback: (err: ErrnoException, fd: number) => void): void
  • open(path: string | Buffer, flags: string | number, mode: number, callback: (err: ErrnoException, fd: number) => void): void
  • open(path: string | Buffer, flags: string | number, mode?: undefined | number): Promise<number>

  • Parameters

    • path: string
    • options: Options
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

  • Parameters

    • path: string
    • Optional callback: undefined | ((err?: Error, zipfile?: ZipFile) => void)

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • flags: string | number
    • Optional mode: undefined | number

    Returns Promise<number>

opendir

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string
    • Optional options: fs.OpenDirOptions

    Returns Promise<Dir>

optionalCallExpression

optionalMemberExpression

outputFile

  • outputFile(file: string, data: any, options?: WriteFileOptions | string): Promise<void>
  • outputFile(file: string, data: any, callback: (err: Error) => void): void
  • outputFile(file: string, data: any, options: WriteFileOptions | string, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • data: any
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    Returns void

outputFileSync

  • outputFileSync(file: string, data: any, options?: WriteFileOptions | string): void

  • Parameters

    Returns void

outputJSON

  • outputJSON(file: string, data: any, options?: WriteOptions): Promise<void>
  • outputJSON(file: string, data: any, options: WriteOptions, callback: (err: Error) => void): void
  • outputJSON(file: string, data: any, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    • file: string
    • data: any
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

outputJSONSync

  • outputJSONSync(file: string, data: any, options?: WriteOptions): void

  • Parameters

    Returns void

outputJson

  • outputJson(file: string, data: any, options?: WriteOptions): Promise<void>
  • outputJson(file: string, data: any, options: WriteOptions, callback: (err: Error) => void): void
  • outputJson(file: string, data: any, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    • file: string
    • data: any
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

outputJsonSync

  • outputJsonSync(file: string, data: any, options?: WriteOptions): void

  • Parameters

    Returns void

parenthesizedExpression

parse

  • Parse the provided code as an entire ECMAScript program.

    Parameters

    Returns File

  • Given some code, parse it using Babel's standard behavior. Referenced presets and plugins will be loaded such that optional syntax plugins are automatically enabled.

    Parameters

    Returns void

  • Given some code, parse it using Babel's standard behavior. Referenced presets and plugins will be loaded such that optional syntax plugins are automatically enabled.

    Parameters

    Returns void

  • Given some code, parse it using Babel's standard behavior. Referenced presets and plugins will be loaded such that optional syntax plugins are automatically enabled.

    Parameters

    Returns ParseResult | null

parseAsync

  • Given some code, parse it using Babel's standard behavior. Referenced presets and plugins will be loaded such that optional syntax plugins are automatically enabled.

    Parameters

    Returns Promise<ParseResult | null>

parseExpression

  • Parse the provided code as a single expression.

    Parameters

    Returns Expression

parseFloat

  • parseFloat(string: string): number

  • Converts a string to a floating-point number.

    Parameters

    • string: string

      A string that contains a floating-point number.

    Returns number

parseInt

  • parseInt(s: string, radix?: undefined | number): number

  • Converts a string to an integer.

    Parameters

    • s: string

      A string to convert into a number.

    • Optional radix: undefined | number

      A value between 2 and 36 that specifies the base of the number in numString. If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal. All other strings are considered decimal.

    Returns number

parseSync

  • Given some code, parse it using Babel's standard behavior. Referenced presets and plugins will be loaded such that optional syntax plugins are automatically enabled.

    Parameters

    Returns ParseResult | null

pass

  • pass(): boolean

pathExists

  • pathExists(path: string): Promise<boolean>
  • pathExists(path: string, callback: (err: Error, exists: boolean) => void): void

  • Parameters

    • path: string

    Returns Promise<boolean>

  • Parameters

    • path: string
    • callback: (err: Error, exists: boolean) => void
        • (err: Error, exists: boolean): void

        • Parameters

          • err: Error
          • exists: boolean

          Returns void

    Returns void

pathExistsSync

  • pathExistsSync(path: string): boolean

  • Parameters

    • path: string

    Returns boolean

pending

  • pending(reason?: undefined | string): void

  • If you call the function pending anywhere in the spec body, no matter the expectations, the spec will be marked pending.

    Parameters

    • Optional reason: undefined | string

    Returns void

pipelineBareFunction

pipelinePrimaryTopicReference

pipelineTopicExpression

placeholder

  • placeholder(expectedNode: "Identifier" | "StringLiteral" | "Expression" | "Statement" | "Declaration" | "BlockStatement" | "ClassBody" | "Pattern", name: Identifier): Placeholder

  • Parameters

    • expectedNode: "Identifier" | "StringLiteral" | "Expression" | "Statement" | "Declaration" | "BlockStatement" | "ClassBody" | "Pattern"
    • name: Identifier

    Returns Placeholder

prependToMemberExpression

  • prependToMemberExpression<T>(member: T, prepend: MemberExpression["object"]): T

  • Type parameters

    Parameters

    • member: T
    • prepend: MemberExpression["object"]

    Returns T

privateName

Const program

qualifiedTypeIdentifier

queueMicrotask

  • queueMicrotask(callback: () => void): void

  • Parameters

    • callback: () => void
        • (): void

        • Returns void

    Returns void

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback: (err: ErrnoException, bytesRead: number, buffer: Buffer) => void): void
  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): Promise<ReadResult>

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number | null

    Returns Promise<ReadResult>

readFile

  • readFile(file: string | Buffer | number, callback: (err: ErrnoException, data: Buffer) => void): void
  • readFile(file: string | Buffer | number, encoding: string, callback: (err: ErrnoException, data: string) => void): void
  • readFile(file: string | Buffer | number, options: { flag?: undefined | string } | { encoding: string; flag?: undefined | string }, callback: (err: ErrnoException, data: Buffer) => void): void
  • readFile(file: string | Buffer | number, options: { flag?: undefined | string } | { encoding: string; flag?: undefined | string }): Promise<string>
  • readFile(file: string | Buffer | number, encoding: string): Promise<string>
  • readFile(file: string | Buffer | number): Promise<Buffer>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • file: string | Buffer | number
    • options: { flag?: undefined | string } | { encoding: string; flag?: undefined | string }

    Returns Promise<string>

  • Parameters

    • file: string | Buffer | number
    • encoding: string

    Returns Promise<string>

  • Parameters

    • file: string | Buffer | number

    Returns Promise<Buffer>

readJSON

  • readJSON(file: string, options?: ReadOptions): Promise<any>
  • readJSON(file: string, callback: (err: Error, jsonObject: any) => void): void
  • readJSON(file: string, options: ReadOptions, callback: (err: Error, jsonObject: any) => void): void

  • Parameters

    Returns Promise<any>

  • Parameters

    • file: string
    • callback: (err: Error, jsonObject: any) => void
        • (err: Error, jsonObject: any): void

        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

  • Parameters

    • file: string
    • options: ReadOptions
    • callback: (err: Error, jsonObject: any) => void
        • (err: Error, jsonObject: any): void

        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

readJSONSync

  • readJSONSync(file: string, options?: ReadOptions): any

  • Parameters

    Returns any

readJson

  • readJson(file: string, options?: ReadOptions): Promise<any>
  • readJson(file: string, callback: (err: Error, jsonObject: any) => void): void
  • readJson(file: string, options: ReadOptions, callback: (err: Error, jsonObject: any) => void): void

  • Parameters

    Returns Promise<any>

  • Parameters

    • file: string
    • callback: (err: Error, jsonObject: any) => void
        • (err: Error, jsonObject: any): void

        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

  • Parameters

    • file: string
    • options: ReadOptions
    • callback: (err: Error, jsonObject: any) => void
        • (err: Error, jsonObject: any): void

        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

readJsonSync

  • readJsonSync(file: string, options?: ReadOptions): any

  • Parameters

    Returns any

readdir

  • Parameters

    Returns void

  • Parameters

    Returns Promise<string[]>

readlink

  • Parameters

    Returns void

  • Parameters

    Returns Promise<string>

realpath

  • realpath(path: string | Buffer, callback: (err: ErrnoException, resolvedPath: string) => any): void
  • realpath(path: string | Buffer, cache: {}, callback: (err: ErrnoException, resolvedPath: string) => any): void
  • realpath(path: string | Buffer, cache?: undefined | {}): Promise<string>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional cache: undefined | {}

    Returns Promise<string>

recordExpression

regExpLiteral

  • regExpLiteral(pattern: string, flags?: undefined | string): RegExpLiteral

  • Parameters

    • pattern: string
    • Optional flags: undefined | string

    Returns RegExpLiteral

remove

  • remove(dir: string): Promise<void>
  • remove(dir: string, callback: (err: Error) => void): void

  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

removeComments

  • removeComments<T>(node: T): T

  • Type parameters

    Parameters

    • node: T

    Returns T

removeProperties

  • removeProperties(n: Node, opts?: { preserveComments: boolean } | null): void

  • Parameters

    • n: Node
    • Optional opts: { preserveComments: boolean } | null

    Returns void

removePropertiesDeep

  • removePropertiesDeep<T>(n: T, opts?: { preserveComments: boolean } | null): T

  • Type parameters

    Parameters

    • n: T
    • Optional opts: { preserveComments: boolean } | null

    Returns T

removeSync

  • removeSync(dir: string): void

  • Parameters

    • dir: string

    Returns void

removeTypeDuplicates

  • Parameters

    Returns FlowType[]

rename

  • rename(oldPath: string, newPath: string, callback: (err: ErrnoException) => void): void
  • rename(oldPath: string, newPath: string): Promise<void>

  • Parameters

    Returns void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

resolvePlugin

  • resolvePlugin(name: string, dirname: string): string | null

  • Parameters

    • name: string
    • dirname: string

    Returns string | null

resolvePreset

  • resolvePreset(name: string, dirname: string): string | null

  • Parameters

    • name: string
    • dirname: string

    Returns string | null

restElement

  • Parameters

    Returns RestElement

returnStatement

  • Parameters

    Returns ReturnStatement

rmdir

  • Asynchronous rmdir - removes the directory specified in {path}

    Parameters

    Returns void

  • Parameters

    Returns Promise<void>

sequenceExpression

setInterval

  • setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): Timeout

  • Parameters

    • callback: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timeout

shallowEqual

  • shallowEqual<T>(actual: object, expected: T): actual is T

  • Type parameters

    • T: object

    Parameters

    • actual: object
    • expected: T

    Returns actual is T

spreadElement

spyOn

  • spyOn<T>(object: T, method: keyof T): Spy

  • Type parameters

    • T

    Parameters

    • object: T
    • method: keyof T

    Returns Spy

stat

stringLiteral

  • Parameters

    • value: string

    Returns StringLiteral

stringLiteralTypeAnnotation

stringTypeAnnotation

switchCase

switchStatement

symbolTypeAnnotation

symlink

taggedTemplateExpression

templateElement

  • templateElement(value: { cooked?: undefined | string; raw: string }, tail?: undefined | false | true): TemplateElement

  • Parameters

    • value: { cooked?: undefined | string; raw: string }
      • Optional cooked?: undefined | string
      • raw: string
    • Optional tail: undefined | false | true

    Returns TemplateElement

templateLiteral

thisExpression

  • Returns ThisExpression

thisTypeAnnotation

throwStatement

toBindingIdentifierName

  • toBindingIdentifierName(name: { toString: any } | null | undefined): string

  • Parameters

    • name: { toString: any } | null | undefined

    Returns string

toBlock

toComputedKey

toExpression

toIdentifier

  • toIdentifier(name: { toString: any } | null | undefined): string

  • Parameters

    • name: { toString: any } | null | undefined

    Returns string

toKeyAlias

  • Parameters

    Returns string

toSequenceExpression

  • Parameters

    • nodes: ReadonlyArray<Node>
    • scope: { buildUndefinedNode: any; push: any }
      • buildUndefinedNode: function
        • buildUndefinedNode(): Node

        • Returns Node

      • push: function

        • Parameters

          Returns void

    Returns SequenceExpression | undefined

toStatement

transform

  • Transforms the passed in code. Calling a callback with an object with the generated code, source map, and AST.

    Parameters

    Returns void

  • Transforms the passed in code. Calling a callback with an object with the generated code, source map, and AST.

    Parameters

    Returns void

  • Here for backward-compatibility. Ideally use transformSync if you want a synchronous API.

    Parameters

    Returns BabelFileResult | null

transformAsync

  • Transforms the passed in code. Calling a callback with an object with the generated code, source map, and AST.

    Parameters

    Returns Promise<BabelFileResult | null>

transformFile

  • Asynchronously transforms the entire contents of a file.

    Parameters

    Returns void

  • Asynchronously transforms the entire contents of a file.

    Parameters

    Returns void

transformFileAsync

  • Asynchronously transforms the entire contents of a file.

    Parameters

    Returns Promise<BabelFileResult | null>

transformFileSync

  • Synchronous version of babel.transformFile. Returns the transformed contents of the filename.

    Parameters

    Returns BabelFileResult | null

transformFromAst

  • Given an AST, transform it.

    Parameters

    Returns void

  • Given an AST, transform it.

    Parameters

    Returns void

transformFromAstAsync

  • Given an AST, transform it.

    Parameters

    Returns Promise<BabelFileResult | null>

transformFromAstSync

  • Here for backward-compatibility. Ideally use ".transformSync" if you want a synchronous API.

    Parameters

    Returns BabelFileResult | null

transformSync

  • Transforms the passed in code. Returning an object with the generated code, source map, and AST.

    Parameters

    Returns BabelFileResult | null

Const traverse

traverseFast

  • Type parameters

    • T

    Parameters

    Returns void

truncate

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional len: undefined | number

    Returns Promise<void>

tryStatement

tsAnyKeyword

  • Returns TSAnyKeyword

tsArrayType

  • Parameters

    Returns TSArrayType

tsAsExpression

tsBigIntKeyword

  • Returns TSBigIntKeyword

tsBooleanKeyword

  • Returns TSBooleanKeyword

tsCallSignatureDeclaration

tsConditionalType

tsConstructSignatureDeclaration

tsConstructorType

tsDeclareFunction

tsDeclareMethod

tsEnumDeclaration

tsEnumMember

tsExportAssignment

tsExpressionWithTypeArguments

tsExternalModuleReference

tsFunctionType

tsImportEqualsDeclaration

tsImportType

tsIndexSignature

tsIndexedAccessType

tsInferType

tsInterfaceBody

tsInterfaceDeclaration

tsIntersectionType

tsLiteralType

tsMappedType

tsMethodSignature

tsModuleBlock

tsModuleDeclaration

tsNamedTupleMember

  • Parameters

    • label: Identifier
    • elementType: TSType
    • Optional optional: undefined | false | true

    Returns TSNamedTupleMember

tsNamespaceExportDeclaration

tsNeverKeyword

  • Returns TSNeverKeyword

tsNonNullExpression

tsNullKeyword

  • Returns TSNullKeyword

tsNumberKeyword

  • Returns TSNumberKeyword

tsObjectKeyword

  • Returns TSObjectKeyword

tsOptionalType

  • Parameters

    Returns TSOptionalType

tsParameterProperty

tsParenthesizedType

tsPropertySignature

tsQualifiedName

tsRestType

  • Parameters

    Returns TSRestType

tsStringKeyword

  • Returns TSStringKeyword

tsSymbolKeyword

  • Returns TSSymbolKeyword

tsThisType

  • Returns TSThisType

tsTupleType

tsTypeAliasDeclaration

tsTypeAnnotation

  • Parameters

    Returns TSTypeAnnotation

tsTypeAssertion

tsTypeLiteral

tsTypeOperator

  • Parameters

    Returns TSTypeOperator

tsTypeParameter

  • Parameters

    • constraint: TSType | null | undefined
    • _default: TSType | null | undefined
    • name: string

    Returns TSTypeParameter

tsTypeParameterDeclaration

tsTypeParameterInstantiation

tsTypePredicate

tsTypeQuery

tsTypeReference

tsUndefinedKeyword

tsUnionType

  • Parameters

    Returns TSUnionType

tsUnknownKeyword

  • Returns TSUnknownKeyword

tsVoidKeyword

  • Returns TSVoidKeyword

tupleExpression

tupleTypeAnnotation

typeAlias

typeAnnotation

  • Parameters

    Returns TypeAnnotation

typeCastExpression

typeParameter

typeParameterDeclaration

typeParameterInstantiation

typeofTypeAnnotation

unaryExpression

  • unaryExpression(operator: "void" | "throw" | "delete" | "!" | "+" | "-" | "~" | "typeof", argument: Expression, prefix?: undefined | false | true): UnaryExpression

  • Parameters

    • operator: "void" | "throw" | "delete" | "!" | "+" | "-" | "~" | "typeof"
    • argument: Expression
    • Optional prefix: undefined | false | true

    Returns UnaryExpression

unescape

  • unescape(string: string): string

  • Computes a new string in which hexadecimal escape sequences are replaced with the character that it represents.

    Parameters

    • string: string

      A string value

    Returns string

unionTypeAnnotation

unlink

  • Asynchronous unlink - deletes the file specified in {path}

    Parameters

    Returns void

  • Parameters

    Returns Promise<void>

updateExpression

  • Parameters

    • operator: "++" | "--"
    • argument: Expression
    • Optional prefix: undefined | false | true

    Returns UpdateExpression

utimes

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • atime: number
    • mtime: number

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

v8IntrinsicIdentifier

  • Parameters

    • name: string

    Returns V8IntrinsicIdentifier

validate

  • validate<T, K>(n: Node | null | undefined, key: K, value: T[K]): void
  • validate(n: Node, key: string, value: any): void

  • Type parameters

    • T: Node

    • K: keyof T

    Parameters

    • n: Node | null | undefined
    • key: K
    • value: T[K]

    Returns void

  • Parameters

    • n: Node
    • key: string
    • value: any

    Returns void

validateFileName

  • validateFileName(fileName: string): string | null

  • Parameters

    • fileName: string

    Returns string | null

valueToNode

  • Parameters

    • value: undefined

    Returns Identifier

  • Parameters

    • value: boolean

    Returns BooleanLiteral

  • Parameters

    • value: null

    Returns NullLiteral

  • Parameters

    • value: string

    Returns StringLiteral

  • Parameters

    • value: number

    Returns NumericLiteral | BinaryExpression | UnaryExpression

  • Parameters

    Returns RegExpLiteral

  • Parameters

    Returns ArrayExpression

  • Parameters

    • value: object

    Returns ObjectExpression

  • Parameters

    • value: undefined | boolean | null | string | number | RegExp | object

    Returns Expression

variableDeclaration

variableDeclarator

variance

  • variance(kind: "minus" | "plus"): Variance

  • Parameters

    • kind: "minus" | "plus"

    Returns Variance

voidTypeAnnotation

whileStatement

withStatement

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback: (err: ErrnoException, written: number, buffer: Buffer) => void): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, callback: (err: ErrnoException, written: number, buffer: Buffer) => void): void
  • write(fd: number, data: any, callback: (err: ErrnoException, written: number, str: string) => void): void
  • write(fd: number, data: any, offset: number, callback: (err: ErrnoException, written: number, str: string) => void): void
  • write(fd: number, data: any, offset: number, encoding: string, callback: (err: ErrnoException, written: number, str: string) => void): void
  • write(fd: number, buffer: Buffer, offset?: undefined | number, length?: undefined | number, position?: number | null): Promise<WriteResult>
  • write(fd: number, data: any, offset?: undefined | number, encoding?: undefined | string): Promise<WriteResult>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • data: any
    • callback: (err: ErrnoException, written: number, str: string) => void

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • callback: (err: ErrnoException, written: number, str: string) => void

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • encoding: string
    • callback: (err: ErrnoException, written: number, str: string) => void

    Returns void

  • Parameters

    • fd: number
    • buffer: Buffer
    • Optional offset: undefined | number
    • Optional length: undefined | number
    • Optional position: number | null

    Returns Promise<WriteResult>

  • Parameters

    • fd: number
    • data: any
    • Optional offset: undefined | number
    • Optional encoding: undefined | string

    Returns Promise<WriteResult>

writeFile

writeJSON

  • writeJSON(file: string, object: any, options?: WriteOptions): Promise<void>
  • writeJSON(file: string, object: any, callback: (err: Error) => void): void
  • writeJSON(file: string, object: any, options: WriteOptions, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • object: any
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    Returns void

writeJSONSync

  • writeJSONSync(file: string, object: any, options?: WriteOptions): void

  • Parameters

    Returns void

writeJson

  • writeJson(file: string, object: any, options?: WriteOptions): Promise<void>
  • writeJson(file: string, object: any, callback: (err: Error) => void): void
  • writeJson(file: string, object: any, options: WriteOptions, callback: (err: Error) => void): void

  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • object: any
    • callback: (err: Error) => void

        • Parameters

          Returns void

    Returns void

  • Parameters

    Returns void

writeJsonSync

  • writeJsonSync(file: string, object: any, options?: WriteOptions): void

  • Parameters

    Returns void

writev

yieldExpression

  • Parameters

    • Optional argument: Expression | null
    • Optional delegate: undefined | false | true

    Returns YieldExpression