Skip to content

pangea-node-sdk: document configuration options #2342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenany merged 1 commit into from
Jun 19, 2025
Merged

pangea-node-sdk: document configuration options #2342

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions packages/pangea-node-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ guarantees as stable releases. [Beta changelog](https://github.com/pangeacyber/p
Via npm:

```bash
$ npm install pangea-node-sdk@4.4.0-beta.2
$ npm install pangea-node-sdk@5.2.0-beta.3
```

Via yarn:

```bash
$ yarn add pangea-node-sdk@4.4.0-beta.2
$ yarn add pangea-node-sdk@5.2.0-beta.3
```

## Usage
Expand Down Expand Up @@ -75,6 +75,31 @@ const audit = new AuditService(token, config);
const response = await audit.log({ message: "Hello, World!" });
```

## Configuration

The SDK supports the following configuration options via `PangeaConfig`:

- `baseUrlTemplate` — Template for constructing the base URL for API requests.
The placeholder `{SERVICE_NAME}` will be replaced with the service name slug.
This is a more powerful version of `domain` that allows for setting more than
just the host of the API server.
Defaults to `https://{SERVICE_NAME}.aws.us.pangea.cloud`.
- `domain` — Base domain for API requests. This is a weaker version of
`baseUrlTemplate` that only allows for setting the host of the API server. Use
`baseUrlTemplate` for more control over the URL, such as setting
service-specific paths. Defaults to `aws.us.pangea.cloud`.
- `requestRetries` — How many times a request should be retried on failure.
Defaults to `3`.
- `requestTimeout` — Maximum allowed time (in milliseconds) for a request to
complete. Defaults to `5000`.
- `queuedRetryEnabled` — Whether or not queued request retries are enabled.
Defaults to `true`.
- `queuedRetries` — How many queued request retries there should be on failure.
Defaults to `4`.
- `pollResultTimeoutMs` — Timeout for polling results after a HTTP/202
(in milliseconds). Defaults to `120 * 1000`.
- `customUserAgent` — User-Agent string to append to the default one.

[Documentation]: https://pangea.cloud/docs/sdk/js/
[GA Examples]: https://github.com/pangeacyber/pangea-javascript/tree/main/examples
[Beta Examples]: https://github.com/pangeacyber/pangea-javascript/tree/beta/examples
Expand Down
Loading