Documentation / @cashconnect-js/core / templates/template-instance

TemplateInstructionsSupported

type TemplateInstructionsSupported = 
  | InstructionResolve
  | InstructionTransaction;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:39

---

TemplateInstructionHandlers

type TemplateInstructionHandlers = TemplateInstructionHandler<TemplateInstructionsSupported>;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:43

---

TemplateInstance

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:46

Type Parameters

Type Parameter	Default type
T extends Template	Template

Constructors

Constructor

new TemplateInstance<T>(template, context): TemplateInstance<T>;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:55

Parameters

Parameter	Type
template	T
context	TemplateContext

Returns

TemplateInstance<T>

Methods

from()

static from<T>(template, context): TemplateInstance<T>;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:50

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type
template	T
context	TemplateContext

Returns

TemplateInstance<T>

executeAction()

executeAction<A>(actionName, params): Promise<ActionResult<T, A>>;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:63

Type Parameters

Type Parameter
A extends string

Parameters

Parameter	Type
actionName	A
params	{ [K in string | number | symbol]: ({ [K in string | number | symbol as T["actions"][A]["params"][K] extends { required: false } ? never : K]: ProcessVariable<T["actions"][A]["params"][K]> } & { [K in string | number | symbol as T["actions"][A]["params"][K] extends { required: false } ? K : never]?: ProcessVariable<T["actions"][A]["params"][K]> })[K] }

Returns

Promise<ActionResult<T, A>>

processPayload()

processPayload(params, templateParams): object;

Defined in: cashconnect-js/packages/core/src/templates/template-instance.ts:222

Parameters

Parameter	Type
params	| { [key: string]: | Uint8Array<ArrayBufferLike> | object[] | { [key: string]: Uint8Array<ArrayBufferLike>; }; } | { [key: string]: | Uint8Array<ArrayBufferLike> | object[] | { [key: string]: Uint8Array<ArrayBufferLike>; }; }
templateParams	TemplateVariables

Returns

object

Properties

Property	Modifier	Type	Defined in
template	readonly	T	cashconnect-js/packages/core/src/templates/template-instance.ts:47
compiler	readonly	Compiler	cashconnect-js/packages/core/src/templates/template-instance.ts:48
context	readonly	TemplateContext	cashconnect-js/packages/core/src/templates/template-instance.ts:55