Function users

  • users(get, post, __): {
        authenticate: ((username: string, password: string) => Promise<{
            id: string;
            token: string;
        }>);
        exists: ((username: string) => Promise<boolean>);
        get: ((options: {
            username: string;
        } | {
            id: string;
        }) => Promise<Utils.APITypes.Users.User>);
        me: (() => Promise<Me>);
        resolve: ((username: string) => Promise<string>);
    }

  • Parameters

    • get: (<T>(__namedParameters: {
          headers?: Record<string, string>;
          json?: boolean;
          token?: null | string;
          uri: string;
      }) => Promise<Res<T>>)
        • <T>(__namedParameters): Promise<Res<T>>

        • Type Parameters

          • T = any

          Parameters

          • __namedParameters: {
                headers?: Record<string, string>;
                json?: boolean;
                token?: null | string;
                uri: string;
            }
            • Optionalheaders?: Record<string, string>
            • Optionaljson?: boolean
            • Optionaltoken?: null | string
            • uri: string

          Returns Promise<Res<T>>

    • post: (<T>(__namedParameters: {
          body: Record<string, any>;
          headers?: Record<string, string>;
          json?: boolean;
          token?: string;
          uri: string;
      }) => Promise<Res<T>>)
        • <T>(__namedParameters): Promise<Res<T>>

        • Type Parameters

          • T = any

          Parameters

          • __namedParameters: {
                body: Record<string, any>;
                headers?: Record<string, string>;
                json?: boolean;
                token?: string;
                uri: string;
            }
            • body: Record<string, any>
            • Optionalheaders?: Record<string, string>
            • Optionaljson?: boolean
            • Optionaltoken?: string
            • uri: string

          Returns Promise<Res<T>>

    • __: APIDefaults

    Returns {
        authenticate: ((username: string, password: string) => Promise<{
            id: string;
            token: string;
        }>);
        exists: ((username: string) => Promise<boolean>);
        get: ((options: {
            username: string;
        } | {
            id: string;
        }) => Promise<Utils.APITypes.Users.User>);
        me: (() => Promise<Me>);
        resolve: ((username: string) => Promise<string>);
    }

    • authenticate: ((username: string, password: string) => Promise<{
          id: string;
          token: string;
      }>)
        • (username, password): Promise<{
              id: string;
              token: string;
          }>

        • Parameters

          • username: string
          • password: string

          Returns Promise<{
              id: string;
              token: string;
          }>

    • exists: ((username: string) => Promise<boolean>)

      Checks whether a user exists

        • (username): Promise<boolean>

        • Checks whethere a user exists

          Parameters

          • username: string

          Returns Promise<boolean>

    • get: ((options: {
          username: string;
      } | {
          id: string;
      }) => Promise<Utils.APITypes.Users.User>)

      Get a user's profile

    • me: (() => Promise<Me>)
        • (): Promise<Me>

        • Returns Promise<Me>

    • resolve: ((username: string) => Promise<string>)
        • (username): Promise<string>

        • Resolves a username to a user ID

          Parameters

          • username: string

          Returns Promise<string>

Settings

Member Visibility