@salesforce/core
    Preparing search index...

    Class BaseOrgAccessor<T, P>Abstract

    Type Parameters

    Hierarchy (View Summary)

    Index
    • Returns true if there is an auth file for the given username. The read or readAll methods must be called first in order to populate the cache.

      Parameters

      • username: string

      Returns Promise<boolean>

    • Parameters

      • username: string

        username to get

      • Optionaldecrypt: boolean

        if true, decrypt encrypted values

      • OptionalthrowOnNotFound: true

        if true, throw if the auth file does not already exist in the cache

      Returns P

    • Return the contents of all the auth files from cache. The read or readAll methods must be called first in order to populate the cache.

      Parameters

      • decrypt: boolean = false

        if true, decrypt encrypted values

      Returns P[]

    • Return the absolute path to the auth file for a given username. Does not require the file to have been read (resolves purely from the username and the global state directory).

      Parameters

      • username: string

      Returns string

    • Read the current on-disk contents of a username's auth file WITHOUT mutating the cache (unlike read, which replaces the cached config/contents). Use this to inspect what another process has persisted without disturbing this instance's in-memory state. Returns null if the file can't be read.

      Parameters

      • username: string

        username to read

      • decrypt: boolean = false

        if true, decrypt encrypted values

      Returns Promise<Nullable<P>>

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      Parameters

      • username: string

        username to read

      • decrypt: boolean = false

        if true, decrypt encrypted values

      • throwOnNotFound: boolean = true

        throw if file is not found for username

      Returns Promise<Nullable<P>>

    • Read all the auth files under the global state directory

      Parameters

      • decrypt: boolean = false

        if true, decrypt encrypted values

      Returns Promise<P[]>

    • Return the file stats for a given userame's auth file.

      Parameters

      • username: string

      Returns Promise<Nullable<Stats | BigIntStats | undefined>>