obby-client for TypeScript
    Preparing search index...

    Type Alias SaslCredentials

    SaslCredentials:
        | { mechanism: "plain"; password: string; username: string }
        | { mechanism: "external" }
        | { mechanism: "scram"; nonce: string; password: string; username: string }

    What to authenticate with.

    Type Declaration

    • { mechanism: "plain"; password: string; username: string }
      • mechanism: "plain"
      • password: string

        Its password.

      • username: string

        The account to log in as.

    • { mechanism: "external" }
    • { mechanism: "scram"; nonce: string; password: string; username: string }
      • mechanism: "scram"
      • nonce: string

        Unpredictable bytes, never reused. The core has no entropy source, so the host supplies this, and reusing one destroys the replay protection the mechanism exists for.

      • password: string

        Its password.

      • username: string

        The account to log in as.