Yurba.js

Appearance

Yurba.js / @yurbajs/rest


yurba.js logo


npm versionnpm downloadsLast commitnpm last update

About ​

REST client for Yurba API with full TypeScript support.

WARNING: it's alpha version

Install ​

Node.js 20 or newer is required.

sh
npm install @yurbajs/rest
yarn add @yurbajs/rest
pnpm add @yurbajs/rest
bun add @yurbajs/rest

Example usage ​

js
import { REST } from '@yurbajs/rest';

const rest = new REST('y.your_token_here');

try {
  // Get current user info
  const me = await rest.users.me();
  console.log('Current user:', me);

  // Send message to dialog
  const message = await rest.dialogs.sendMessage(123, {
    text: 'Hello from yurba.js! 👋'
  });
  console.log('Sent message:', message);

  // Get user by username or ID
  const user = await rest.users.get('username');
  const userById = await rest.users.get(12345);
  
  // Get all dialogs
  const dialogs = await rest.dialogs.getAll();
  console.log('My dialogs:', dialogs);

  // Create new dialog
  const newDialog = await rest.dialogs.create({
    name: 'My Channel',
    description: 'Discussion place',
    type: 'channel'
  });

  // Get friends
  const friends = await rest.users.friends();
  console.log('Friends:', friends);

} catch (error) {
  console.error('API Error:', error.message);
}

Batch Requests ​

Execute multiple API calls in parallel for better performance:

js
// Instead of sequential calls (slow)
const me = await rest.users.me();        // 300ms
const dialogs = await rest.dialogs.getAll(); // 300ms  
const friends = await rest.users.friends();  // 300ms
// Total: ~900ms

// Use batch requests (fast)
const results = await rest.batch()
  .add('me', rest.users.me())
  .add('dialogs', rest.dialogs.getAll())
  .add('friends', rest.users.friends())
  .execute();
// Total: ~300ms (parallel)

console.log('User:', results.me);
console.log('Dialogs:', results.dialogs);
console.log('Friends:', results.friends);

// Handle partial failures
const results = await rest.batch()
  .add('me', rest.users.me())
  .add('invalid', rest.users.get('nonexistent')) // will fail
  .executeSettled(); // won't throw on errors

console.log(results.me);      // User object
console.log(results.invalid); // { error: Error }

Contributing ​

Want to help make yurba.js better?

Please make sure to follow our coding style and test your changes before submitting.

Getting Help ​

Need assistance?

Classes ​

Interfaces ​

References ​

default ​

Renames and re-exports REST