@tryfinch/finch-api 5.14.2 → 5.14.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 5.14.3 (2023-12-20)
+
+Full Changelog: [v5.14.2...v5.14.3](https://github.com/Finch-API/finch-api-node/compare/v5.14.2...v5.14.3)
+
+### Documentation
+
+* reformat README.md ([#259](https://github.com/Finch-API/finch-api-node/issues/259)) ([aeadd81](https://github.com/Finch-API/finch-api-node/commit/aeadd812236bad61610280946b98db000e27aad3))
+
+
+### Refactors
+
+* write jest config in typescript ([#257](https://github.com/Finch-API/finch-api-node/issues/257)) ([b19f8be](https://github.com/Finch-API/finch-api-node/commit/b19f8be4a71e4b0ae70d198fb6fde1656ed562b3))
+
 ## 5.14.2 (2023-12-19)
 
 Full Changelog: [v5.14.1...v5.14.2](https://github.com/Finch-API/finch-api-node/compare/v5.14.1...v5.14.2)

package/README.md

@@ -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';
 
@@ -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';
 
@@ -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) => {
@@ -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();
 
@@ -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).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryfinch/finch-api",
-  "version": "5.14.2",
+  "version": "5.14.3",
   "description": "The official TypeScript library for the Finch API",
   "author": "Finch <founders@tryfinch.com>",
   "types": "./index.d.ts",

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.14.2'; // x-release-please-version
+export const VERSION = '5.14.3'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.14.2";
+export declare const VERSION = "5.14.3";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.14.2'; // x-release-please-version
+exports.VERSION = '5.14.3'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.14.2'; // x-release-please-version
+export const VERSION = '5.14.3'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map