1.0.6 • Published 10 months ago

fetch-opts v1.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Fetch Opts

Test GitHub license

Fetch Opts is a lightweight JavaScript library that simplifies the process of creating fetch options for the Fetch API. It provides a chainable interface for building fetch options, making it easier to work with various options such as Bearer tokens, methods, content types, bodies, credentials, and custom headers.

Installation

NPM:

npm install fetch-opts

Yarn:

yarn add fetch-opts

Usage

import { FetchOptionsBuilder } from 'fetch-opts';

// Create a new instance of the builder.
const builder = new FetchOptionsBuilder();

const requestBody = {
  email: 'myemail@mail.com',
  password: 'password123',
};

// Chain the methods to set the desired options.
const fetchOptions = builder
  .method('POST')
  .contentType('application/json')
  .body(requestBody)
  .credentials('include')
  .build();

fetch('https://api.example.com/signin', fetchOptions)
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error('Error:', error));

API Reference

MethodParametersDescription
bearerTokenaccessToken: string or numberSets the Bearer token for the request.
methodmethod: stringSets the HTTP method for the request.
contentTypecontentType: stringSets the Content-Type header for the request. Includes built-in types for common content types.
bodybody: anySets the request body. If the method is 'GET', it will display a warning and ignore the body.
credentialscredentials: stringSets the credentials mode for the request.
customHeaderkey: string, value: stringSets a custom header for the request.
buildBuilds and returns the final fetch options object.

Contributing

Contributions are welcome from the community! If you're interested in contributing, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes, and add tests for your changes.
  4. Commit your changes.
  • Note that Husky is set up to automatically run tests and format your code using Prettier before each commit. Make sure your changes pass the tests.
  1. Push your branch to your fork.
  2. Open a pull request from your fork to the main repository.

License

This project is licensed under MIT

1.0.6

10 months ago

1.0.5

12 months ago

1.0.4

12 months ago

1.0.3

12 months ago

1.0.2

12 months ago

1.0.1

12 months ago

1.0.0

12 months ago