Empty Lightweight Client

This is a lightweight client for the Empty API. It contains only methods and types and exports only fetch call to make requests.

It supports only application/json content type and does not support file uploads. However, you can use the corresponding methods to upload files by URLs or file IDs. You can also upload files using another approach and pass the file ID to the method.

Installation

npm install @lightweight-clients/empty-lightweight-client

Usage

Examples

import { sample } from '@lightweight-clients/empty-lightweight-client';

const main = async () => {
    const result = sample();
    console.log(result);
};

main();

The library provides methods:

• request methods: sample, etc. These methods are used to make requests to the Empty API.
• client_*: methods for configuring the client.

client_* Methods

The methods starting with client_ are used to configure the client. They are:

• client_setClientToken(token: string): sets the token.
• client_setBaseUrl(endpoint: string): sets the endpoint.
• client_setFetch(customFetch: typeof client_fetch): sets the fetch function for all requests. Defaults to the fetch function from the node-fetch package. If you want to use a different fetch function (e.g., for browser or Node.js), you can set it here.

Features

• No dependencies.
• When using code minifiers, only the fetch command is exported.
• Can be used in browser and Node.js.
• Fully compatible with AWS LLRT.
• Fully typed API.

Versioning

TODO

Schema

The schema for the TODO is available in the {{SCHEMAS_REPO}} repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details. TODO