From 682855f4ca773cb8348a61412a3015b2568ce653 Mon Sep 17 00:00:00 2001 From: james-pre Date: Sat, 5 Oct 2024 16:51:01 +0000 Subject: [PATCH] deploy: 4250d68c54a5f73a54e9f206d81fc20f20260cc5 --- enums/Access.html | 4 ++-- enums/AccountType.html | 10 +++++----- functions/auth.html | 2 +- functions/checkAccountAttribute.html | 2 +- functions/createAccount.html | 2 +- functions/deleteAccount.html | 2 +- functions/disable.html | 2 +- functions/enable.html | 2 +- functions/getAccount.html | 2 +- functions/getAccountNum.html | 2 +- functions/getAccountRole.html | 2 +- functions/getAccounts.html | 2 +- functions/getAllAccounts.html | 2 +- functions/isValidAccountAttribute.html | 2 +- functions/login.html | 2 +- functions/logout.html | 2 +- functions/metadata-1.html | 2 +- functions/request.html | 2 +- functions/stripAccountInfo.html | 2 +- functions/update.html | 2 +- interfaces/Account.html | 22 +++++++++++----------- interfaces/AccountResult.html | 4 ++-- interfaces/FullAccount.html | 22 +++++++++++----------- interfaces/FullAccountResult.html | 4 ++-- interfaces/Metadata.html | 6 +++--- interfaces/Response.html | 10 +++++----- types/UniqueAccountKey.html | 2 +- variables/accountAttributes.html | 2 +- variables/accountRoles.html | 2 +- variables/config.html | 2 +- variables/uniqueAccountAttributes.html | 2 +- 31 files changed, 64 insertions(+), 64 deletions(-) diff --git a/enums/Access.html b/enums/Access.html index abb2b0f..e816909 100644 --- a/enums/Access.html +++ b/enums/Access.html @@ -1,5 +1,5 @@ Access | @blankstorm/api - v0.5.4

Enumeration Access

Access level for information

-

Enumeration Members

PRIVATE +

Enumeration Members

PRIVATE PROTECTED PUBLIC -

Enumeration Members

PRIVATE

PRIVATE: 0

PROTECTED

PROTECTED: 1

PUBLIC

PUBLIC: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

PRIVATE

PRIVATE: 0

PROTECTED

PROTECTED: 1

PUBLIC

PUBLIC: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/AccountType.html b/enums/AccountType.html index 12de50b..80e6341 100644 --- a/enums/AccountType.html +++ b/enums/AccountType.html @@ -1,5 +1,5 @@ AccountType | @blankstorm/api - v0.5.4

Enumeration AccountType

The account's level of access and status

-

Enumeration Members

ACCOUNT +

Enumeration Members

ACCOUNT ADMIN ADMINISTRATOR DEV @@ -8,7 +8,7 @@ MODERATOR OWNER

Enumeration Members

ACCOUNT

ACCOUNT: 0

Standard accounts

-

ADMIN

ADMIN: 3

Alias for ADMINISTRATOR

-

ADMINISTRATOR

ADMINISTRATOR: 3

DEV

DEV: 2

Alias for DEVELOPER

-

DEVELOPER

DEVELOPER: 2

MOD

MOD: 1

Alias for MODERATOR

-

MODERATOR

MODERATOR: 1

OWNER

OWNER: 4

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ADMIN

ADMIN: 3

Alias for ADMINISTRATOR

+

ADMINISTRATOR

ADMINISTRATOR: 3

DEV

DEV: 2

Alias for DEVELOPER

+

DEVELOPER

DEVELOPER: 2

MOD

MOD: 1

Alias for MODERATOR

+

MODERATOR

MODERATOR: 1

OWNER

OWNER: 4

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/auth.html b/functions/auth.html index 49e73a2..3d22bc5 100644 --- a/functions/auth.html +++ b/functions/auth.html @@ -1,3 +1,3 @@ auth | @blankstorm/api - v0.5.4

Function auth

  • auth(token): void

  • Sets the authenication token

    Parameters

    • token: string

      the new token

      -

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/checkAccountAttribute.html b/functions/checkAccountAttribute.html index dae18dd..1a42987 100644 --- a/functions/checkAccountAttribute.html +++ b/functions/checkAccountAttribute.html @@ -1,4 +1,4 @@ checkAccountAttribute | @blankstorm/api - v0.5.4

Function checkAccountAttribute

  • checkAccountAttribute<K>(key, value): void

  • Checks if value is a valid key

    Type Parameters

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createAccount.html b/functions/createAccount.html index aa6c12c..1b58a9c 100644 --- a/functions/createAccount.html +++ b/functions/createAccount.html @@ -3,4 +3,4 @@
  • username: string

    the account's username

  • password: string

    the account's password

    • Returns Promise<Account>

    The created account's data

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/deleteAccount.html b/functions/deleteAccount.html index ef18c07..f92d416 100644 --- a/functions/deleteAccount.html +++ b/functions/deleteAccount.html @@ -1,3 +1,3 @@ deleteAccount | @blankstorm/api - v0.5.4

    Function deleteAccount

    • deleteAccount(id, reason?): Promise<void>

    • Deletes an account (Requires authenication)

      Parameters

      • id: string

        the ID of the account to delete

        -
      • Optional reason: string

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional reason: string

    • Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/disable.html b/functions/disable.html index 214f120..623a6b4 100644 --- a/functions/disable.html +++ b/functions/disable.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<boolean>

    True when successful

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/enable.html b/functions/enable.html index 18886d8..1f27559 100644 --- a/functions/enable.html +++ b/functions/enable.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<boolean>

    True when successful

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getAccount.html b/functions/getAccount.html index f1d20be..cf14b8f 100644 --- a/functions/getAccount.html +++ b/functions/getAccount.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<Account>

    The account's data

    -
  • getAccount(key, value?, access?): Promise<Account>

  • Parameters

    Returns Promise<Account>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • getAccount(key, value?, access?): Promise<Account>

  • Parameters

    Returns Promise<Account>

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getAccountNum.html b/functions/getAccountNum.html index bfa493b..f852c18 100644 --- a/functions/getAccountNum.html +++ b/functions/getAccountNum.html @@ -1,2 +1,2 @@ getAccountNum | @blankstorm/api - v0.5.4

    Function getAccountNum

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<number>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getAccountRole.html b/functions/getAccountRole.html index 47b1c8c..38d93bc 100644 --- a/functions/getAccountRole.html +++ b/functions/getAccountRole.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    the role

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getAccounts.html b/functions/getAccounts.html index 6f40711..86fdd87 100644 --- a/functions/getAccounts.html +++ b/functions/getAccounts.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<Account[]>

    The accounts

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getAllAccounts.html b/functions/getAllAccounts.html index e025b6f..f82141e 100644 --- a/functions/getAllAccounts.html +++ b/functions/getAllAccounts.html @@ -1,3 +1,3 @@ getAllAccounts | @blankstorm/api - v0.5.4

    Function getAllAccounts

    • getAllAccounts(offset?, limit?): Promise<Account[]>

    • Gets info about all account (Requires authorization: Mod)

      Parameters

      • offset: number = 0
      • limit: number = 1000

      Returns Promise<Account[]>

      The accounts

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/isValidAccountAttribute.html b/functions/isValidAccountAttribute.html index 9867859..a2c74fe 100644 --- a/functions/isValidAccountAttribute.html +++ b/functions/isValidAccountAttribute.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns boolean

    whether the value is valid

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/login.html b/functions/login.html index 0aea8e2..df14e26 100644 --- a/functions/login.html +++ b/functions/login.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<Account & {
        token: string;
    }>

    The logged in account's data (includes the token)

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/logout.html b/functions/logout.html index b3e9c20..a5c30f3 100644 --- a/functions/logout.html +++ b/functions/logout.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<boolean>

    True when successful

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/metadata-1.html b/functions/metadata-1.html index b02111f..8646cb7 100644 --- a/functions/metadata-1.html +++ b/functions/metadata-1.html @@ -1,2 +1,2 @@ metadata | @blankstorm/api - v0.5.4

    Function metadata

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<Metadata>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/request.html b/functions/request.html index 3532483..9ea9f0e 100644 --- a/functions/request.html +++ b/functions/request.html @@ -3,4 +3,4 @@
  • endpoint: string

    The API endpoint to send the request to

  • data: object = {}

    The data to include in the request

    • Returns Promise<R>

    a Promise which resolves to the result of the response

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/stripAccountInfo.html b/functions/stripAccountInfo.html index 0af72e8..99c52b7 100644 --- a/functions/stripAccountInfo.html +++ b/functions/stripAccountInfo.html @@ -1,4 +1,4 @@ stripAccountInfo | @blankstorm/api - v0.5.4

    Function stripAccountInfo

    • stripAccountInfo(account, access?): Account

    • Strips private information (e.g. email, password hash, etc.) from an account

      Parameters

      • account: Account

        the account to strip info from

      • access: Access = Access.PUBLIC

      Returns Account

      a new object without the stripped info

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/update.html b/functions/update.html index fb1cc8d..2ceab2e 100644 --- a/functions/update.html +++ b/functions/update.html @@ -4,4 +4,4 @@
  • value: FullAccount[K]

    the new value

  • Optional reason: string

    the reason for the change

    • Returns Promise<Account>

    the updated account data

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Account.html b/interfaces/Account.html index 0bbd604..3ae518e 100644 --- a/interfaces/Account.html +++ b/interfaces/Account.html @@ -1,5 +1,5 @@ Account | @blankstorm/api - v0.5.4

    Interface Account

    Represents an account

    -
    interface Account {
        created: Date;
        email?: string;
        id: string;
        is_disabled: boolean;
        lastchange: Date;
        password?: string;
        session?: string;
        token?: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created +
    interface Account {
        created: Date;
        email?: string;
        id: string;
        is_disabled: boolean;
        lastchange: Date;
        password?: string;
        session?: string;
        token?: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created email? id is_disabled @@ -10,14 +10,14 @@ type username

    Properties

    created

    created: Date

    When the account was created

    -

    Optional email

    email?: string

    The email of the account

    -

    id

    id: string

    The ID of the account

    -

    is_disabled

    is_disabled: boolean

    If the account is currently disabled

    -

    lastchange

    lastchange: Date

    The last time the account's username was changed

    -

    Optional password

    password?: string

    The account's password hash.

    +

    Optional email

    email?: string

    The email of the account

    +

    id

    id: string

    The ID of the account

    +

    is_disabled

    is_disabled: boolean

    If the account is currently disabled

    +

    lastchange

    lastchange: Date

    The last time the account's username was changed

    +

    Optional password

    password?: string

    The account's password hash.

    This is never sent by the server, it is only here for code convience when updating the password.

    -

    Optional session

    session?: string

    The session token of the account

    -

    Optional token

    token?: string

    The login token of the account

    -

    type

    type: AccountType

    The type of the account

    -

    username

    username: string

    The username of the account

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional session

    session?: string

    The session token of the account

    +

    Optional token

    token?: string

    The login token of the account

    +

    type

    type: AccountType

    The type of the account

    +

    username

    username: string

    The username of the account

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/AccountResult.html b/interfaces/AccountResult.html index dffcce3..33ba59e 100644 --- a/interfaces/AccountResult.html +++ b/interfaces/AccountResult.html @@ -1,6 +1,6 @@ AccountResult | @blankstorm/api - v0.5.4

    Interface AccountResult

    The result object of a response representing an account

    See

    Account

    -
    interface AccountResult {
        created: string;
        email?: string;
        id: string;
        is_disabled: boolean;
        lastchange: string;
        session?: string;
        token?: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created +
    interface AccountResult {
        created: string;
        email?: string;
        id: string;
        is_disabled: boolean;
        lastchange: string;
        session?: string;
        token?: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created email? id is_disabled @@ -9,4 +9,4 @@ token? type username -

    Properties

    created

    created: string

    Optional email

    email?: string

    id

    id: string

    is_disabled

    is_disabled: boolean

    lastchange

    lastchange: string

    Optional session

    session?: string

    Optional token

    token?: string

    type

    type: AccountType

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    created

    created: string

    Optional email

    email?: string

    id

    id: string

    is_disabled

    is_disabled: boolean

    lastchange

    lastchange: string

    Optional session

    session?: string

    Optional token

    token?: string

    type

    type: AccountType

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/FullAccount.html b/interfaces/FullAccount.html index 0f891e7..f572726 100644 --- a/interfaces/FullAccount.html +++ b/interfaces/FullAccount.html @@ -1,5 +1,5 @@ FullAccount | @blankstorm/api - v0.5.4

    Interface FullAccount

    Represents an account with all data (i.e. sensitive information must be included)

    -
    interface FullAccount {
        created: Date;
        email: string;
        id: string;
        is_disabled: boolean;
        lastchange: Date;
        password?: string;
        session: string;
        token: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created +
    interface FullAccount {
        created: Date;
        email: string;
        id: string;
        is_disabled: boolean;
        lastchange: Date;
        password?: string;
        session: string;
        token: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created email id is_disabled @@ -10,14 +10,14 @@ type username

    Properties

    created

    created: Date

    When the account was created

    -

    email

    email: string

    The email of the account

    -

    id

    id: string

    The ID of the account

    -

    is_disabled

    is_disabled: boolean

    If the account is currently disabled

    -

    lastchange

    lastchange: Date

    The last time the account's username was changed

    -

    Optional password

    password?: string

    The account's password hash.

    +

    email

    email: string

    The email of the account

    +

    id

    id: string

    The ID of the account

    +

    is_disabled

    is_disabled: boolean

    If the account is currently disabled

    +

    lastchange

    lastchange: Date

    The last time the account's username was changed

    +

    Optional password

    password?: string

    The account's password hash.

    This is never sent by the server, it is only here for code convience when updating the password.

    -

    session

    session: string

    The session token of the account

    -

    token

    token: string

    The login token of the account

    -

    type

    type: AccountType

    The type of the account

    -

    username

    username: string

    The username of the account

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    session

    session: string

    The session token of the account

    +

    token

    token: string

    The login token of the account

    +

    type

    type: AccountType

    The type of the account

    +

    username

    username: string

    The username of the account

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/FullAccountResult.html b/interfaces/FullAccountResult.html index 32778f4..9e32257 100644 --- a/interfaces/FullAccountResult.html +++ b/interfaces/FullAccountResult.html @@ -1,6 +1,6 @@ FullAccountResult | @blankstorm/api - v0.5.4

    Interface FullAccountResult

    The result object of a response representing an account with all data

    See

    FullAccount

    -
    interface FullAccountResult {
        created: string;
        email: string;
        id: string;
        is_disabled: boolean;
        lastchange: string;
        session: string;
        token: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created +
    interface FullAccountResult {
        created: string;
        email: string;
        id: string;
        is_disabled: boolean;
        lastchange: string;
        session: string;
        token: string;
        type: AccountType;
        username: string;
    }

    Hierarchy (view full)

    Properties

    created email id is_disabled @@ -9,4 +9,4 @@ token type username -

    Properties

    created

    created: string

    email

    email: string

    id

    id: string

    is_disabled

    is_disabled: boolean

    lastchange

    lastchange: string

    session

    session: string

    token

    token: string

    type

    type: AccountType

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    created

    created: string

    email

    email: string

    id

    id: string

    is_disabled

    is_disabled: boolean

    lastchange

    lastchange: string

    session

    session: string

    token

    token: string

    type

    type: AccountType

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Metadata.html b/interfaces/Metadata.html index 2cffdaf..241bebf 100644 --- a/interfaces/Metadata.html +++ b/interfaces/Metadata.html @@ -1,5 +1,5 @@ -Metadata | @blankstorm/api - v0.5.4

    Interface Metadata

    interface Metadata {
        debug: boolean;
        version: string;
    }

    Properties

    debug +Metadata | @blankstorm/api - v0.5.4

    Interface Metadata

    interface Metadata {
        debug: boolean;
        version: string;
    }

    Properties

    debug version

    Properties

    debug

    debug: boolean

    Whether the API has debug features enabled

    -

    version

    version: string

    Current API version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    version

    version: string

    Current API version

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Response.html b/interfaces/Response.html index 9603a71..dbe96ca 100644 --- a/interfaces/Response.html +++ b/interfaces/Response.html @@ -1,11 +1,11 @@ Response | @blankstorm/api - v0.5.4

    Interface Response<Result>

    A response to an API request

    -
    interface Response<Result> {
        error: boolean;
        result: Result;
        status: number;
        statusText: string;
    }

    Type Parameters

    • Result

    Properties

    error +
    interface Response<Result> {
        error: boolean;
        result: Result;
        status: number;
        statusText: string;
    }

    Type Parameters

    • Result

    Properties

    error result status statusText

    Properties

    error

    error: boolean

    Whether the request failed (true) or not (false)

    -

    result

    result: Result

    The result of the request.

    +

    result

    result: Result

    The result of the request.

    Remarks

    If the request fails, result will contain the error message

    -

    status

    status: number

    The HTTP status of the response

    -

    statusText

    statusText: string

    The HTTP status' text

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    status

    status: number

    The HTTP status of the response

    +

    statusText

    statusText: string

    The HTTP status' text

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/UniqueAccountKey.html b/types/UniqueAccountKey.html index 4de6d9c..cb5715c 100644 --- a/types/UniqueAccountKey.html +++ b/types/UniqueAccountKey.html @@ -1 +1 @@ -UniqueAccountKey | @blankstorm/api - v0.5.4

    Type alias UniqueAccountKey

    UniqueAccountKey: "id" | "email" | "username" | "token" | "session"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +UniqueAccountKey | @blankstorm/api - v0.5.4

    Type alias UniqueAccountKey

    UniqueAccountKey: "id" | "email" | "username" | "token" | "session"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/accountAttributes.html b/variables/accountAttributes.html index 3bd0f45..0336b1a 100644 --- a/variables/accountAttributes.html +++ b/variables/accountAttributes.html @@ -1 +1 @@ -accountAttributes | @blankstorm/api - v0.5.4

    Variable accountAttributesConst

    accountAttributes: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +accountAttributes | @blankstorm/api - v0.5.4

    Variable accountAttributesConst

    accountAttributes: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/accountRoles.html b/variables/accountRoles.html index bc27d3e..46d0017 100644 --- a/variables/accountRoles.html +++ b/variables/accountRoles.html @@ -1,2 +1,2 @@ accountRoles | @blankstorm/api - v0.5.4

    Variable accountRolesConst

    accountRoles: {
        [key in AccountType]: string
    } & string[] = ...

    The roles of account types

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/config.html b/variables/config.html index 7dcc837..89055bf 100644 --- a/variables/config.html +++ b/variables/config.html @@ -1,3 +1,3 @@ config | @blankstorm/api - v0.5.4

    Variable configConst

    config: {
        throw_errors: boolean;
        url: string;
    } = ...

    Type declaration

    • throw_errors: boolean

      Whether to throw an error on erroneous responses

    • url: string

      The base API URL

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/uniqueAccountAttributes.html b/variables/uniqueAccountAttributes.html index 8070bec..5c03a82 100644 --- a/variables/uniqueAccountAttributes.html +++ b/variables/uniqueAccountAttributes.html @@ -1 +1 @@ -uniqueAccountAttributes | @blankstorm/api - v0.5.4

    Variable uniqueAccountAttributesConst

    uniqueAccountAttributes: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +uniqueAccountAttributes | @blankstorm/api - v0.5.4

    Variable uniqueAccountAttributesConst

    uniqueAccountAttributes: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file