Skip to content

BlockSuite API Documentation / @blocksuite/store / ASTWalkerContext

Class: ASTWalkerContext<TNode>

Defined in: packages/framework/store/src/adapter/context.ts:3

Type Parameters

TNode

TNode extends object

Constructors

new ASTWalkerContext()

new ASTWalkerContext<TNode>(): ASTWalkerContext<TNode>

Returns

ASTWalkerContext<TNode>

Properties

_skip

_skip: boolean = false

Defined in: packages/framework/store/src/adapter/context.ts:14


_skipChildrenNum

_skipChildrenNum: number = 0

Defined in: packages/framework/store/src/adapter/context.ts:16

Accessors

stack

Get Signature

get stack(): object[]

Defined in: packages/framework/store/src/adapter/context.ts:22

Returns

object[]

Methods

cleanGlobalContextStack()

cleanGlobalContextStack(key): void

Defined in: packages/framework/store/src/adapter/context.ts:30

Parameters

key

string

Returns

void


closeNode()

closeNode(): ASTWalkerContext<TNode>

Defined in: packages/framework/store/src/adapter/context.ts:36

Returns

ASTWalkerContext<TNode>


currentNode()

currentNode(): TNode

Defined in: packages/framework/store/src/adapter/context.ts:51

Returns

TNode


getGlobalContext()

getGlobalContext(key): unknown

Defined in: packages/framework/store/src/adapter/context.ts:55

Parameters

key

string

Returns

unknown


getGlobalContextStack()

getGlobalContextStack<StackElement>(key): StackElement[]

Defined in: packages/framework/store/src/adapter/context.ts:59

Type Parameters

StackElement

StackElement

Parameters

key

string

Returns

StackElement[]


getNodeContext()

getNodeContext(key): unknown

Defined in: packages/framework/store/src/adapter/context.ts:68

Parameters

key

string

Returns

unknown


getPreviousNodeContext()

getPreviousNodeContext(key): unknown

Defined in: packages/framework/store/src/adapter/context.ts:72

Parameters

key

string

Returns

unknown


openNode()

openNode(node, parentProp?): ASTWalkerContext<TNode>

Defined in: packages/framework/store/src/adapter/context.ts:76

Parameters

node

TNode

parentProp?

Keyof<TNode>

Returns

ASTWalkerContext<TNode>


previousNode()

previousNode(): TNode

Defined in: packages/framework/store/src/adapter/context.ts:85

Returns

TNode


pushGlobalContextStack()

pushGlobalContextStack<StackElement>(key, value): void

Defined in: packages/framework/store/src/adapter/context.ts:89

Type Parameters

StackElement

StackElement

Parameters

key

string

value

StackElement

Returns

void


setDefaultProp()

setDefaultProp(parentProp): void

Defined in: packages/framework/store/src/adapter/context.ts:18

Parameters

parentProp

Keyof<TNode>

Returns

void


setGlobalContext()

setGlobalContext(key, value): ASTWalkerContext<TNode>

Defined in: packages/framework/store/src/adapter/context.ts:98

Parameters

key

string

value

unknown

Returns

ASTWalkerContext<TNode>


setGlobalContextStack()

setGlobalContextStack<StackElement>(key, value): void

Defined in: packages/framework/store/src/adapter/context.ts:103

Type Parameters

StackElement

StackElement

Parameters

key

string

value

StackElement[]

Returns

void


setNodeContext()

setNodeContext(key, value): ASTWalkerContext<TNode>

Defined in: packages/framework/store/src/adapter/context.ts:107

Parameters

key

string

value

unknown

Returns

ASTWalkerContext<TNode>


skipAllChildren()

skipAllChildren(): void

Defined in: packages/framework/store/src/adapter/context.ts:112

Returns

void


skipChildren()

skipChildren(num): void

Defined in: packages/framework/store/src/adapter/context.ts:116

Parameters

num

number = 1

Returns

void