ConnectionDefinition
Defined in: pkgs/connection-contract/src/index.ts:77
Type Parameters
Section titled “Type Parameters”TCred = unknown
Properties
Section titled “Properties”capabilities
Section titled “capabilities”
readonlycapabilities:Capabilities
Defined in: pkgs/connection-contract/src/index.ts:80
displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: pkgs/connection-contract/src/index.ts:79
readonlykind:string
Defined in: pkgs/connection-contract/src/index.ts:78
Methods
Section titled “Methods”parseCredential()
Section titled “parseCredential()”parseCredential(
bytes):TCred
Defined in: pkgs/connection-contract/src/index.ts:83
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”TCred
serializeCredential()
Section titled “serializeCredential()”serializeCredential(
credential):Uint8Array
Defined in: pkgs/connection-contract/src/index.ts:82
Parameters
Section titled “Parameters”credential
Section titled “credential”TCred
Returns
Section titled “Returns”Uint8Array
setup()
Section titled “setup()”setup(
ctx):AsyncIterable<SetupStep>
Defined in: pkgs/connection-contract/src/index.ts:81
Parameters
Section titled “Parameters”Returns
Section titled “Returns”AsyncIterable<SetupStep>
teardown()
Section titled “teardown()”teardown(
credential,ctx):Promise<void>
Defined in: pkgs/connection-contract/src/index.ts:85
Parameters
Section titled “Parameters”credential
Section titled “credential”TCred
Returns
Section titled “Returns”Promise<void>
verify()
Section titled “verify()”verify(
credential,ctx):Promise<Readonly<{credential?:Uint8Array<ArrayBufferLike>;liveness:LivenessState;metadata?:Readonly<Record<string,unknown>>; }>>
Defined in: pkgs/connection-contract/src/index.ts:84
Parameters
Section titled “Parameters”credential
Section titled “credential”TCred
Returns
Section titled “Returns”Promise<Readonly<{ credential?: Uint8Array<ArrayBufferLike>; liveness: LivenessState; metadata?: Readonly<Record<string, unknown>>; }>>