Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpenOptions

Hierarchy

  • OpenOptions

Index

Properties

Properties

Optional agent

agent?: string

An identifier for this client connection which may be used by the WAMP server for logging purposes

Optional auth

auth?: { authId: string; authMethods: string[]; onChallenge: any }

Optional authentication data

If this is not defined then the library will try to authenticate using the anonymous authMethod. Omit this if you only need anonymous access.

Type declaration

  • authId: string

    The username or ID to authenticate as.

    This value depends on the authMethods selected and the settings of your WAMP server.

  • authMethods: string[]

    Could be values like anonymous, ticket, cookie, etc.

    Refer to your WAMP server's settings to find out which auth methods are supported.

  • onChallenge:function
    • onChallenge(authMethod: string): string | Promise<string>

    • Handle authentication challenge from the WAMP server.

      Depending on the auth method requested by the server, this could return things like the password of the user we are trying to authenticate as.

      Parameters

      • authMethod: string

      Returns string | Promise<string>

realm

realm: string

The realm to connect to on the WAMP server

Optional uriBase

uriBase?: string

This string will be prepended to all of your URI cased WAMP operations. This can be a convenient way to shorten the WAMP URIs by defining the common part of the WAMP URIs here.

The final URI that gets used for communicating with the WAMP server ends up being {uriBase}.{URI of operation}.

It is also possible to disable the use of uriBase for a given WAMP operation by setting the withoutUriBase option for the operations that support that option

example

Setting this to com.company.something will allow you to shorten a call() to com.company.something.my.fancy_registration down to a call() to my.fancy_registration

Generated using TypeDoc