IDL | @dfinity/candid

Type Aliases

InterfaceFactory

InterfaceFactory: ((idl: { IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: typeof Func; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: typeof Opt; Principal: PrincipalClass; Rec: typeof Rec; Record: typeof Record; Reserved: ReservedClass; Text: TextClass; Tuple: typeof Tuple; Unknown: UnknownClass; Variant: typeof Variant; Vec: typeof Vec; Service: any } }) => ServiceClass)

Type declaration

- (idl: { IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: typeof Func; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: typeof Opt; Principal: PrincipalClass; Rec: typeof Rec; Record: typeof Record; Reserved: ReservedClass; Text: TextClass; Tuple: typeof Tuple; Unknown: UnknownClass; Variant: typeof Variant; Vec: typeof Vec; Service: any } }): ServiceClass
- An Interface Factory, normally provided by a Candid code generation.
  
  Parameters
  - idl: { IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: typeof Func; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: typeof Opt; Principal: PrincipalClass; Rec: typeof Rec; Record: typeof Record; Reserved: ReservedClass; Text: TextClass; Tuple: typeof Tuple; Unknown: UnknownClass; Variant: typeof Variant; Vec: typeof Vec; Service: any } }
    - IDL: { Bool: BoolClass; Empty: EmptyClass; Float32: FloatClass; Float64: FloatClass; Func: typeof Func; Int: IntClass; Int16: FixedIntClass; Int32: FixedIntClass; Int64: FixedIntClass; Int8: FixedIntClass; Nat: NatClass; Nat16: FixedNatClass; Nat32: FixedNatClass; Nat64: FixedNatClass; Nat8: FixedNatClass; Null: NullClass; Opt: typeof Opt; Principal: PrincipalClass; Rec: typeof Rec; Record: typeof Record; Reserved: ReservedClass; Text: TextClass; Tuple: typeof Tuple; Unknown: UnknownClass; Variant: typeof Variant; Vec: typeof Vec; Service: any }
      - Bool: BoolClass
      - Empty: EmptyClass
      - Float32: FloatClass
      - Float64: FloatClass
      - Func: typeof Func
      - Int: IntClass
      - Int16: FixedIntClass
      - Int32: FixedIntClass
      - Int64: FixedIntClass
      - Int8: FixedIntClass
      - Nat: NatClass
      - Nat16: FixedNatClass
      - Nat32: FixedNatClass
      - Nat64: FixedNatClass
      - Nat8: FixedNatClass
      - Null: NullClass
      - Opt: typeof Opt
      - Principal: PrincipalClass
      - Rec: typeof Rec
      - Record: typeof Record
      - Reserved: ReservedClass
      - Text: TextClass
      - Tuple: typeof Tuple
      - Unknown: UnknownClass
      - Variant: typeof Variant
      - Vec: typeof Vec
      - Service:function
        Service(t: Record<string, FuncClass>): ServiceClass
        Defined in packages/candid/src/idl.ts:1879
        Parameters
        t: Record<string, FuncClass>
        Returns ServiceClass
  Returns ServiceClass

Variables

Const Bool

Bool: BoolClass = ...

Const Empty

Empty: EmptyClass = ...

Const Float32

Float32: FloatClass = ...

Const Float64

Float64: FloatClass = ...

Const Int

Int: IntClass = ...

Const Nat

Nat: NatClass = ...

Const Nat16

Nat16: FixedNatClass = ...

Const Nat32

Nat32: FixedNatClass = ...

Const Nat64

Nat64: FixedNatClass = ...

Const Nat8

Nat8: FixedNatClass = ...

Const Null

Null: NullClass = ...

Const Principal

Principal: PrincipalClass = ...

Const Reserved

Reserved: ReservedClass = ...

Const Text

Text: TextClass = ...

Const Unknown

Unknown: UnknownClass = ...

Client-only type for deserializing unknown data. Not supported by Candid, and its use is discouraged.

Functions

Func

Func(args: Type<any>[], ret: Type<any>[], annotations?: string[]): FuncClass

- Defined in packages/candid/src/idl.ts:1967
Parameters
- args: Type<any>[]
  
  array of IDL Types
- ret: Type<any>[]
  
  array of IDL Types
- annotations: string[] = []
  
  array of strings, [] by default
Returns FuncClass
new FuncClass

Opt

Opt<T>(t: Type<T>): OptClass<T>

- Defined in packages/candid/src/idl.ts:1932
Type Parameters
- T
Parameters
- t: Type<T>
  
  IDL Type
Returns OptClass<T>
OptClass of Type

Rec

Rec(): RecClass

- Defined in packages/candid/src/idl.ts:1956
Returns RecClass
new RecClass

Record

Record(t: Record<string, Type<any>>): RecordClass

- Defined in packages/candid/src/idl.ts:1940
Parameters
- t: Record<string, Type<any>>
  
  Record of string and IDL Type
Returns RecordClass
RecordClass of string and Type

Service

Service(t: Record<string, FuncClass>): ServiceClass

- Defined in packages/candid/src/idl.ts:1976
Parameters
- t: Record<string, FuncClass>
  
  Record of string and FuncClass
Returns ServiceClass
ServiceClass

Tuple

Tuple<T>(...types: T): TupleClass<T>

- Defined in packages/candid/src/idl.ts:1916
Type Parameters
- T extends any[]
Parameters
- Rest ...types: T
  
  array of any types
Returns TupleClass<T>
TupleClass from those types

Variant

Variant(fields: Record<string, Type<any>>): VariantClass

- Defined in packages/candid/src/idl.ts:1949
Parameters
- fields: Record<string, Type<any>>
  
  Record of string and IDL Type
Returns VariantClass
VariantClass

Vec

Vec<T>(t: Type<T>): VecClass<T>

- Defined in packages/candid/src/idl.ts:1924
Type Parameters
- T
Parameters
- t: Type<T>
  
  IDL Type
Returns VecClass<T>
VecClass from that type

decode

decode(retTypes: Type<any>[], bytes: ArrayBuffer): JsonValue[]

- Defined in packages/candid/src/idl.ts:1588
Decode a binary value

Parameters
- retTypes: Type<any>[]
  
  Types expected in the buffer.
- bytes: ArrayBuffer
  
  hex-encoded string, or buffer.
Returns JsonValue[]
Value deserialised to JS type

encode

encode(argTypes: Type<any>[], args: any[]): ArrayBuffer

- Defined in packages/candid/src/idl.ts:1554
Encode a array of values

Parameters
- argTypes: Type<any>[]
  
  array of Types
- args: any[]
  
  array of values
Returns ArrayBuffer
serialised value

Index

Classes

Type Aliases

Variables

Functions

Type Aliases

InterfaceFactory

Type declaration

Parameters

Bool: BoolClass

Empty: EmptyClass

Float32: FloatClass

Float64: FloatClass

Func: typeof Func

Int: IntClass

Int16: FixedIntClass

Int32: FixedIntClass

Int64: FixedIntClass

Int8: FixedIntClass

Nat: NatClass

Nat16: FixedNatClass

Nat32: FixedNatClass

Nat64: FixedNatClass

Nat8: FixedNatClass

Null: NullClass

Opt: typeof Opt

Principal: PrincipalClass

Rec: typeof Rec

Record: typeof Record

Reserved: ReservedClass

Text: TextClass

Tuple: typeof Tuple

Unknown: UnknownClass

Variant: typeof Variant

Vec: typeof Vec

Service:function

Parameters

t: Record<string, FuncClass>

Returns ServiceClass

Returns ServiceClass

Variables

Const Bool

Const Empty

Const Float32

Const Float64

Const Int

Const Int16

Const Int32

Const Int64

Const Int8

Const Nat

Const Nat16

Const Nat32

Const Nat64

Const Nat8

Const Null

Const Principal

Const Reserved

Const Text

Const Unknown

Functions

Func

Parameters

args: Type<any>[]

ret: Type<any>[]

annotations: string[] = []

Returns FuncClass

Opt

Type Parameters

T

Parameters

t: Type<T>

Returns OptClass<T>

Rec

Returns RecClass

Record

Parameters

t: Record<string, Type<any>>

Returns RecordClass

Service