Documentation / @cashconnect-js/templates-dev / helpers/vars

VarOptions

type VarOptions = Partial<{
  required: boolean;
  description: string;
}>;

Defined in: packages/templates-dev/src/helpers/vars.ts:7

---

Vars

Defined in: packages/templates-dev/src/helpers/vars.ts:12

Constructors

Constructor

new Vars(): Vars;

Returns

Vars

Methods

address()

static address(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:17

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

bytes()

static bytes(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:25

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

enum()

static enum(
   name, 
   options, 
   config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:33

Parameters

Parameter	Type
name	string
options	string[]
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

number()

static number(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:46

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

publicKey()

static publicKey(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:54

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

satoshis()

static satoshis(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:65

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

signature()

static signature(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:76

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

string()

static string(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:87

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

transaction()

static transaction(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:95

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

transactionHash()

static transactionHash(name, config): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:106

Parameters

Parameter	Type
name	string
config	VarOptions

Returns

object

Name	Type	Defined in
type	| "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"	packages/core/dist/templates.d.ts:35
name	string	packages/core/dist/templates.d.ts:47
required?	boolean	packages/core/dist/templates.d.ts:48

object()

static object<T>(properties, required): object;

Defined in: packages/templates-dev/src/helpers/vars.ts:117

Type Parameters

Type Parameter
T extends Record<string, { type: | "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"; name: string; required?: boolean; }>

Parameters

Parameter	Type	Default value
properties	T	undefined
required	boolean	true

Returns

object

Name	Type	Default value	Defined in
type	"object"	'object'	packages/templates-dev/src/helpers/vars.ts:122
properties	T	-	packages/templates-dev/src/helpers/vars.ts:123
required	boolean	-	packages/templates-dev/src/helpers/vars.ts:124

withValues()

static withValues<T>(variables, valueAssignments): T;

Defined in: packages/templates-dev/src/helpers/vars.ts:138

Assign values to variables

Type Parameters

Type Parameter

T extends Record<string, | { type: "array"; properties: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{ type: z.ZodEnum<{ string: "string"; number: "number"; transaction: "transaction"; enum: "enum"; address: "address"; bytes: "bytes"; publicKey: "publicKey"; satoshis: "satoshis"; signature: "signature"; transactionHash: "transactionHash"; }>; name: z.ZodString; required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>; }, z.core.$strip>], "type">>; required?: boolean; } | { type: "object"; properties: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{ type: z.ZodEnum<{ string: "string"; number: "number"; transaction: "transaction"; enum: "enum"; address: "address"; bytes: "bytes"; publicKey: "publicKey"; satoshis: "satoshis"; signature: "signature"; transactionHash: "transactionHash"; }>; name: z.ZodString; required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>; }, z.core.$strip>], "type">>; required?: boolean; } | { type: | "string" | "number" | "transaction" | "enum" | "address" | "bytes" | "publicKey" | "satoshis" | "signature" | "transactionHash"; name: string; required?: boolean; }>

Parameters

Parameter	Type	Description
variables	T	The variable definitions
valueAssignments	Partial<Record<keyof T, string>>	Key-value pairs of variable names to values

Returns

T

Variables with values assigned