Interface SolidDataClientOptions

interface SolidDataClientOptions {
    authServer?: Express | SolidAuthServerOptions;
    autoLogin?: boolean;
    clientId?: string;
    clientName?: string;
    clientSecret?: string;
    dataServiceDriver?: DataServiceDriver<string, string>;
    defaultOidcIssuer?: string;
    loginErrorCallback?: ((req, res, sessionInfo, reason) => void);
    loginPath?: string;
    loginSuccessCallback?: ((req, res, sessionInfo) => void);
    redirectPath?: string;
    redirectUrl?: string;
}

Hierarchy (view full)

Properties

authServer? autoLogin? clientId? clientName? clientSecret? dataServiceDriver? defaultOidcIssuer? loginErrorCallback? loginPath? loginSuccessCallback? redirectPath? redirectUrl?

Properties

Optional authServer

authServer?: Express | SolidAuthServerOptions

Optional autoLogin

autoLogin?: boolean

Automatically login after starting the server

Default

false

Optional clientId

clientId?: string

Client identifier

Optional clientName

clientName?: string

Client name displayed to the user

Optional clientSecret

clientSecret?: string

Client secret

Optional dataServiceDriver

dataServiceDriver?: DataServiceDriver<string, string>

Data service driver to use for key:value pairs In a browser this should be @openhps/localstorage

Optional defaultOidcIssuer

defaultOidcIssuer?: string

Optional loginErrorCallback

loginErrorCallback?: ((req, res, sessionInfo, reason) => void)

Type declaration

    • (req, res, sessionInfo, reason): void

    • Parameters

      • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
      • res: Response<any, Record<string, any>>
      • sessionInfo: ISessionInfo
      • reason: any

      Returns void

Optional loginPath

loginPath?: string

Optional loginSuccessCallback

loginSuccessCallback?: ((req, res, sessionInfo) => void)

Type declaration

    • (req, res, sessionInfo): void

    • Parameters

      • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
      • res: Response<any, Record<string, any>>
      • sessionInfo: ISessionInfo

      Returns void

Optional redirectPath

redirectPath?: string

Optional redirectUrl

redirectUrl?: string

Redirect URL

Settings

Member Visibility

Theme

On This Page

authServerautoLoginclientIdclientNameclientSecretdataServiceDriverdefaultOidcIssuerloginErrorCallbackloginPathloginSuccessCallbackredirectPathredirectUrl