0.3.0-alpha.1 • Published 6 months ago
@simplesmiler/taxios v0.3.0-alpha.1
@simplesmiler/taxios
TypeScript wrapper over Axios.
Use
Typings for your API can be generated with @simplesmiler/taxios-generate package.
Example typings: PetStore.ts (generated from the PetStore Swagger).
import axios from 'axios';
import { Taxios } from '@simplesmiler/taxios';
import { PetStore } from './PetStore';
const taxios = new Taxios<PetStore>(axios.create({ baseURL: 'https://petstore.swagger.io/v2' }));
// <method> returns whole response.
const inventoryResponse = await taxios.get('/store/inventory');
// $<method> returns response body.
const inventory = await taxios.$get('/store/inventory');
// Url params example.
// Note the literal route from Swagger/OpenAPI instead of interpolated url.
const pet = await taxios.$get('/pet/{id}', { params: { id: 1 } });
// Query string params example.
const found = await taxios.$get('/pet/findByStatus', { query: { status: ['sold', 'pending'] } });
// Full arguments
await taxios.<method>(url, config); // For methods without body, like GET and DELETE
await taxios.<method>(url, body, config); // For methods with body, like POST and PUT
// Config
{
// Url params, e.g. { id: 5 } for /api/pet/{id} -> /api/pet/5
params: { key: value },
//
// Query string params, e.g. { status: ['sold', 'pending'] } for /api/pets/findByStatus?status=sold,pending
query: { key: value },
//
// The rest of axios config, if you need it, e.g. { headers: { 'X-Visitor-Id': 1 } }
axios: { ... },
};
0.3.0-alpha.0
8 months ago
0.3.0-alpha.1
6 months ago
0.2.15
1 year ago
0.2.14
1 year ago
0.2.13
2 years ago
0.2.12
2 years ago
0.2.11
2 years ago
0.2.9-alpha.0
2 years ago
0.2.10
2 years ago
0.2.9
2 years ago
0.2.8-alpha.0
3 years ago
0.2.8-alpha.1
3 years ago
0.2.8
3 years ago
0.2.7-alpha.1
3 years ago
0.2.7
3 years ago
0.2.6
3 years ago
0.2.5
4 years ago
0.2.3
4 years ago
0.2.4
4 years ago
0.2.1
4 years ago
0.1.8
4 years ago
0.2.2
4 years ago
0.2.0
4 years ago
0.2.0-alpha.2
4 years ago
0.2.0-alpha.0
4 years ago
0.2.0-alpha.1
4 years ago
0.1.7
4 years ago
0.1.6
4 years ago
0.1.5
4 years ago
0.1.4
4 years ago
0.1.3
4 years ago
0.1.2
4 years ago
0.1.1
4 years ago
0.1.0
4 years ago