Skip to content

docs: fix typo in usage examples #4

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
merged 1 commit into from
Jun 12, 2023
Merged

docs: fix typo in usage examples #4

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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const client = new OnspringClient(process.env.BASE_URL, process.env.API_KEY);

### `Axios` Instance Configuration

By default when you construct an instance of the `OnspringClient` the a new `Axios` instance will also be created. Its `baseURL` property will always be set to the `baseUrl` parameter based to the `OnspringClient`'s constructor and its headers will always contain the proper `x-api-key` header.
By default when you construct an instance of the `OnspringClient` a new `Axios` instance will also be created. Its `baseURL` property will always be set to the `baseUrl` parameter based to the `OnspringClient`'s constructor and its headers will always contain the proper `x-api-key` header.

You can though pass a third optional argument to the `OnspringClient` constructor that specifies additional configuration options for the `Axios` instance used to make requests.

Expand Down Expand Up @@ -378,10 +378,10 @@ import { GetRecordsByAppIdRequest } from 'onspring-api-sdk';

const request = new GetRecordsByAppIdRequest(130);
const res = await client.getRecordsByAppId(request);
const apps = res.data.items;
const records = res.data.items;

for (const app of apps) {
console.log(app);
for (const record of records) {
console.log(record);
}
```

Expand All @@ -402,10 +402,10 @@ const request = new GetRecordsByAppIdRequest(
);

const res = await client.getRecordsByAppId(request);
const apps = res.data.items;
const records = res.data.items;

for (const app of apps) {
console.log(app);
for (const record of records) {
console.log(record);
}
```

Expand Down