@salesforce/core
    Preparing search index...

    Hierarchy (View Summary)

    Index
    • Constructs a new AsyncCreatable instance. For internal and subclass use only. New subclass instances must be created with the static create method.

      Parameters

      • Optionaloptions: object

        An options object providing initialization params.

      Returns SandboxAccessor

    • 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<SandboxFields>>

    • 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<SandboxFields>>