Class BaseOrgAccessor<T, P>Abstract

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

exists get getAll has hasFile list read readAll remove set stat update write

Constructors

constructor

  • new BaseOrgAccessor<T, P>(options?): BaseOrgAccessor<T, P>

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

    Type Parameters

    Parameters

    • Optionaloptions: object

      An options object providing initialization params.

    Returns BaseOrgAccessor<T, P>

Methods

exists

  • exists(username): Promise<boolean>

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

get

  • get(username, decrypt?, throwOnNotFound?): P

  • 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

getAll

  • getAll(decrypt?): 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[]

has

hasFile

list

read

  • read(username, decrypt?, throwOnNotFound?): 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>>

readAll

remove

set

stat

  • stat(username): Promise<Nullable<Stats | BigIntStats>>

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

    Parameters

    • username: string

    Returns Promise<Nullable<Stats | BigIntStats>>

update

write

Settings

Member Visibility

On This Page

Constructors
Methods