Skip to content
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.

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

chore: Fix spelling #109

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion .speakeasy/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sources:
registry:
location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source
targets:
unstructed-typescript:
unstructured-typescript:
target: typescript
source: my-source
publish:
Expand Down
4 changes: 2 additions & 2 deletions FUNCTIONS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Standalone Functions

> [!NOTE]
> This section is useful if you are using a bundler and targetting browsers and
> This section is useful if you are using a bundler and targeting browsers and
> runtimes where the size of an application affects performance and load times.

Every method in this SDK is also available as a standalone function. This
alternative API is suitable when targetting the browser or serverless runtimes
alternative API is suitable when targeting the browser or serverless runtimes
and using a bundler to build your application since all unused functionality
will be tree-shaken away. This includes code for unused methods, Zod schemas,
encoding helpers and response handlers. The result is dramatically smaller
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
</div>

<h2 align="center">
<p>Typescript SDK for the Unstructured API</p>
<p>TypeScript SDK for the Unstructured API</p>
</h2>

This is a Typescript client for the [Unstructured API](https://docs.unstructured.io/api-reference/api-services/overview).
This is a TypeScript client for the [Unstructured API](https://docs.unstructured.io/api-reference/api-services/overview).

Please refer to the [Unstructured docs](https://docs.unstructured.io/api-reference/api-services/sdk-jsts) for a full guide to using the client.

Expand Down Expand Up @@ -384,6 +384,6 @@ looking for the latest version.
### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
Feel free to open a PR or a GitHub issue as a proof of concept and we'll do our best to include it in a future release!

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
2 changes: 1 addition & 1 deletion overlay_client.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ actions:
"split_pdf_allow_failed":
{
"title": "Split Pdf Allow Failed",
"description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages.",
"description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resulting list of Elements will miss the data from errored pages.",
"type": "boolean",
"default": false,
}
8 changes: 4 additions & 4 deletions src/lib/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export type Awaitable<T> = T | Promise<T>;
const DEFAULT_FETCHER: Fetcher = (input, init) => {
// If input is a Request and init is undefined, Bun will discard the method,
// headers, body and other options that were set on the request object.
// Node.js and browers would ignore an undefined init value. This check is
// Node.js and browsers would ignore an undefined init value. This check is
// therefore needed for interop with Bun.
if (init == null) {
return fetch(input);
Expand Down Expand Up @@ -254,7 +254,7 @@ export function matchResponse(
}

/**
* Uses various heurisitics to determine if an error is a connection error.
* Uses various heuristics to determine if an error is a connection error.
*/
export function isConnectionError(err: unknown): boolean {
if (typeof err !== "object" || err == null) {
Expand All @@ -281,7 +281,7 @@ export function isConnectionError(err: unknown): boolean {
}

/**
* Uses various heurisitics to determine if an error is a timeout error.
* Uses various heuristics to determine if an error is a timeout error.
*/
export function isTimeoutError(err: unknown): boolean {
if (typeof err !== "object" || err == null) {
Expand All @@ -302,7 +302,7 @@ export function isTimeoutError(err: unknown): boolean {
}

/**
* Uses various heurisitics to determine if an error is a abort error.
* Uses various heuristics to determine if an error is a abort error.
*/
export function isAbortError(err: unknown): boolean {
if (typeof err !== "object" || err == null) {
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/models/errors/sdkvalidationerror.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export function formatZodError(err: z.ZodError, level = 0): string {
case "invalid_union": {
const len = issue.unionErrors.length;
append(
`│ ✖︎ Attemped to deserialize into one of ${len} union members:`,
`│ ✖︎ Attempted to deserialize into one of ${len} union members:`,
);
issue.unionErrors.forEach((err, i) => {
append(`│ ✖︎ Member ${i + 1} of ${len}`);
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/models/shared/partitionparameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export type PartitionParameters = {
*/
skipInferTableTypes?: Array<string> | undefined;
/**
* When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages.
* When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resulting list of Elements will miss the data from errored pages.
*/
splitPdfAllowFailed?: boolean | undefined;
/**
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/types/constdatetime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ export function constDateTime(
return (
typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
);
}, `Value must be equivelant to ${val}`);
}, `Value must be equivalent to ${val}`);
}