Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ const pages = seam.createPaginator(
)

for await (const device of pages.flatten()) {
console.log(devices.name)
console.log(device.display_name)
}
```

Expand Down Expand Up @@ -523,7 +523,8 @@ default.

The Axios client and retry behavior may be configured with custom initiation options
via [`axiosOptions`][axiosOptions] and [`axiosRetryOptions`][axiosRetryOptions].
Options are deep merged with the default options.
Options are shallow merged with the default options:
each provided top-level option replaces the default value.

By default, the SDK makes up to three attempts: the initial request and two
retries. Retries are limited to `GET`, `HEAD`, `OPTIONS`, `PUT`, and `DELETE`
Expand Down Expand Up @@ -586,6 +587,12 @@ console.log(`${request.method} ${request.url}`, JSON.stringify(request.body))
const devices = await request.execute()
```

A `SeamHttpRequest` is sent at most once.
Awaiting the same request again,
or calling `execute`, `then`, `catch`, or `finally` more than once,
always returns the result of the first execution
and never repeats the HTTP request.

#### Serializing URL search params

The Seam API parses URL search params as complex types.
Expand Down
Loading
Loading