Hoppa till innehåll
This package has changed name, was previously @soleil-api/requester-wrapper.
More information

@soleil-se/requester

A wrapper for Requester since the request always is synchronous even though the API looks asynchronous.

Install

Terminal window
npm i @soleil-se/requester

Usage

import requester from '@soleil-se/requester';

Example

Options are the same as Requester with the addition of method.
Throws a HttpError on fail.

import requester from '@soleil-se/requester';
try {
// Default method is GET.
const { result, status, headers } = requester('https://example.com/api', {
data: {
id: 'foo',
},
});
// Send a POST request
const { result, status, headers } = requester('https://example.com/api', {
method: 'POST',
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

Request method alias

Aliases exist for all supported request methods.
requester.get(url, config)
requester.post(url, config)
requester.put(url, config)
requester.delete(url, config)
requester.patch(url, config) requester.head(url, config)

GET request

import requester from '@soleil-se/requester';
try {
const { result, status, headers } = requester.get('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

POST request

import requester from '@soleil-se/requester';
try {
const { result, status, headers } = requester.post('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

PUT request

import requester from '@soleil-se/requester';
try {
const { result, status, headers } = requester.put('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

DELETE request

import requester from '@soleil-se/requester';
try {
const { result, status, headers } = requester.delete('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

PATCH request

import requester from '@soleil-se/requester';
try {
const { result, status, headers } = requester.patch('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

HEAD request

import requester from '@soleil-se/requester';
try {
const { status, headers } = requester.head('https://example.com/api', {
data: {
id: 'foo',
},
});
} catch (error) {
// Do something with error.
}

Options

See Requester Options for all available options.