• Get the basic configuration definitions for RabbitMQ-specific settings

    Parameters

    • variables: Dict<undefined | string> = process.env

      process.env variables or custom provided values

    • Optional logger: LoggerFn

    Returns {
        rmqChannelMax: (() => number);
        rmqDevMiddleware: (() => boolean);
        rmqEventSigningKeyVersion: (() => number);
        rmqEventSigningKeyVersionsToRevoke: (() => number[]);
        rmqEventSigningPrivateKey: (() => string);
        rmqEventSigningPublicKey: (() => string);
        rmqHost: (() => string);
        rmqMgmtHost: (() => undefined | string);
        rmqMgmtPort: (() => undefined | number);
        rmqMgmtProtocol: (() => undefined | string);
        rmqPassword: (() => string);
        rmqPort: (() => number);
        rmqProtocol: (() => string);
        rmqUser: (() => string);
        rmqVHost: (() => string);
        rmqVHostAssert: (() => boolean);
    }

    The following configuration values are included:

    rmqProtocol // e.g. RABBITMQ_PROTOCOL=amqps
    rmqVHost // e.g. RABBITMQ_VHOST=2rig00smn1o9pq3a_rj3i6f7hj90ap1wc
    rmqHost // e.g. RABBITMQ_HOST=rabbitmq.eu.axinom.net
    rmqPort // e.g. RABBITMQ_PORT=5672
    rmqUser // e.g. RABBITMQ_USER=jXSwOk3FiQxRui39
    rmqPassword // e.g. RABBITMQ_PASSWORD=rk3m5LPHs4m4ALyDy9spsG2X
    rmqDevMiddleware // e.g. RABBITMQ_DEV_MIDDLEWARE=true
    rmqVHostAssert // e.g. RABBITMQ_VHOST_ASSERT=true
    rmqChannelMax // e.g. RABBITMQ_CHANNEL_MAX=100
    rmqMgmtProtocol // e.g. RABBITMQ_MGMT_PROTOCOL=https
    rmqMgmtHost // e.g. RABBITMQ_MGMT_HOST=rabbitmq.eu.axinom.net
    rmqMgmtPort // e.g. RABBITMQ_MGMT_PORT=15672
    rmqEventSigningPrivateKey // e.g. RABBITMQ_EVENT_SIGNING_PRIVATE_KEY=MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tP...
    rmqEventSigningKeyVersion // e.g. RABBITMQ_EVENT_SIGNING_KEY_VERSION=3
    rmqEventSigningPublicKey // e.g. RABBITMQ_EVENT_SIGNING_PUBLIC_KEY=MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE=
    rmqEventSigningKeyVersionsToRevoke // e.g. RABBITMQ_EVENT_SIGNING_KEY_VERSIONS_TO_REVOKE=1,2
    • rmqChannelMax: (() => number)
        • (): number
        • Returns number

          Example

          RABBITMQ_CHANNEL_MAX=100
          
    • rmqDevMiddleware: (() => boolean)
        • (): boolean
        • Returns boolean

          Example

          RABBITMQ_DEV_MIDDLEWARE=true
          
    • rmqEventSigningKeyVersion: (() => number)
        • (): number
        • Returns number

          Example

          RABBITMQ_EVENT_SIGNING_KEY_VERSION=3
          
    • rmqEventSigningKeyVersionsToRevoke: (() => number[])
        • (): number[]
        • Returns number[]

          Example

          RABBITMQ_EVENT_SIGNING_KEY_VERSIONS_TO_REVOKE=1,2
          
    • rmqEventSigningPrivateKey: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_EVENT_SIGNING_PRIVATE_KEY=MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tP...
          
    • rmqEventSigningPublicKey: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_EVENT_SIGNING_PUBLIC_KEY=MEgCQQCo9+BpMRYQ/dL3DS2CyJxRF+j6ctbT3/Qp84+KeFhnii7NT7fELilKUSnxS30WAvQCCo2yU1orfgqr41mM70MBAgMBAAE=
          
    • rmqHost: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_HOST=rabbitmq.eu.axinom.net
          
    • rmqMgmtHost: (() => undefined | string)
        • (): undefined | string
        • Returns undefined | string

          Example

          RABBITMQ_MGMT_HOST=rabbitmq.eu.axinom.net
          
    • rmqMgmtPort: (() => undefined | number)
        • (): undefined | number
        • Returns undefined | number

          Example

          RABBITMQ_MGMT_PORT=15672
          
    • rmqMgmtProtocol: (() => undefined | string)
        • (): undefined | string
        • Returns undefined | string

          Example

          RABBITMQ_MGMT_PROTOCOL=https
          
    • rmqPassword: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_PASSWORD=rk3m5LPHs4m4ALyDy9spsG2X
          
    • rmqPort: (() => number)
        • (): number
        • Returns number

          Example

          RABBITMQ_PORT=5672
          
    • rmqProtocol: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_PROTOCOL=amqps
          
    • rmqUser: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_USER=jXSwOk3FiQxRui39
          
    • rmqVHost: (() => string)
        • (): string
        • Returns string

          Example

          RABBITMQ_VHOST=2rig00smn1o9pq3a_rj3i6f7hj90ap1wc
          
    • rmqVHostAssert: (() => boolean)
        • (): boolean
        • Returns boolean

          Example

          RABBITMQ_VHOST_ASSERT=true
          

Generated using TypeDoc