RecipientAddress overview

Added in v1.0.0

Table of contents

• constructors
  • isRecipientAddress
  • makeRecipientAddress
• models
  • RecipientAddress (class)
    • [Hash.symbol] (method)
    • [Equal.symbol] (method)
• symbols
  • RecipientAddressTypeId

constructors

isRecipientAddress

Ensure that given value is a RecipientAddress

Signature

export declare function isRecipientAddress(value: unknown): value is RecipientAddress

Added in v1.0.0

makeRecipientAddress

Given a name and a schema for the protocol, constructs an EntityType.

Signature

export declare function makeRecipientAddress(recipientTypeName: string, entityId: string): RecipientAddress

Added in v1.0.0

models

RecipientAddress (class)

A RecipientAddress uniquely identifies a RecipientType + EntityId instance.

Signature

export declare class RecipientAddress

Added in v1.0.0

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

Added in v1.0.0

[Equal.symbol] (method)

Signature

[Equal.symbol](this: RecipientAddress, that: Equal.Equal): boolean

Added in v1.0.0

symbols

RecipientAddressTypeId

Signature

export declare const RecipientAddressTypeId: typeof RecipientAddressTypeId

Added in v1.0.0