Triangle.js Docs
    Preparing search index...

    Function users

    • Parameters

      • get: <T = any>(
            __namedParameters: {
                headers?: Record<string, string>;
                json?: boolean;
                token?: string | null;
                uri: string;
            },
        ) => Promise<Res<T>>
      • post: <T = any>(
            __namedParameters: {
                body: Record<string, any>;
                headers?: Record<string, string>;
                json?: boolean;
                token?: string | null;
                uri: string;
            },
        ) => 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 }>
      • exists: (username: string) => Promise<boolean>

        Checks whether a user exists

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

        Get a user's profile

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

        Resolves a username to a user ID

    Settings

    Member Visibility