Skip to content

Commit 295dc17

Browse files
authored
docs: Fix minor typos in README (#128)
1 parent 3e9cdc0 commit 295dc17

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ const seam = new SeamHttp()
122122
// Pass as the first argument to the constructor
123123
const seam = new SeamHttp('your-api-key')
124124

125-
// Pass as an option the constructor
125+
// Pass as an option to the constructor
126126
const seam = new SeamHttp({ apiKey: 'your-api-key' })
127127

128128
// Use the factory method
@@ -134,7 +134,7 @@ const seam = SeamHttp.fromApiKey('your-api-key')
134134
A Client Session Token is scoped to a client session and should only be used on the client.
135135

136136
```ts
137-
// Pass as an option the constructor
137+
// Pass as an option to the constructor
138138
const seam = new SeamHttp({ clientSessionToken: 'some-client-session-token' })
139139

140140
// Use the factory method
@@ -174,7 +174,7 @@ A workspace ID must be provided when using this method
174174
and all requests will be scoped to that workspace.
175175

176176
```ts
177-
// Pass as an option the constructor
177+
// Pass as an option to the constructor
178178

179179
const seam = new SeamHttp({
180180
personalAccessToken: 'your-personal-access-token',
@@ -196,7 +196,7 @@ A workspace ID must be provided when using this method
196196
and all requests will be scoped to that workspace.
197197

198198
```ts
199-
// Pass as an option the constructor
199+
// Pass as an option to the constructor
200200
const seam = new SeamHttp({
201201
consoleSessionToken: 'some-console-session-token',
202202
workspaceId: 'your-workspace-id',
@@ -234,7 +234,7 @@ and want to wait for it to resolve, simply use
234234
await seam.actionAttempts.get({ action_attempt_id })
235235
```
236236

237-
Or, to get the current state of an action attempt by ID without waiting,
237+
Or, to get the current state of an action attempt by ID without waiting:
238238

239239
```ts
240240
await seam.actionAttempts.get(
@@ -245,7 +245,7 @@ await seam.actionAttempts.get(
245245
)
246246
```
247247

248-
To disable this behavior, set the default option for the client,
248+
To disable this behavior, set the default option for the client:
249249

250250
```ts
251251
const seam = new SeamHttp({
@@ -256,7 +256,7 @@ const seam = new SeamHttp({
256256
await seam.locks.unlockDoor({ device_id })
257257
```
258258

259-
or the behavior may be configured per-request,
259+
or the behavior may be configured per-request:
260260

261261
```ts
262262
await seam.locks.unlockDoor(
@@ -267,7 +267,8 @@ await seam.locks.unlockDoor(
267267
)
268268
```
269269

270-
The `pollingInterval` and `timeout` may be configured for the client or per-request, for example
270+
The `pollingInterval` and `timeout` may be configured for the client or per-request.
271+
For example:
271272

272273
```ts
273274
import {
@@ -319,7 +320,7 @@ A Personal Access Token is scoped to a Seam Console user.
319320
Obtain one from the Seam Console.
320321

321322
```ts
322-
// Pass as an option the constructor
323+
// Pass as an option to the constructor
323324
const seam = new SeamHttpMultiWorkspace({
324325
personalAccessToken: 'your-personal-access-token',
325326
})
@@ -339,7 +340,7 @@ A Console Session Token is used by the Seam Console.
339340
This authentication method is only used by internal Seam applications.
340341

341342
```ts
342-
// Pass as an option the constructor
343+
// Pass as an option to the constructor
343344
const seam = new SeamHttpMultiWorkspace({
344345
consoleSessionToken: 'some-console-session-token',
345346
})

0 commit comments

Comments
 (0)