Class ConnectionConfig

chrisURLfile

chrisURLfilepath

ReadonlyconfigDir

ReadonlycurrentDirectory

debug

tokenFile

tokenFilepath

userChRISContextDir

userContextDir

userFile

userFilepath

storage

• get storage(): IStorageProvider

  Returns IStorageProvider

chrisURL_load

• chrisURL_load(): Promise<string | null>

  Load the saved ChRIS URL from storage.

  Returns Promise<string | null>

  The URL or null if not found.

chrisURL_save

• chrisURL_save(url: string): Promise<boolean>

  Save the ChRIS URL to storage.

  Parameters

  • url: string

    The URL to save.

  Returns Promise<boolean>

  True if successful, false otherwise.

context_set

• context_set(user: string, url?: string): Promise<void>

  Set the current user and ChRIS URL context.

  Parameters

  • user: string

    The username.

  • Optionalurl: string

    Optional ChRIS URL.

  Returns Promise<void>

dir_convertToUri

• dir_convertToUri(dir: string): string

  Convert a directory-safe string back to a URI.

  Parameters

  • dir: string

    The directory name to convert.

  Returns string

  The reconstructed URI.

  Throws

  Error if the directory name format is invalid.

init

• init(): Promise<void>

  Initialize the connection configuration. Loads last user and ChRIS URL from storage.

  Returns Promise<void>

lastUser_load

• lastUser_load(): Promise<string | null>

  Load the last logged-in user from storage.

  Returns Promise<string | null>

  The username or null if not found.

lastUser_save

• lastUser_save(user: string): Promise<boolean>

  Save the last logged-in user to storage.

  Parameters

  • user: string

    The username to save.

  Returns Promise<boolean>

  True if successful, false otherwise.

uri_convertToDir

• uri_convertToDir(uri: string): string

  Convert a URI to a directory-safe string.

  Parameters

  • uri: string

    The URI to convert.

  Returns string

  A string safe for use as a directory name.

Staticinstance_get

• instance_get(
      storageProvider: IStorageProvider,
      options?: ConnectionConfigOptions,
  ): Promise<ConnectionConfig>

  Get the singleton instance of ConnectionConfig.

  Parameters

  • storageProvider: IStorageProvider

    The storage provider to use.

  • Optionaloptions: ConnectionConfigOptions

    Optional configuration options.

  Returns Promise<ConnectionConfig>

  A promise resolving to the ConnectionConfig instance.