FuncClass
Defined in: packages/candid/src/idl.ts:1703
Represents an IDL function reference.
Argument types.
Return types.
Function annotations.
Extends
Section titled “Extends”ConstructType<[Principal,string]>
Type Parameters
Section titled “Type Parameters”Args extends GenericIdlFuncArgs = GenericIdlFuncArgs
Rets extends GenericIdlFuncRets = GenericIdlFuncRets
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FuncClass<
Args,Rets>(argTypes,retTypes,annotations):FuncClass<Args,Rets>
Defined in: packages/candid/src/idl.ts:1722
Parameters
Section titled “Parameters”argTypes
Section titled “argTypes”Args
retTypes
Section titled “retTypes”Rets
annotations
Section titled “annotations”string[] = []
Returns
Section titled “Returns”FuncClass<Args, Rets>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”annotations
Section titled “annotations”annotations:
string[] =[]
Defined in: packages/candid/src/idl.ts:1725
argTypes
Section titled “argTypes”argTypes:
Args
Defined in: packages/candid/src/idl.ts:1723
retTypes
Section titled “retTypes”retTypes:
Rets
Defined in: packages/candid/src/idl.ts:1724
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get name():
string
Defined in: packages/candid/src/idl.ts:1785
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”typeName
Section titled “typeName”Get Signature
Section titled “Get Signature”get typeName():
IdlTypeName
Defined in: packages/candid/src/idl.ts:1707
Returns
Section titled “Returns”IdlTypeName
Overrides
Section titled “Overrides”Methods
Section titled “Methods”_buildTypeTableImpl()
Section titled “_buildTypeTableImpl()”_buildTypeTableImpl(
T):void
Defined in: packages/candid/src/idl.ts:1749
Parameters
Section titled “Parameters”TypeTable
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ConstructType._buildTypeTableImpl
accept()
Section titled “accept()”accept<
D,R>(v,d):R
Defined in: packages/candid/src/idl.ts:1730
Type Parameters
Section titled “Type Parameters”D
R
Parameters
Section titled “Parameters”Visitor<D, R>
D
Returns
Section titled “Returns”R
Overrides
Section titled “Overrides”buildTypeTable()
Section titled “buildTypeTable()”buildTypeTable(
typeTable):void
Defined in: packages/candid/src/idl.ts:217
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”checkType()
Section titled “checkType()”checkType(
t):ConstructType<[Principal,string]>
Defined in: packages/candid/src/idl.ts:264
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ConstructType<[Principal, string]>
Inherited from
Section titled “Inherited from”covariant()
Section titled “covariant()”covariant(
x):x is [Principal, string]
Defined in: packages/candid/src/idl.ts:1733
Assert that JavaScript’s x is the proper type represented by this
Type.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”x is [Principal, string]
Overrides
Section titled “Overrides”decodeValue()
Section titled “decodeValue()”decodeValue(
b,t): [Principal,string]
Defined in: packages/candid/src/idl.ts:1764
Parameters
Section titled “Parameters”Returns
Section titled “Returns”[Principal, string]
Overrides
Section titled “Overrides”display()
Section titled “display()”display():
string
Defined in: packages/candid/src/idl.ts:1796
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”encodeType()
Section titled “encodeType()”encodeType(
typeTable):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:274
Implement I in the IDL spec.
Encode this type for the type table.
Parameters
Section titled “Parameters”typeTable
Section titled “typeTable”TypeTable
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Inherited from
Section titled “Inherited from”encodeValue()
Section titled “encodeValue()”encodeValue(
__namedParameters):Uint8Array<ArrayBufferLike>
Defined in: packages/candid/src/idl.ts:1739
Internal
Encode the value. This needs to be public because it is used by encodeValue() from different types.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”[Principal, string]
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike>
Overrides
Section titled “Overrides”valueToString()
Section titled “valueToString()”valueToString(
__namedParameters):string
Defined in: packages/candid/src/idl.ts:1792
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”[Principal, string]
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”[hasInstance]()
Section titled “[hasInstance]()”
static[hasInstance](instance):instance is FuncClass<GenericIdlFuncArgs, GenericIdlFuncRets>
Defined in: packages/candid/src/idl.ts:1711
Parameters
Section titled “Parameters”instance
Section titled “instance”any
Returns
Section titled “Returns”instance is FuncClass<GenericIdlFuncArgs, GenericIdlFuncRets>
argsToString()
Section titled “argsToString()”
staticargsToString(types,v):string
Defined in: packages/candid/src/idl.ts:1715
Parameters
Section titled “Parameters”Type<any>[]
any[]
Returns
Section titled “Returns”string