Function makeLoginResponse

  • Generate a login response mixing in the supplied overrides to the default login response.

    Returns

    The merged login response.

    Parameters

    • overrides: Partial<{
          controller-tag: string;
          facades: {
              name: string;
              versions: number[];
          }[];
          model-tag: string;
          server-version: string;
          user-info: {
              controller-access: string;
              credentials: string;
              display-name: string;
              identity: string;
              last-connection: string;
              model-access: string;
          };
      }>

      The response to be returned during the juju login over the WebSocket. The object value provided here will be merged with the default response allowing you to provide custom values for top level keys like 'facades'.

    Returns {
        response: {
            controller-tag: string;
            facades: {
                name: string;
                versions: number[];
            }[];
            model-tag: string;
            server-version: string;
            user-info: {
                controller-access: string;
                credentials: string;
                display-name: string;
                identity: string;
                last-connection: string;
                model-access: string;
            };
        } & Partial<{
            controller-tag: string;
            facades: {
                name: string;
                versions: number[];
            }[];
            model-tag: string;
            server-version: string;
            user-info: {
                controller-access: string;
                credentials: string;
                display-name: string;
                identity: string;
                last-connection: string;
                model-access: string;
            };
        }>;
    }

    • response: {
          controller-tag: string;
          facades: {
              name: string;
              versions: number[];
          }[];
          model-tag: string;
          server-version: string;
          user-info: {
              controller-access: string;
              credentials: string;
              display-name: string;
              identity: string;
              last-connection: string;
              model-access: string;
          };
      } & Partial<{
          controller-tag: string;
          facades: {
              name: string;
              versions: number[];
          }[];
          model-tag: string;
          server-version: string;
          user-info: {
              controller-access: string;
              credentials: string;
              display-name: string;
              identity: string;
              last-connection: string;
              model-access: string;
          };
      }>

Settings

Member Visibility

Theme

Generated using TypeDoc