From 9292780007971aab98d44b7ed2865aa2af7e9805 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Mon, 12 Jun 2023 12:36:39 -0500 Subject: [PATCH] docs: fix typo in usage examples --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 06d6c00..7e4ed86 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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); } ``` @@ -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); } ```