Pod overview
Added in v1.0.0
Table of contents
constructors
make
Constructs a Pod from it’s identifing PodAddress and application server version.
Signature
export declare function make(address: PodAddress.PodAddress, version: string): Pod
Added in v1.0.0
models
Pod (class)
A pod is an application server that is able to run entities. A pod can run multiple entities, but a single entity will live on a given pod at a time. Since this is an application server, it needs to have an unique identifier where it’s addressed (PodAddress), and has a version of the application that’s running on it. Version is used during the rebalance phase to give priority to newer application servers and slowly kill older ones.
Signature
export declare class Pod
Added in v1.0.0
toString (method)
Signature
toString()
Added in v1.0.0
Pod (namespace)
Added in v1.0.0
Encoded (interface)
This is the shape that a Pod is represented over the wire.
Signature
export interface Encoded extends Schema.Schema.Encoded<typeof Pod> {}
Added in v1.0.0
schema
schema
Signature
export declare const schema: Schema.Schema<Pod, Pod.Encoded>
Added in v1.0.0
symbols
PodTypeId
Signature
export declare const PodTypeId: typeof PodTypeId
Added in v1.0.0
PodTypeId (type alias)
Signature
export type PodTypeId = typeof PodTypeId
Added in v1.0.0
utils
isPod
Given a value, ensures that it’s a valid Pod.
Signature
export declare function isPod(value: unknown): value is Pod
Added in v1.0.0