Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onedoclabs/fileforge-node-sdk
A Node.js library for the FileForge API
https://github.com/onedoclabs/fileforge-node-sdk
built-with-fern generated-from-openapi javascript-client typescript-client
Last synced: 7 days ago
JSON representation
A Node.js library for the FileForge API
- Host: GitHub
- URL: https://github.com/onedoclabs/fileforge-node-sdk
- Owner: OnedocLabs
- License: mit
- Created: 2024-05-07T13:42:38.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-14T00:53:10.000Z (5 months ago)
- Last Synced: 2024-06-14T02:20:18.772Z (5 months ago)
- Topics: built-with-fern, generated-from-openapi, javascript-client, typescript-client
- Language: TypeScript
- Homepage:
- Size: 354 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fileforge TypeScript Library
[](https://www.npmjs.org/package/@fileforge/client)
[](https://buildwithfern.com/)
The Fileforge TypeScript library provides convenient access to the Fileforge API from JavaScript/TypeScript.
## Documentation
API reference documentation is available [here](https://docs.fileforge.com/api-reference/).
## Installation
```bash
npm install --save @fileforge/client
# or
yarn add @fileforge/client
```
## Usage
```typescript
import { FileforgeClient, Fileforge } from "@fileforge/client";
import * as fs from "fs";
const fileforge = new FileforgeClient({
apiKey: "...",
});
await fileforge.generate({
files: [fs.readStream("index.html")],
options: {
fileName: "output.pdf",
},
});
```
## Exception Handling
When the API returns a non-success status code (4xx or 5xx response),
a subclass of [FileforgeError](./src/errors/FileforgeError.ts) will be thrown:
```ts
import { FileforgeError } from '@fileforge/client';
try {
await fileforge.generate(...);
} catch (err) {
if (err instanceof FileforgeError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
}
}
```
## Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be
retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
than the configured retry limit (default: 2).
A request is deemed retriable when any of the following HTTP status codes is returned:
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
Use the `maxRetries` request option to configure this behavior.
```ts
const response = await fileforge.generate(..., {
maxRetries: 0 // override maxRetries at the request level
});
```
## Timeouts
The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to
configure this behavior.
```ts
const response = await fileforge.generate(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
```
## Runtime compatiblity
The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK
works in the following runtimes:
The following runtimes are supported:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
### Customizing Fetch client
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're
running in an unsupported environment, this provides a way for you to break the glass and
ensure the SDK works.
```ts
import { Fileforge } from '@fileforge/client';
const guesty = new Fileforge({
apiKey: "...",
fetcher: // provide your implementation here
});
```
## Beta status
This SDK is in beta, and there may be breaking changes between versions without a major version update.
Therefore, we recommend pinning the package version to a specific version in your package.json file.
This way, you can install the same version each time without breaking changes unless you are
intentionally looking for the latest version.
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a
PR as a proof of concept, but know that we will not be able to merge it as-is.
We suggest [opening an issue](https://github.com/FlatFilers/flatfile-node/issues) first to discuss with us!