@hunteroi/discord-verification
    Preparing search index...

    Interface IStoringSystem<TUser>

    The contract of a storing service.

    IStoringSystem

    interface IStoringSystem<TUser extends IUser> {
        read(userid: string): Promise<undefined | null | TUser>;
        readBy(filters: Map<string, any>): Promise<undefined | null | TUser>;
        readBy(
            callback: (user: TUser, index: string | number) => boolean,
        ): Promise<undefined | null | TUser>;
        readBy(
            argument:
                | Map<string, any>
                | ((user: TUser, index: string | number) => boolean),
        ): Promise<undefined | null | TUser>;
        write(user: TUser): Promise<void>;
    }

    Type Parameters

    Index

    Methods

    read readBy write

    Methods

    • 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

      IStoringSystem

    • 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

      IStoringSystem

    • Parameters

      • callback: (user: TUser, index: string | number) => boolean

      Returns Promise<undefined | null | TUser>

    • Parameters

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

      Returns Promise<undefined | null | TUser>

    Settings

    Member Visibility

    On This Page

    Methods