Skip to content

Commit

Permalink
docs: reformat README.md (#259)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-bot committed Dec 20, 2023
1 parent 5c60165 commit 7ce66ca
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ yarn add @tryfinch/finch-api

The full API of this library can be found in [api.md](https://www.github.com/Finch-API/finch-api-node/blob/main/api.md).

<!-- prettier-ignore -->
```js
import Finch from '@tryfinch/finch-api';

Expand All @@ -39,6 +40,7 @@ main();

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

<!-- prettier-ignore -->
```ts
import Finch from '@tryfinch/finch-api';

Expand All @@ -61,6 +63,7 @@ When the library is unable to connect to the API,
or if the API returns a non-success status code (i.e., 4xx or 5xx response),
a subclass of `APIError` will be thrown:

<!-- prettier-ignore -->
```ts
async function main() {
const company = await finch.hris.company.retrieve().catch((err) => {
Expand Down Expand Up @@ -217,6 +220,7 @@ The "raw" `Response` returned by `fetch()` can be accessed through the `.asRespo

You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.

<!-- prettier-ignore -->
```ts
const finch = new Finch();

Expand All @@ -239,12 +243,11 @@ If you would prefer to use a global, web-standards-compliant `fetch` function ev
(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
add the following import before your first import `from "Finch"`:

<!-- prettier-ignore -->
```ts
// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
import "@tryfinch/finch-api/shims/web";
import Finch from "@tryfinch/finch-api";
import '@tryfinch/finch-api/shims/web';
import Finch from '@tryfinch/finch-api';
```

To do the inverse, add `import "@tryfinch/finch-api/shims/node"` (which does import polyfills).
Expand Down

0 comments on commit 7ce66ca

Please sign in to comment.