any2orca API reference
    Preparing search index...

    Interface ProfileSource

    Raw access to a catalog. Both methods return parsed JSON; the core validates it.

    interface ProfileSource {
        readIndex(): Promise<unknown>;
        readProfile(id: string): Promise<unknown>;
        release?(path: string): ProfileSource;
    }
    Index
    readIndex readProfile release?

    • The catalog index (index.json).

      Returns Promise<unknown>

    • One profile file (profiles/<id>.json). Only called with an id the index lists.

      Parameters

      • id: string

      Returns Promise<unknown>

    • The source for an older release this catalog holds, in the folder at path (from index.json releases, always releases/<version>). Only called with a path that passes isReleasePath. Leave it out for a catalog with one release.

      Parameters

      • path: string

      Returns ProfileSource

    Settings

    On This Page
    Methods