Class Scope

constructor

• new Scope(path, parentScope?): Scope

• This searches the current "scope" and collects all references/bindings within.

  Parameters

  • path: NodePath<Node>
  • Optional parentScope: Scope

  Returns Scope

bindings

block

crawling

data

globals

hub

labels

parent

parentBlock

path

references

uid

uids

Static contextVariables

Static globals

addGlobal

• addGlobal(node): void

• Parameters

  • node: Identifier | JSXIdentifier

  Returns void

bindingIdentifierEquals

• bindingIdentifierEquals(name, node): boolean

• Parameters

  • name: string
  • node: Node

  Returns boolean

buildUndefinedNode

• buildUndefinedNode(): UnaryExpression

• Returns UnaryExpression

checkBlockScopedCollisions

• checkBlockScopedCollisions(local, kind, name, id): void

• Parameters

  • local: Binding
  • kind: BindingKind
  • name: string
  • id: object

  Returns void

crawl

• crawl(): void

• Returns void

dump

• dump(): void

• Returns void

generateDeclaredUidIdentifier

• generateDeclaredUidIdentifier(name?): Identifier

• Generate a unique identifier and add it to the current scope.

  Parameters

  • Optional name: string

  Returns Identifier

generateUid

• generateUid(name?): string

• Generate a unique _id1 binding.

  Parameters

  • Optional name: string

  Returns string

generateUidIdentifier

• generateUidIdentifier(name?): Identifier

• Generate a unique identifier.

  Parameters

  • Optional name: string

  Returns Identifier

generateUidIdentifierBasedOnNode

• generateUidIdentifierBasedOnNode(parent, defaultName?): Identifier

• Generate a unique identifier based on a node.

  Parameters

  • parent: Node
  • Optional defaultName: string

  Returns Identifier

getAllBindings

• getAllBindings(): Record<string, Binding>

• Walks the scope tree and gathers all bindings.

  Returns Record<string, Binding>

getAllBindingsOfKind

• getAllBindingsOfKind(...kinds): Record<string, Binding>

• Walks the scope tree and gathers all declarations of kind.

  Parameters

  • Rest ...kinds: string[]

  Returns Record<string, Binding>

getBinding

• getBinding(name): undefined | Binding

• Parameters

  • name: string

  Returns undefined | Binding

getBindingIdentifier

• getBindingIdentifier(name): Identifier

• Parameters

  • name: string

  Returns Identifier

getBlockParent

• getBlockParent(): Scope

• Walk up the scope tree until we hit either a BlockStatement/Loop/Program/Function/Switch or reach the very top and hit Program.

  Returns Scope

getData

• getData(key): any

• Recursively walk up scope tree looking for the data key.

  Parameters

  • key: string

  Returns any

getFunctionParent

• getFunctionParent(): null | Scope

• Walk up the scope tree until we hit either a Function or return null.

  Returns null | Scope

getLabel

• getLabel(name): undefined | NodePath<LabeledStatement>

• Parameters

  • name: string

  Returns undefined | NodePath<LabeledStatement>

getOwnBinding

• getOwnBinding(name): undefined | Binding

• Parameters

  • name: string

  Returns undefined | Binding

getOwnBindingIdentifier

• getOwnBindingIdentifier(name): Identifier

• Parameters

  • name: string

  Returns Identifier

getPatternParent

• getPatternParent(): Scope

• Walk up from a pattern scope (function param initializer) until we hit a non-pattern scope, then returns its block parent

  Returns Scope

  An ancestry scope whose path is a block parent

getProgramParent

• getProgramParent(): Scope

• Walk up to the top of the scope tree and get the Program.

  Returns Scope

hasBinding

• hasBinding(name, optsOrNoGlobals?): boolean

• Parameters

  • name: string
  • Optional optsOrNoGlobals: boolean | {
        noGlobals?: boolean;
        noUids?: boolean;
    }

  Returns boolean

hasGlobal

• hasGlobal(name): boolean

• Parameters

  • name: string

  Returns boolean

hasLabel

• hasLabel(name): boolean

• Parameters

  • name: string

  Returns boolean

hasOwnBinding

• hasOwnBinding(name): boolean

• Parameters

  • name: string

  Returns boolean

hasReference

• hasReference(name): boolean

• Parameters

  • name: string

  Returns boolean

hasUid

• hasUid(name): boolean

• Parameters

  • name: string

  Returns boolean

isPure

• isPure(node, constantsOnly?): boolean

• Parameters

  • node: Node
  • Optional constantsOnly: boolean

  Returns boolean

isStatic

• isStatic(node): boolean

• Determine whether evaluating the specific input node is a consequenceless reference. ie. evaluating it wont result in potentially arbitrary code from being ran. The following are whitelisted and determined not to cause side effects:

  • this expressions
  • super expressions
  • Bound identifiers

  Parameters

  • node: Node

  Returns boolean

maybeGenerateMemoised

• maybeGenerateMemoised(node, dontPush?): Identifier

• Possibly generate a memoised identifier if it is not static and has consequences.

  Parameters

  • node: Node
  • Optional dontPush: boolean

  Returns Identifier

moveBindingTo

• moveBindingTo(name, scope): void

• Move a binding of name to another scope.

  Parameters

  • name: string
  • scope: Scope

  Returns void

parentHasBinding

• parentHasBinding(name, opts?): boolean

• Parameters

  • name: string
  • Optional opts: {
        noGlobals?: boolean;
        noUids?: boolean;
    }

    • Optional noGlobals?: boolean

    • Optional noUids?: boolean

  Returns boolean

push

• push(opts): void

• Parameters

  • opts: {
        _blockHoist?: number;
        id: LVal;
        init?: Expression;
        kind?: "var" | "let" | "const";
        unique?: boolean;
    }

    • Optional _blockHoist?: number

    • id: LVal

    • Optional init?: Expression

    • Optional kind?: "var" | "let" | "const"

    • Optional unique?: boolean

  Returns void

registerBinding

• registerBinding(kind, path, bindingPath?): void

• Parameters

  • kind: BindingKind
  • path: NodePath<Node>
  • Optional bindingPath: NodePath<Node>

  Returns void

registerConstantViolation

• registerConstantViolation(path): void

• Parameters

  • path: NodePath<Node>

  Returns void

registerDeclaration

• registerDeclaration(path): void

• Parameters

  • path: NodePath<Node>

  Returns void

registerLabel

• registerLabel(path): void

• Parameters

  • path: NodePath<LabeledStatement>

  Returns void

removeBinding

• removeBinding(name): void

• Parameters

  • name: string

  Returns void

removeData

• removeData(key): void

• Recursively walk up scope tree looking for the data key and if it exists, remove it.

  Parameters

  • key: string

  Returns void

removeOwnBinding

• removeOwnBinding(name): void

• Parameters

  • name: string

  Returns void

rename

• rename(oldName, newName?, block?): void

• Parameters

  • oldName: string
  • Optional newName: string
  • Optional block: Node

  Returns void

setData

• setData(key, val): any

• Set some arbitrary data on the current scope.

  Parameters

  • key: string
  • val: any

  Returns any

toArray

• toArray(node, i?, arrayLikeIsIterable?): ArrayExpression | CallExpression | Identifier

• Parameters

  • node: Node
  • Optional i: number | boolean
  • Optional arrayLikeIsIterable: boolean

  Returns ArrayExpression | CallExpression | Identifier

traverse

• traverse<S>(node, opts, state): void

• Traverse node with current scope and path.

  Type Parameters

  • S

  Parameters

  • node: Node | Node[]
  • opts: TraverseOptions<S>
  • state: S

  Returns void
• traverse(node, opts?, state?): void

• Parameters

  • node: Node | Node[]
  • Optional opts: TraverseOptions<Node>
  • Optional state: any

  Returns void