Api-def NPM | npm.io

0.11.1 • Published 11 months ago

Install

Weekly downloads

2

License

MIT

Repository

Last release

11 months ago

api-def ·

Typed APIs with middleware support

API def provides a unified way to type your endpoints allowing for compile time checking of query, body, response and even url parameters

npm i api-def

Documentation

import {Api} from "api-def";

const api = new Api({
  baseUrl: "https://my-api/",
  name: "My API",
});

const fetchData = api.endpoint()
    .queryOf<{ includeAwesome: boolean; }>()
    .responseOf<{ data: {awesome: boolean; } }>()
    .build({
      id: "fetch_data",
      method: "get",
      path: "/data"
    });

// calls GET https://my-api/data?includeAwesome=true
const res = await fetchData.submit({
  query: {includeAwesome: true}
});

console.log(res.data); // { data: { awesome: true } }

typescript javascript node web api typed cache fetch retry middleware

@everything-registry/sub-chunk-1150 @zalastax/nolb-api-d

0.12.0-alpha.35

11 months ago

0.12.0-alpha.36

11 months ago

0.12.0-alpha.33

11 months ago

0.12.0-alpha.34

11 months ago

0.12.0-alpha.31

12 months ago

0.12.0-alpha.32

12 months ago

0.12.0-alpha.30

12 months ago

0.12.0-alpha.29

12 months ago

0.12.0-alpha.28

12 months ago

0.12.0-alpha.27

12 months ago

0.12.0-alpha.24

12 months ago

0.12.0-alpha.25

12 months ago

0.12.0-alpha.22

12 months ago

0.12.0-alpha.23

12 months ago

0.12.0-alpha.20

1 year ago

0.12.0-alpha.21

1 year ago

0.12.0-alpha.17

1 year ago

0.12.0-alpha.18

1 year ago

0.12.0-alpha.16

1 year ago

0.12.0-alpha.13

1 year ago

0.12.0-alpha.14

1 year ago

0.12.0-alpha.11

1 year ago

0.12.0-alpha.15

1 year ago

0.12.0-alpha.10

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago