[!NOTE]
Once this package is published to npm, this will become: npm install ai-content-reviewer
Usage
The full API of this library can be found in api.md.
<!-- prettier-ignore -->
import AIContentReviewer from 'ai-content-reviewer';
const client = new AIContentReviewer({
apiKey: process.env['AI_CONTENT_REVIEWER_API_KEY'], // This is the default and can be omitted
});
const reviews = await client.reviews.list();
console.log(reviews.pagination);
Request & Response types
This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
<!-- prettier-ignore -->
import AIContentReviewer from 'ai-content-reviewer';
const client = new AIContentReviewer({
apiKey: process.env['AI_CONTENT_REVIEWER_API_KEY'], // This is the default and can be omitted
});
const reviews: AIContentReviewer.ReviewListResponse = await client.reviews.list();
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
Handling errors
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 will be thrown:
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors will all be retried by default.
You can use the maxRetries option to configure or disable this:
// Configure the default for all requests:
const client = new AIContentReviewer({
maxRetries: 0, // default is 2
});
// Or, configure per-request:
await client.reviews.list({
maxRetries: 5,
});
Timeouts
Requests time out after 1 minute by default. You can configure this with a timeout option:
// Configure the default for all requests:
const client = new AIContentReviewer({
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});
// Override per-request:
await client.reviews.list({
timeout: 5 * 1000,
});
On timeout, an APIConnectionTimeoutError is thrown.
The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return.
This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
You can also use the .withResponse() method to get the raw Response along with the parsed data.
Unlike .asResponse() this method consumes the body, returning once it is parsed.
const client = new AIContentReviewer();
const response = await client.reviews.list().asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object
const { data: reviews, response: raw } = await client.reviews.list().withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(reviews.pagination);
Logging
[!IMPORTANT]
All log messages are intended for debugging only. The format and content of log messages
may change between releases.
Log levels
The log level can be configured in two ways:
Via the AI_CONTENT_REVIEWER_LOG environment variable
Using the logLevel client option (overrides the environment variable if set)
import AIContentReviewer from 'ai-content-reviewer';
const client = new AIContentReviewer({
logLevel: 'debug', // Show all log messages
});
Available log levels, from most to least verbose:
'debug' - Show debug messages, info, warnings, and errors
'info' - Show info messages, warnings, and errors
'warn' - Show warnings and errors (default)
'error' - Show only errors
'off' - Disable all logging
At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies.
Some authentication-related headers are redacted, but sensitive data in request and response bodies
may still be visible.
Custom logger
By default, this library logs to globalThis.console. You can also provide a custom logger.
Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.
When providing a custom logger, the logLevel option still controls which messages are emitted, messages
below the configured level will not be sent to your logger.
import AIContentReviewer from 'ai-content-reviewer';
import pino from 'pino';
const logger = pino();
const client = new AIContentReviewer({
logger: logger.child({ name: 'AIContentReviewer' }),
logLevel: 'debug', // Send all messages to pino, allowing it to filter
});
Making custom/undocumented requests
This library is typed for convenient access to the documented API. If you need to access undocumented
endpoints, params, or response properties, the library can still be used.
Undocumented endpoints
To make requests to undocumented endpoints, you can use client.get, client.post, and other HTTP verbs.
Options on the client, such as retries, will be respected when making these requests.
To make requests using undocumented parameters, you may use // @ts-expect-error on the undocumented
parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
send will be sent as-is.
client.reviews.list({
// ...
// @ts-expect-error baz is not yet public
baz: 'undocumented option',
});
For requests with the GET verb, any extra params will be in the query, all other requests will send the
extra param in the body.
If you want to explicitly send an extra argument, you can do so with the query, body, and headers request
options.
Undocumented response properties
To access undocumented response properties, you may access the response object with // @ts-expect-error on
the response object, or cast the response object to the requisite type. Like the request params, we do not
validate or strip extra properties from the response from the API.
Customizing the fetch client
By default, this library expects a global fetch function is defined.
If you want to use a different fetch function, you can either polyfill the global:
import fetch from 'my-fetch';
globalThis.fetch = fetch;
Or pass it to the client:
import AIContentReviewer from 'ai-content-reviewer';
import fetch from 'my-fetch';
const client = new AIContentReviewer({ fetch });
Fetch options
If you want to set custom fetch options without overriding the fetch function, you can provide a fetchOptions object when instantiating the client or making a request. (Request-specific options override client options.)
import AIContentReviewer from 'ai-content-reviewer';
const client = new AIContentReviewer({
fetchOptions: {
// `RequestInit` options
},
});
Configuring proxies
To modify proxy behavior, you can provide custom fetchOptions that add runtime-specific proxy
options to requests:
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
Changes that only affect static types, without breaking runtime behavior.
Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
Requirements
TypeScript >= 4.9 is supported.
The following runtimes are supported:
Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
)
