Class UserResource

User resource for managing user-related API operations

Example: Basic usage

const user = await client.users.getMe();
const userByTag = await client.users.getByTag('rastgame');

Hierarchy

BaseResource
- UserResource

Index

Constructors

constructor

new UserResource(client: REST): UserResource
Creates a new user resource instance
Parameters
- client: REST
  REST client instance
Returns UserResource
Overrides BaseResource.constructor
- Defined in packages/rest/src/resources/UserResource.ts:21

Properties

`Protected` `Readonly`client

client: REST

Methods

`Protected`buildPaginatedEndpoint

buildPaginatedEndpoint(
    baseEndpoint: string,
    page?: number,
    limit?: number,
): string
Build paginated endpoint URL
Parameters
- baseEndpoint: string
  Base endpoint
- Optionalpage: number
  Page number
- Optionallimit: number
  Items per page
Returns string
Formatted endpoint with pagination
Inherited from BaseResource.buildPaginatedEndpoint
- Defined in packages/rest/src/resources/BaseResource.ts:85

getByTag

getByTag(tag: string, config?: RequestConfig): Promise<User>
Get user information by tag
Parameters
- tag: string
  User tag (without @ symbol)
- Optionalconfig: RequestConfig
  Request configuration
Returns Promise<User>
Promise resolving to user data
Example
```
const user = await client.users.getByTag('rastgame');
console.log(`User: ${user.name} (@${user.tag})`);
```
Throws
When user not found or access denied
- Defined in packages/rest/src/resources/UserResource.ts:57

getFriends

getFriends(tag: string, page: number): Promise<User[]>
Отримати друзів користувача
Parameters
- tag: string
  Тег користувача
- page: number
  Номер сторінки
Returns Promise<User[]>
Список друзів
- Defined in packages/rest/src/resources/UserResource.ts:106

getIncomingRequests

getIncomingRequests(page: number): Promise<User[]>
Отримати вхідні запити на дружбу
Parameters
- page: number
  Номер сторінки
Returns Promise<User[]>
Список запитів
- Defined in packages/rest/src/resources/UserResource.ts:115

getMe

getMe(config?: RequestConfig): Promise<User>
Get current authenticated user information
Parameters
- Optionalconfig: RequestConfig
Returns Promise<User>
Promise resolving to current user data
Example
```
const user = await client.users.getMe();
console.log(`Logged in as: ${user.name}`);
```
Throws
When authentication fails or user not found
- Defined in packages/rest/src/resources/UserResource.ts:38

getOutgoingRequests

getOutgoingRequests(page: number): Promise<User[]>
Отримати вихідні запити на дружбу
Parameters
- page: number
  Номер сторінки
Returns Promise<User[]>
Список запитів
- Defined in packages/rest/src/resources/UserResource.ts:124

getPhotos

getPhotos(
    tag: string,
    options?: { mode?: 0 | 1 | 2; page?: number },
    config?: RequestConfig,
): Promise<Photo[]>
Get user photos with pagination and filtering
Parameters
- tag: string
  User tag
- options: { mode?: 0 | 1 | 2; page?: number } = {}
  Photo retrieval options
  - Optionalmode?: 0 | 1 | 2
    Photo visibility mode (0: all, 1: public, 2: private)
  - Optionalpage?: number
    Page number (default: 0)
- Optionalconfig: RequestConfig
  Request configuration
Returns Promise<Photo[]>
Promise resolving to array of photos
Example
```
// Get first page of all photos
const photos = await client.users.getPhotos('rastgame');

// Get public photos from page 2
const publicPhotos = await client.users.getPhotos('rastgame', { 
  page: 2, 
  mode: 1 
});
```
- Defined in packages/rest/src/resources/UserResource.ts:86

getRelationships

getRelationships(tag: string): Promise<any>
Отримати відносини з користувачем
Parameters
- tag: string
  Тег користувача
Returns Promise<any>
Дані про відносини
- Defined in packages/rest/src/resources/UserResource.ts:142

ignoreIncomingRequest

ignoreIncomingRequest(userId: number): Promise<any>
Ігнорувати вхідний запит на дружбу
Parameters
- userId: number
  ID користувача
Returns Promise<any>
Результат операції
- Defined in packages/rest/src/resources/UserResource.ts:133

`Protected`request

request<T>(
    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE",
    endpoint: string,
    data?: any,
    config?: RequestConfig,
): Promise<T>
Execute request with automatic error handling and type safety
Type Parameters
- T
Parameters
- method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
  HTTP method
- endpoint: string
  API endpoint
- Optionaldata: any
  Request data
- Optionalconfig: RequestConfig
  Request configuration
Returns Promise<T>
Promise resolving to typed response
Inherited from BaseResource.request
- Defined in packages/rest/src/resources/BaseResource.ts:106

subscribeFriends

subscribeFriends(tag: string): Promise<any>
Підписатися на друзів користувача
Parameters
- tag: string
  Тег користувача
Returns Promise<any>
Результат підписки
- Defined in packages/rest/src/resources/UserResource.ts:151

`Protected`validateConstraints

validateConstraints(
    value: any,
    constraints: {
        enum?: any[];
        max?: number;
        maxLength?: number;
        min?: number;
        minLength?: number;
        pattern?: RegExp;
    },
    paramName: string,
): void
Validate parameter constraints
Parameters
- value: any
  Value to validate
- constraints: {
      enum?: any[];
      max?: number;
      maxLength?: number;
      min?: number;
      minLength?: number;
      pattern?: RegExp;
  }
  Validation constraints
- paramName: string
  Parameter name for error messages
Returns void
Inherited from BaseResource.validateConstraints
- Defined in packages/rest/src/resources/BaseResource.ts:40

`Protected`validateRequired

validateRequired(params: Record<string, any>, required: string[]): void
Validate required parameters
Parameters
- params: Record<string, any>
  Parameters to validate
- required: string[]
  Required parameter names
Returns void
Throws
If any required parameter is missing
Inherited from BaseResource.validateRequired
- Defined in packages/rest/src/resources/BaseResource.ts:26

Class UserResource

Example: Basic usage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserResource

Properties

Protected Readonlyclient

Methods

ProtectedbuildPaginatedEndpoint

Parameters

Returns string

getByTag

Parameters

Returns Promise<User>

Example

Throws

getFriends

Parameters

Returns Promise<User[]>

getIncomingRequests

Parameters

Returns Promise<User[]>

getMe

Parameters

Returns Promise<User>

Example

Throws

getOutgoingRequests

Parameters

Returns Promise<User[]>

getPhotos

Parameters

Optionalmode?: 0 | 1 | 2

Optionalpage?: number

Returns Promise<Photo[]>

Example

getRelationships

Parameters

Returns Promise<any>

ignoreIncomingRequest

Parameters

Returns Promise<any>

Protectedrequest

Type Parameters

Parameters

Returns Promise<T>

subscribeFriends

Parameters

Returns Promise<any>

ProtectedvalidateConstraints

Parameters

Returns void

ProtectedvalidateRequired

Parameters

Returns void

Throws

Settings

On This Page

`Protected` `Readonly`client

`Protected`buildPaginatedEndpoint

`Optional`mode?: 0 | 1 | 2

`Optional`page?: number

`Protected`request

`Protected`validateConstraints

`Protected`validateRequired