Node.js SDK Documentation

LimitYourAPI Node.js SDK documentation. Installation, configuration, middleware, and error handling.

Node.js Integration Reference

The official Node.js SDK is designed with zero dependencies, leveraging native fetch (Node 18+) to avoid supply-chain vulnerability vectors.

1. Initialization Parameters

Initialize the client with custom configurations:

`javascript

import { LimitYourAPIClient } from 'limityourapi';

const limiter = new LimitYourAPIClient({

apiKey: process.env.LYA_API_KEY, // Required

baseUrl: 'https://api.v2.limityourapi.tech/api', // Default target

timeout: 2000, // Cancel check after 2 seconds

failOpen: true // Pass requests on connection errors

});

`

2. Manual Verification

You can evaluate request limits programmatically without using middleware:

`javascript

const result = await limiter.check({

endpoint: '/v1/users'

});

console.log(result.allowed); // boolean

console.log(result.remaining); // remaining requests

console.log(result.resetIn); // seconds until window resets

`

import { LimitYourAPIClient } from 'limityourapi';
const client = new LimitYourAPIClient({ apiKey: 'YOUR_KEY' });
const res = await client.check({ endpoint: '/v1/resource' });