Interface IStoringSystem<TUser>

The contract of a storing service.

Export

IStoringSystem

interface IStoringSystem<TUser> {
    read(userid): Promise<undefined | null | TUser>;
    readBy(filters): Promise<undefined | null | TUser>;
    readBy(callback): Promise<undefined | null | TUser>;
    readBy(argument): Promise<undefined | null | TUser>;
    write(user): Promise<void>;
}

Type Parameters

Methods

read readBy write

Methods

read

  • read(userid): Promise<undefined | null | TUser>

  • Reads the storing system to get the user based on its unique identifier.

    Parameters

    • userid: string

    Returns Promise<undefined | null | TUser>

    the user or nothing

    Memberof

    IStoringSystem

readBy

  • readBy(filters): Promise<undefined | null | TUser>

  • Reads the storing system to get the user based on filters.

    Parameters

    • filters: Map<string, any>

    Returns Promise<undefined | null | TUser>

    the user or nothing

    Memberof

    IStoringSystem

  • readBy(callback): Promise<undefined | null | TUser>

  • Parameters

    • callback: ((user, index) => boolean)
        • (user, index): boolean

        • Parameters

          • user: TUser
          • index: string | number

          Returns boolean

    Returns Promise<undefined | null | TUser>

  • readBy(argument): Promise<undefined | null | TUser>

  • Parameters

    • argument: Map<string, any> | ((user, index) => boolean)

    Returns Promise<undefined | null | TUser>

write

  • write(user): Promise<void>

  • Writes a user into the storing system.

    Parameters

    Returns Promise<void>

    Memberof

    IStoringSystem

Settings

Member Visibility

Theme

On This Page

readreadBywrite