Yurba.js

Appearance

Yurba.js / @yurbajs/rest / UserResource

Class: UserResource ​

User Core ​

find() ​

find(payload, page): Promise<User[]>

Find users

Parameters ​

payload ​

FindUserPayload

Search filters

page ​

number = 0

Page number (default 0)

Returns ​

Promise<User[]>

User list

Since ​

1.0.0

Deprecated ​

Use rest.search.users() instead

Example ​

javascript
// Use rest.search.users() instead
const users = await rest.search.users({
  sort: 0,
  country: 0,
  region: 0,
  city: 0,
  worksAt: "",
  relationships: 0,
  online: 0,
  avatar: 0
});

User Friends ​

friends() ​

friends(page): Promise<User[]>

Gets current user's friends

Parameters ​

page ​

number = 0

Page number (default 0)

Returns ​

Promise<User[]>

Array of User objects

Since ​

1.0.0

Throws ​

If user not found in cache

Example ​

javascript
const friends = await rest.users.friends();
const nextPage = await rest.users.friends(1);

getFriends() ​

getFriends(user, page): Promise<User[]>

Gets user friends

Parameters ​

user ​

User ({tag}/{id}/u{id})

string | number

page ​

number

Page number

Returns ​

Promise<User[]>

Array of User objects

Since ​

1.0.0

Throws ​

If parameters are invalid

Example ​

javascript
const friends = await rest.users.getFriends('username', 0);
const friendsById = await rest.users.getFriends(12345, 1);

getRelationships() ​

getRelationships(user): Promise<RelationshipsResult>

Gets user relationships

Parameters ​

user ​

User ({tag}/{id}/u{id})

string | number

Returns ​

Promise<RelationshipsResult>

Relationships data

Since ​

1.0.0

Throws ​

If user identifier is invalid

Example ​

javascript
const relationships = await rest.users.getRelationships('username');

ignoreIncomingRequest() ​

ignoreIncomingRequest(userId): Promise<BaseOkay>

Ignores incoming friend request

Parameters ​

userId ​

number

User identifier

Returns ​

Promise<BaseOkay>

Operation result

Since ​

1.0.0

Throws ​

If user ID is invalid

Example ​

javascript
await rest.users.ignoreIncomingRequest(12345);

incomingRequests() ​

incomingRequests(page): Promise<User[]>

Gets incoming friend requests

Parameters ​

page ​

number = 0

Page number

Returns ​

Promise<User[]>

Array of User objects

Since ​

1.0.0

Throws ​

If page number is invalid

Example ​

javascript
const requests = await rest.users.incomingRequests();
const nextPage = await rest.users.incomingRequests(1);

outgoingRequests() ​

outgoingRequests(page): Promise<User[]>

Gets outgoing friend requests

Parameters ​

page ​

number = 0

Page number

Returns ​

Promise<User[]>

Array of User objects

Since ​

1.0.0

Throws ​

If page number is invalid

Example ​

javascript
const requests = await rest.users.outgoingRequests();
const nextPage = await rest.users.outgoingRequests(1);

subscribe() ​

subscribe(user): Promise<RelationshipsResult>

Subscribe to user

Parameters ​

user ​

User ({tag}/{id}/u{id})

string | number

Returns ​

Promise<RelationshipsResult>

RelationshipsResult Subscribe result

Since ​

1.0.0

Throws ​

If user identifier is invalid

Example ​

javascript
const result = await rest.users.subscribe('username');
const resultById = await rest.users.subscribe(12345);

User Gifts ​

getGifts() ​

getGifts(user, page): Promise<Gift[]>

Gets user gifts

Parameters ​

user ​

User ({tag}/{id}/u{id})

string | number

page ​

number = 0

Page number (default 0)

Returns ​

Promise<Gift[]>

Array of Gift objects

Since ​

1.0.0

Throws ​

If parameters are invalid

Example ​

javascript
const gifts = await rest.users.getGifts('username');
const giftsById = await rest.users.getGifts(12345, 1);

gifts() ​

gifts(page): Promise<Gift[]>

Gets current user's gifts

Parameters ​

page ​

number = 0

Page number (default 0)

Returns ​

Promise<Gift[]>

Array of Gift objects

Since ​

1.0.0

Throws ​

If user not found in cache or page is invalid

Example ​

javascript
const gifts = await rest.users.gifts();
const nextPage = await rest.users.gifts(1);

Users Core ​

get() ​

get(user): Promise<User>

Gets user by identifier

Parameters ​

user ​

User ({tag}/{id}/u{id})

string | number

Returns ​

Promise<User>

User User information

Since ​

1.0.0

Throws ​

If user identifier is invalid

Example ​

javascript
const user = await rest.users.get('username');
const userById = await rest.users.get(12345);
const userByUid = await rest.users.get('u12345');

me() ​

me(): Promise<User>

Gets current user information

Returns ​

Promise<User>

User Current user

Since ​

1.0.0

Example ​

javascript
const me = await rest.users.me();