PodAddress overview

Added in v1.0.0

Table of contents

• constructors
  • make
• models
  • PodAddress (class)
    • toString (method)
  • PodAddress (namespace)
    • Encoded (interface)
• schema
  • schema
• symbols
  • PodAddressTypeId
  • PodAddressTypeId (type alias)
• utils
  • isPodAddress

constructors

make

Constructs a PodAddress from an host and a port.

Signature

export declare function make(host: string, port: number): PodAddress

Added in v1.0.0

models

PodAddress (class)

A PodAddress is a unique identifier of a Pod (application server). It is conventially built by using an address and a port, so that messaging implementations may use directly the PodAddress to know how to connect to the specific Pod.

Signature

export declare class PodAddress

Added in v1.0.0

toString (method)

Signature

toString()

Added in v1.0.0

PodAddress (namespace)

Added in v1.0.0

Encoded (interface)

This is the shape one PodAddress has over the wire.

Signature

export interface Encoded extends Schema.Schema.Encoded<typeof PodAddress> {}

Added in v1.0.0

schema

schema

This is the schema for a PodAddress.

Signature

export declare const schema: Schema.Schema<PodAddress, PodAddress.Encoded>

Added in v1.0.0

symbols

PodAddressTypeId

Signature

export declare const PodAddressTypeId: typeof PodAddressTypeId

Added in v1.0.0

PodAddressTypeId (type alias)

Signature

export type PodAddressTypeId = typeof PodAddressTypeId

Added in v1.0.0

utils

isPodAddress

Ensures that the given value is a valid PodAddress.

Signature

export declare function isPodAddress(value: unknown): value is PodAddress

Added in v1.0.0