ziron-worker/dist/lib/WorkerServerOptions.d.ts

Ziron worker

import { ServerOptions } from "ziron-server";
import { LogLevel } from "./Logger";
export type WorkerServerOptions = {
    /**
     * @description
     * Specifies the join token to the cluster.
     * This is required if you want to run a cluster.
     */
    join?: string | null;
    /**
     * Defines the max size of clients to a broker instance.
     * The concrete max size is determined with the count of broker instances.
     * @default 12
     */
    brokerClusterClientMaxPoolSize?: number;
    /**
     * Defines payload that will be sent to the state server when a connection will be created.
     * @default {}
     */
    clusterJoinPayload?: any;
    /**
     * Defines an object that can be shared with all workers via the state server.
     * Notice, only the shared object from the first worker in the cluster will be actively used and shared.
     * It can be helpful to sync a secret between all workers.
     * @default undefined
     */
    clusterShared?: any;
    /**
     * This property indicates if the server should share the auth
     * options for verifying and sign tokens in a cluster.
     * The options of the first server that has joined the cluster
     * will be used for all other servers in the cluster. When the option is enabled,
     * the server will load the shared auth options.
     * That is useful if you are using generated auth keys that will change on every server start.
     * That helps to make the token valid on every server in the cluster,
     * even if the other servers had different auth options before joining the cluster.
     * @default true
     */
    clusterShareAuth?: boolean;
    /**
     * @description
     * The log level specifies what information should be logged.
     * @default LogLevel.Everything
     */
    logLevel?: LogLevel;
} & ServerOptions;