Overview

Namespaces

• IDL

Classes

InputBox

Defined in: packages/core/src/candid/candid-core.ts:23

Constructors

Constructor

new InputBox(idl, ui): InputBox

Defined in: packages/core/src/candid/candid-core.ts:28

Parameters

idl

Type

ui

UIConfig

Returns

InputBox

Properties

idl

idl: Type

Defined in: packages/core/src/candid/candid-core.ts:29

label

label: string | null = null

Defined in: packages/core/src/candid/candid-core.ts:25

status

status: HTMLElement

Defined in: packages/core/src/candid/candid-core.ts:24

ui

ui: UIConfig

Defined in: packages/core/src/candid/candid-core.ts:30

value

value: any = undefined

Defined in: packages/core/src/candid/candid-core.ts:26

Methods

isRejected()

isRejected(): boolean

Defined in: packages/core/src/candid/candid-core.ts:49

Returns

boolean

parse()

parse(config?): any

Defined in: packages/core/src/candid/candid-core.ts:53

Parameters

config?

ParseConfig = {}

Returns

any

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:80

Parameters

dom

HTMLElement

Returns

void

---

abstract InputForm

Defined in: packages/core/src/candid/candid-core.ts:99

Extended by

• RecordForm
• TupleForm
• VariantForm
• OptionForm
• VecForm

Constructors

Constructor

new InputForm(ui): InputForm

Defined in: packages/core/src/candid/candid-core.ts:101

Parameters

ui

FormConfig

Returns

InputForm

Properties

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:101

Methods

generateForm()

abstract generateForm(): any

Defined in: packages/core/src/candid/candid-core.ts:104

Returns

any

parse()

abstract parse(config): any

Defined in: packages/core/src/candid/candid-core.ts:103

Parameters

config

ParseConfig

Returns

any

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

---

OptionForm

Defined in: packages/core/src/candid/candid-core.ts:223

Extends

• InputForm

Constructors

Constructor

new OptionForm(ty, ui): OptionForm

Defined in: packages/core/src/candid/candid-core.ts:224

Parameters

ty

Type

ui

FormConfig

Returns

OptionForm

Overrides

InputForm.constructor

Properties

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

Inherited from

InputForm.form

ty

ty: Type

Defined in: packages/core/src/candid/candid-core.ts:225

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:226

Inherited from

InputForm.ui

Methods

generateForm()

generateForm(): void

Defined in: packages/core/src/candid/candid-core.ts:230

Returns

void

Overrides

InputForm.generateForm

parse()

parse<T>(config): [] | [T] | undefined

Defined in: packages/core/src/candid/candid-core.ts:238

Type Parameters

T

T

Parameters

config

ParseConfig

Returns

[] | [T] | undefined

Overrides

InputForm.parse

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.render

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.renderForm

---

PipeArrayBuffer

Defined in: packages/core/src/candid/utils/buffer.ts:18

A class that abstracts a pipe-like Uint8Array.

Constructors

Constructor

new PipeArrayBuffer(buffer?, length?): PipeArrayBuffer

Defined in: packages/core/src/candid/utils/buffer.ts:54

Creates a new instance of a pipe

Parameters

buffer?

Uint8Array<ArrayBufferLike>

an optional buffer to start with

length?

number = ...

an optional amount of bytes to use for the length.

Returns

PipeArrayBuffer

Accessors

buffer

Get Signature

get buffer(): Uint8Array

Defined in: packages/core/src/candid/utils/buffer.ts:72

Returns

Uint8Array

byteLength

Get Signature

get byteLength(): number

Defined in: packages/core/src/candid/utils/buffer.ts:77

Returns

number

end

Get Signature

get end(): boolean

Defined in: packages/core/src/candid/utils/buffer.ts:127

Whether or not there is more data to read from the buffer

Returns

boolean

Methods

alloc()

alloc(amount): void

Defined in: packages/core/src/candid/utils/buffer.ts:135

Allocate a fixed amount of memory in the buffer. This does not affect the view.

Parameters

amount

number

A number of bytes to add to the buffer.

Returns

void

read()

read(num): Uint8Array

Defined in: packages/core/src/candid/utils/buffer.ts:85

Read num number of bytes from the front of the pipe.

Parameters

num

number

The number of bytes to read.

Returns

Uint8Array

readUint8()

readUint8(): number | undefined

Defined in: packages/core/src/candid/utils/buffer.ts:91

Returns

number | undefined

restore()

restore(checkPoint): void

Defined in: packages/core/src/candid/utils/buffer.ts:36

Restore a checkpoint of the reading view (for backtracking)

Parameters

checkPoint

Uint8Array

a previously saved checkpoint

Returns

void

save()

save(): Uint8Array

Defined in: packages/core/src/candid/utils/buffer.ts:28

Save a checkpoint of the reading view (for backtracking)

Returns

Uint8Array

write()

write(buf): void

Defined in: packages/core/src/candid/utils/buffer.ts:104

Write a buffer to the end of the pipe.

Parameters

buf

Uint8Array

The bytes to write.

Returns

void

---

RecordForm

Defined in: packages/core/src/candid/candid-core.ts:139

Extends

• InputForm

Constructors

Constructor

new RecordForm(fields, ui): RecordForm

Defined in: packages/core/src/candid/candid-core.ts:140

Parameters

fields

[string, Type<any>][]

ui

FormConfig

Returns

RecordForm

Overrides

InputForm.constructor

Properties

fields

fields: [string, Type<any>][]

Defined in: packages/core/src/candid/candid-core.ts:141

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

Inherited from

InputForm.form

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:142

Inherited from

InputForm.ui

Methods

generateForm()

generateForm(): void

Defined in: packages/core/src/candid/candid-core.ts:146

Returns

void

Overrides

InputForm.generateForm

parse()

parse(config): Record<string, any> | undefined

Defined in: packages/core/src/candid/candid-core.ts:158

Parameters

config

ParseConfig

Returns

Record<string, any> | undefined

Overrides

InputForm.parse

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.render

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.renderForm

---

Render

Defined in: packages/core/src/candid/candid-ui.ts:31

Extends

• Visitor<null, InputBox>

Constructors

Constructor

new Render(): Render

Returns

Render

Inherited from

Visitor.constructor

Methods

visitBool()

visitBool(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:154

Parameters

t

BoolClass

data

null

Returns

InputBox

Inherited from

Visitor.visitBool

visitConstruct()

visitConstruct<T>(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:188

Type Parameters

T

T

Parameters

t

ConstructType<T>

data

null

Returns

InputBox

Inherited from

Visitor.visitConstruct

visitEmpty()

visitEmpty(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:151

Parameters

t

EmptyClass

data

null

Returns

InputBox

Inherited from

Visitor.visitEmpty

visitFixedInt()

visitFixedInt(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:178

Parameters

t

FixedIntClass

data

null

Returns

InputBox

Inherited from

Visitor.visitFixedInt

visitFixedNat()

visitFixedNat(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:181

Parameters

t

FixedNatClass

data

null

Returns

InputBox

Inherited from

Visitor.visitFixedNat

visitFloat()

visitFloat(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:175

Parameters

t

FloatClass

data

null

Returns

InputBox

Inherited from

Visitor.visitFloat

visitFunc()

visitFunc(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:210

Parameters

t

FuncClass

data

null

Returns

InputBox

Inherited from

Visitor.visitFunc

visitInt()

visitInt(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:169

Parameters

t

IntClass

data

null

Returns

InputBox

Inherited from

Visitor.visitInt

visitNat()

visitNat(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:172

Parameters

t

NatClass

data

null

Returns

InputBox

Inherited from

Visitor.visitNat

visitNull()

visitNull(t, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:38

Parameters

t

NullClass

_d

null

Returns

InputBox

Overrides

Visitor.visitNull

visitNumber()

visitNumber<T>(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:166

Type Parameters

T

T

Parameters

t

PrimitiveType<T>

data

null

Returns

InputBox

Inherited from

Visitor.visitNumber

visitOpt()

visitOpt<T>(t, ty, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:77

Type Parameters

T

T

Parameters

t

OptClass<T>

ty

Type<T>

_d

null

Returns

InputBox

Overrides

Visitor.visitOpt

visitPrimitive()

visitPrimitive<T>(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:148

Type Parameters

T

T

Parameters

t

PrimitiveType<T>

data

null

Returns

InputBox

Inherited from

Visitor.visitPrimitive

visitPrincipal()

visitPrincipal(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:184

Parameters

t

PrincipalClass

data

null

Returns

InputBox

Inherited from

Visitor.visitPrincipal

visitRec()

visitRec<T>(_t, ty, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:97

Type Parameters

T

T

Parameters

_t

RecClass<T>

ty

ConstructType<T>

_d

null

Returns

InputBox

Overrides

Visitor.visitRec

visitRecord()

visitRecord(t, fields, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:41

Parameters

t

RecordClass

fields

[string, Type<any>][]

_d

null

Returns

InputBox

Overrides

Visitor.visitRecord

visitReserved()

visitReserved(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:160

Parameters

t

ReservedClass

data

null

Returns

InputBox

Inherited from

Visitor.visitReserved

visitService()

visitService(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:213

Parameters

t

ServiceClass

data

null

Returns

InputBox

Inherited from

Visitor.visitService

visitText()

visitText(t, data): InputBox

Defined in: packages/core/src/candid/idl.ts:163

Parameters

t

TextClass

data

null

Returns

InputBox

Inherited from

Visitor.visitText

visitTuple()

visitTuple<T>(t, components, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:51

Type Parameters

T

T extends any[]

Parameters

t

TupleClass<T>

components

Type<any>[]

_d

null

Returns

InputBox

Overrides

Visitor.visitTuple

visitType()

visitType<T>(t, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:32

Type Parameters

T

T

Parameters

t

Type<T>

_d

null

Returns

InputBox

Overrides

Visitor.visitType

visitVariant()

visitVariant(t, fields, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:65

Parameters

t

VariantClass

fields

[string, Type<any>][]

_d

null

Returns

InputBox

Overrides

Visitor.visitVariant

visitVec()

visitVec<T>(t, ty, _d): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:84

Type Parameters

T

T

Parameters

t

VecClass<T>

ty

Type<T>

_d

null

Returns

InputBox

Overrides

Visitor.visitVec

---

TupleForm

Defined in: packages/core/src/candid/candid-core.ts:171

Extends

• InputForm

Constructors

Constructor

new TupleForm(components, ui): TupleForm

Defined in: packages/core/src/candid/candid-core.ts:172

Parameters

components

Type<any>[]

ui

FormConfig

Returns

TupleForm

Overrides

InputForm.constructor

Properties

components

components: Type<any>[]

Defined in: packages/core/src/candid/candid-core.ts:173

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

Inherited from

InputForm.form

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:174

Inherited from

InputForm.ui

Methods

generateForm()

generateForm(): void

Defined in: packages/core/src/candid/candid-core.ts:178

Returns

void

Overrides

InputForm.generateForm

parse()

parse(config): any[] | undefined

Defined in: packages/core/src/candid/candid-core.ts:184

Parameters

config

ParseConfig

Returns

any[] | undefined

Overrides

InputForm.parse

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.render

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.renderForm

---

VariantForm

Defined in: packages/core/src/candid/candid-core.ts:197

Extends

• InputForm

Constructors

Constructor

new VariantForm(fields, ui): VariantForm

Defined in: packages/core/src/candid/candid-core.ts:198

Parameters

fields

[string, Type<any>][]

ui

FormConfig

Returns

VariantForm

Overrides

InputForm.constructor

Properties

fields

fields: [string, Type<any>][]

Defined in: packages/core/src/candid/candid-core.ts:199

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

Inherited from

InputForm.form

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:200

Inherited from

InputForm.ui

Methods

generateForm()

generateForm(): void

Defined in: packages/core/src/candid/candid-core.ts:204

Returns

void

Overrides

InputForm.generateForm

parse()

parse(config): Record<string, any> | undefined

Defined in: packages/core/src/candid/candid-core.ts:210

Parameters

config

ParseConfig

Returns

Record<string, any> | undefined

Overrides

InputForm.parse

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.render

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.renderForm

---

VecForm

Defined in: packages/core/src/candid/candid-core.ts:250

Extends

• InputForm

Constructors

Constructor

new VecForm(ty, ui): VecForm

Defined in: packages/core/src/candid/candid-core.ts:251

Parameters

ty

Type

ui

FormConfig

Returns

VecForm

Overrides

InputForm.constructor

Properties

form

form: InputBox[] = []

Defined in: packages/core/src/candid/candid-core.ts:100

Inherited from

InputForm.form

ty

ty: Type

Defined in: packages/core/src/candid/candid-core.ts:252

ui

ui: FormConfig

Defined in: packages/core/src/candid/candid-core.ts:253

Inherited from

InputForm.ui

Methods

generateForm()

generateForm(): void

Defined in: packages/core/src/candid/candid-core.ts:257

Returns

void

Overrides

InputForm.generateForm

parse()

parse<T>(config): T[] | undefined

Defined in: packages/core/src/candid/candid-core.ts:265

Type Parameters

T

T

Parameters

config

ParseConfig

Returns

T[] | undefined

Overrides

InputForm.parse

render()

render(dom): void

Defined in: packages/core/src/candid/candid-core.ts:113

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.render

renderForm()

renderForm(dom): void

Defined in: packages/core/src/candid/candid-core.ts:105

Parameters

dom

HTMLElement

Returns

void

Inherited from

InputForm.renderForm

Interfaces

FormConfig

Defined in: packages/core/src/candid/candid-core.ts:15

Properties

container?

optional container?: HTMLElement

Defined in: packages/core/src/candid/candid-core.ts:19

event?

optional event?: string

Defined in: packages/core/src/candid/candid-core.ts:17

labelMap?

optional labelMap?: Record<string, string>

Defined in: packages/core/src/candid/candid-core.ts:18

open?

optional open?: HTMLElement

Defined in: packages/core/src/candid/candid-core.ts:16

Methods

render()

render(t): InputBox

Defined in: packages/core/src/candid/candid-core.ts:20

Parameters

t

Type

Returns

InputBox

---

JsonArray

Defined in: packages/core/src/candid/types.ts:3

Extends

• Array<JsonValue>

Indexable

[n: number]: JsonValue

Properties

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.

Index Signature

[key: number]: boolean | undefined

[iterator]?

optional [iterator]?: boolean

[unscopables]?

readonly optional [unscopables]?: boolean

Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.

at?

optional at?: boolean

concat?

optional concat?: boolean

copyWithin?

optional copyWithin?: boolean

entries?

optional entries?: boolean

every?

optional every?: boolean

fill?

optional fill?: boolean

filter?

optional filter?: boolean

find?

optional find?: boolean

findIndex?

optional findIndex?: boolean

flat?

optional flat?: boolean

flatMap?

optional flatMap?: boolean

forEach?

optional forEach?: boolean

includes?

optional includes?: boolean

indexOf?

optional indexOf?: boolean

join?

optional join?: boolean

keys?

optional keys?: boolean

lastIndexOf?

optional lastIndexOf?: boolean

length?

optional length?: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map?: boolean

pop?

optional pop?: boolean

push?

optional push?: boolean

reduce?

optional reduce?: boolean

reduceRight?

optional reduceRight?: boolean

reverse?

optional reverse?: boolean

shift?

optional shift?: boolean

slice?

optional slice?: boolean

some?

optional some?: boolean

sort?

optional sort?: boolean

splice?

optional splice?: boolean

toLocaleString?

optional toLocaleString?: boolean

toString?

optional toString?: boolean

unshift?

optional unshift?: boolean

values?

optional values?: boolean

Inherited from

Array.[unscopables]

length

length: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1329

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

Array.length

Methods

[iterator]()

[iterator](): ArrayIterator<JsonValue>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<JsonValue>

Inherited from

Array.[iterator]

at()

at(index): JsonValue | undefined

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

JsonValue | undefined

Inherited from

Array.at

concat()

Call Signature

concat(…items): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1353

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

…ConcatArray<JsonValue>[]

Additional arrays and/or items to add to the end of the array.

Returns

JsonValue[]

Inherited from

Array.concat

Call Signature

concat(…items): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1359

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

…(JsonValue | ConcatArray<JsonValue>)[]

Additional arrays and/or items to add to the end of the array.

Returns

JsonValue[]

Inherited from

Array.concat

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Array.copyWithin

entries()

entries(): ArrayIterator<[number, JsonValue]>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, JsonValue]>

Inherited from

Array.entries

every()

Call Signature

every<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1440

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S extends JsonValue

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

Array.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1449

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.every

fill()

fill(value, start?, end?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

JsonValue

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Array.fill

filter()

Call Signature

filter<S>(predicate, thisArg?): S[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1476

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S extends JsonValue

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

Array.filter

Call Signature

filter(predicate, thisArg?): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1482

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

JsonValue[]

Inherited from

Array.filter

find()

Call Signature

find<S>(predicate, thisArg?): S | undefined

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends JsonValue

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S | undefined

Inherited from

Array.find

Call Signature

find(predicate, thisArg?): JsonValue | undefined

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

JsonValue | undefined

Inherited from

Array.find

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Array.findIndex

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

flatMap()

flatMap<U, This>(callback, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

U

U

This

This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.flatMap

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1464

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Array.forEach

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

JsonValue

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Array.includes

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1425

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

JsonValue

The value to locate in the array.

fromIndex?

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Array.indexOf

join()

join(separator?): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1364

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

keys()

keys(): ArrayIterator<number>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Array.keys

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1431

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

JsonValue

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

map()

map<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1470

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

U

U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.map

pop()

pop(): JsonValue | undefined

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1342

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

JsonValue | undefined

Inherited from

Array.pop

push()

push(…items): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1347

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

items

…JsonValue[]

New elements to add to the array.

Returns

number

Inherited from

Array.push

reduce()

Call Signature

reduce(callbackfn): JsonValue

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1488

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => JsonValue

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

JsonValue

Inherited from

Array.reduce

Call Signature

reduce(callbackfn, initialValue): JsonValue

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1489

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => JsonValue

initialValue

JsonValue

Returns

JsonValue

Inherited from

Array.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1495

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduce

reduceRight()

Call Signature

reduceRight(callbackfn): JsonValue

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1501

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => JsonValue

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

JsonValue

Inherited from

Array.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): JsonValue

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1502

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => JsonValue

initialValue

JsonValue

Returns

JsonValue

Inherited from

Array.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1508

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduceRight

reverse()

reverse(): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1369

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

JsonValue[]

Inherited from

Array.reverse

shift()

shift(): JsonValue | undefined

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1374

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

JsonValue | undefined

Inherited from

Array.shift

slice()

slice(start?, end?): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1384

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

start?

number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end?

number

The end index of the specified portion of the array. This is exclusive of the element at the index ‘end’. If end is undefined, then the slice extends to the end of the array.

Returns

JsonValue[]

Inherited from

Array.slice

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1458

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.some

sort()

sort(compareFn?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1395

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they’re equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Array.sort

splice()

Call Signature

splice(start, deleteCount?): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1404

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns

JsonValue[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Call Signature

splice(start, deleteCount, …items): JsonValue[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1414

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items

…JsonValue[]

Elements to insert into the array in place of the deleted elements.

Returns

JsonValue[]

An array containing the elements that were deleted.

Inherited from

Array.splice

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1337

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Array.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Array.toLocaleString

toString()

toString(): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1333

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

unshift()

unshift(…items): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1419

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

items

…JsonValue[]

Elements to insert at the start of the array.

Returns

number

Inherited from

Array.unshift

values()

values(): ArrayIterator<JsonValue>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator<JsonValue>

Inherited from

Array.values

---

JsonObject

Defined in: packages/core/src/candid/types.ts:5

Extends

• Record<string, JsonValue>

Indexable

[key: string]: JsonValue

---

ParseConfig

Defined in: packages/core/src/candid/candid-core.ts:5

Properties

random?

optional random?: boolean

Defined in: packages/core/src/candid/candid-core.ts:6

---

UIConfig

Defined in: packages/core/src/candid/candid-core.ts:9

Properties

form?

optional form?: InputForm

Defined in: packages/core/src/candid/candid-core.ts:11

input?

optional input?: HTMLElement

Defined in: packages/core/src/candid/candid-core.ts:10

Methods

parse()

parse(t, config, v): any

Defined in: packages/core/src/candid/candid-core.ts:12

Parameters

t

Type

config

ParseConfig

v

string

Returns

any

Type Aliases

JsonValue

JsonValue = boolean | string | number | bigint | JsonArray | JsonObject

Defined in: packages/core/src/candid/types.ts:7

Functions

compare()

compare(u1, u2): number

Defined in: packages/core/src/candid/utils/buffer.ts:189

Parameters

u1

Uint8Array

uint8Array 1

u2

Uint8Array

uint8Array 2

Returns

number

number - negative if u1 < u2, positive if u1 > u2, 0 if u1 === u2

---

concat()

concat(…uint8Arrays): Uint8Array

Defined in: packages/core/src/candid/utils/buffer.ts:5

Concatenate multiple Uint8Arrays.

Parameters

uint8Arrays

…Uint8Array<ArrayBufferLike>[]

The Uint8Arrays to concatenate.

Returns

Uint8Array

---

idlLabelToId()

idlLabelToId(label): number

Defined in: packages/core/src/candid/utils/hash.ts:23

Parameters

label

string

string

Returns

number

number representing hashed label

---

inputBox()

inputBox(t, config): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:12

Parameters

t

Type

config

Partial<UIConfig>

Returns

InputBox

---

lebDecode()

lebDecode(pipe): bigint

Defined in: packages/core/src/candid/utils/leb128.ts:74

Decode a leb encoded buffer into a bigint. The number will always be positive (does not support signed leb encoding).

Parameters

pipe

PipeArrayBuffer

A Buffer containing the leb encoded bits.

Returns

bigint

---

lebEncode()

lebEncode(value): Uint8Array

Defined in: packages/core/src/candid/utils/leb128.ts:44

Encode a positive number (or bigint) into a Buffer. The number will be floored to the nearest integer.

Parameters

value

number | bigint

The number to encode.

Returns

Uint8Array

---

optForm()

optForm(ty, config): OptionForm

Defined in: packages/core/src/candid/candid-ui.ts:24

Parameters

ty

Type

config

Partial<FormConfig>

Returns

OptionForm

---

readIntLE()

readIntLE(pipe, byteLength): bigint

Defined in: packages/core/src/candid/utils/leb128.ts:223

Parameters

pipe

PipeArrayBuffer

Pipe from buffer-pipe

byteLength

number

number

Returns

bigint

bigint

---

readUIntLE()

readUIntLE(pipe, byteLength): bigint

Defined in: packages/core/src/candid/utils/leb128.ts:202

Parameters

pipe

PipeArrayBuffer

Pipe from buffer-pipe

byteLength

number

number

Returns

bigint

bigint

---

recordForm()

recordForm(fields, config): RecordForm

Defined in: packages/core/src/candid/candid-ui.ts:15

Parameters

fields

[string, Type<any>][]

config

Partial<FormConfig>

Returns

RecordForm

---

renderInput()

renderInput(t): InputBox

Defined in: packages/core/src/candid/candid-ui.ts:202

Parameters

t

Type

an IDL type

Returns

InputBox

an input for that type

---

renderValue()

renderValue(t, input, value): void

Defined in: packages/core/src/candid/candid-ui.ts:218

Parameters

t

Type

an IDL Type

input

InputBox

an InputBox

value

any

any

Returns

void

rendering that value to the provided input

---

safeRead()

safeRead(pipe, num): Uint8Array

Defined in: packages/core/src/candid/utils/leb128.ts:21

Parameters

pipe

PipeArrayBuffer

Pipe from buffer-pipe

num

number

number

Returns

Uint8Array

Uint8Array

---

safeReadUint8()

safeReadUint8(pipe): number

Defined in: packages/core/src/candid/utils/leb128.ts:31

Parameters

pipe

PipeArrayBuffer

PipeArrayBuffer simulating buffer-pipe api

Returns

number

---

slebDecode()

slebDecode(pipe): bigint

Defined in: packages/core/src/candid/utils/leb128.ts:134

Decode a leb encoded buffer into a bigint. The number is decoded with support for negative signed-leb encoding.

Parameters

pipe

PipeArrayBuffer

A Buffer containing the signed leb encoded bits.

Returns

bigint

---

slebEncode()

slebEncode(value): Uint8Array

Defined in: packages/core/src/candid/utils/leb128.ts:93

Encode a number (or bigint) into a Buffer, with support for negative numbers. The number will be floored to the nearest integer.

Parameters

value

number | bigint

The number to encode.

Returns

Uint8Array

---

tupleForm()

tupleForm(components, config): TupleForm

Defined in: packages/core/src/candid/candid-ui.ts:18

Parameters

components

Type<any>[]

config

Partial<FormConfig>

Returns

TupleForm

---

uint8Equals()

uint8Equals(u1, u2): boolean

Defined in: packages/core/src/candid/utils/buffer.ts:207

Checks two uint8Arrays for equality.

Parameters

u1

Uint8Array

uint8Array 1

u2

Uint8Array

uint8Array 2

Returns

boolean

boolean

---

uint8FromBufLike()

uint8FromBufLike(bufLike): Uint8Array

Defined in: packages/core/src/candid/utils/buffer.ts:153

Returns a true Uint8Array from an ArrayBufferLike object.

Parameters

bufLike

ArrayBufferLike | Uint8Array<ArrayBufferLike> | number[] | DataView<ArrayBufferLike> | ArrayBufferView<ArrayBufferLike> | [number] | { buffer: ArrayBuffer; }

a buffer-like object

Returns

Uint8Array

Uint8Array

---

uint8ToDataView()

uint8ToDataView(uint8): DataView

Defined in: packages/core/src/candid/utils/buffer.ts:216

Helpers to convert a Uint8Array to a DataView.

Parameters

uint8

Uint8Array

Uint8Array

Returns

DataView

DataView

---

variantForm()

variantForm(fields, config): VariantForm

Defined in: packages/core/src/candid/candid-ui.ts:21

Parameters

fields

[string, Type<any>][]

config

Partial<FormConfig>

Returns

VariantForm

---

vecForm()

vecForm(ty, config): VecForm

Defined in: packages/core/src/candid/candid-ui.ts:27

Parameters

ty

Type

config

Partial<FormConfig>

Returns

VecForm

---

writeIntLE()

writeIntLE(value, byteLength): Uint8Array

Defined in: packages/core/src/candid/utils/leb128.ts:175

Parameters

value

number | bigint

bigint or number

byteLength

number

number

Returns

Uint8Array

Uint8Array

---

writeUIntLE()

writeUIntLE(value, byteLength): Uint8Array

Defined in: packages/core/src/candid/utils/leb128.ts:162

Parameters

value

number | bigint

bigint or number

byteLength

number

number

Returns

Uint8Array

Uint8Array

References

GenericIdlFuncArgs

Re-exports GenericIdlFuncArgs

---

GenericIdlFuncRets

Re-exports GenericIdlFuncRets

---

GenericIdlServiceFields

Re-exports GenericIdlServiceFields