Skip to main content

Class: DocStack

Defined in: packages/client/src/index.ts:35

Extends​

  • EventTarget

Constructors​

Constructor​

new DocStack(...config): DocStack

Defined in: packages/client/src/index.ts:199

Parameters​

config​

...StackConfig[]

Returns​

DocStack

Overrides​

EventTarget.constructor

Methods​

addEventListener()​

addEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11569

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters​

type​

string

callback​

null | EventListenerOrEventListenerObject

options?​

boolean | AddEventListenerOptions

Returns​

void

Inherited from​

EventTarget.addEventListener

clearConnection()​

clearConnection(conn): Promise<void>

Defined in: packages/client/src/index.ts:121

Parameters​

conn​

string

Returns​

Promise<void>

createAttribute()​

createAttribute(className, params): Promise<void>

Defined in: packages/client/src/index.ts:172

Parameters​

className​

string

params​
config?​

{ }

description?​

string

name​

string

type​

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

Returns​

Promise<void>

createClass()​

createClass(name, config): Promise<void>

Defined in: packages/client/src/index.ts:147

Parameters​

name​

string

config​
description​

string

type​

string

Returns​

Promise<void>

dispatchEvent()​

dispatchEvent(event): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11575

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters​

event​

Event

Returns​

boolean

Inherited from​

EventTarget.dispatchEvent

export()​

export(stackName): Promise<AllDocsResponse<{ }>>

Defined in: packages/client/src/index.ts:137

Parameters​

stackName​

string

Returns​

Promise<AllDocsResponse<{ }>>

getReadyState()​

getReadyState(): boolean

Defined in: packages/client/src/index.ts:109

Returns​

boolean

getStack()​

getStack(name): undefined | ClientStack

Defined in: packages/client/src/index.ts:105

Parameters​

name​

string

Returns​

undefined | ClientStack

getStacks()​

getStacks(): ClientStack[]

Defined in: packages/client/src/index.ts:101

Returns​

ClientStack[]

removeEventListener()​

removeEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11581

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Parameters​

type​

string

callback​

null | EventListenerOrEventListenerObject

options?​

boolean | EventListenerOptions

Returns​

void

Inherited from​

EventTarget.removeEventListener

reset()​

reset(): Promise<void>

Defined in: packages/client/src/index.ts:112

Returns​

Promise<void>

resetAll()​

resetAll(): Promise<void>

Defined in: packages/client/src/index.ts:91

Returns​

Promise<void>