Skip to content

docs: update TypeScript SDK API reference (next) #8331

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

Open
camunda-docs-pr-automation wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update TypeScript SDK API reference (next) #8331

Show file tree
Hide file tree
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
function classifyDomainError(err): DomainErrorTag;
```

Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L42)
Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L42)

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
function eventuallyTE<E, A>(thunk, predicate, opts): TaskEither<E, A>;
```

Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L177)
Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L177)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
function foldDomainError<A>(handlers): (err) => A;
```

Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L51)
Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L51)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
function retryTE<E, A>(task, opts): TaskEither<E, A>;
```

Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L128)
Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L128)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
function withTimeoutTE<E, A>(task, ms, onTimeout?): TaskEither<E, A>;
```

Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L155)
Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L155)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ type DomainError =
| Error;
```

Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L24)
Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L24)
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ The Functional Programming API is a **technical preview**. Its surface may chang
type DomainErrorTag = "validation" | "timeout" | "http" | "generic";
```

Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L40)
Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L40)
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type FnKeys<C> = {
}[keyof C];
```

Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L72)
Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L72)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type Fpify<C> = {
} & object & { [K in Exclude<keyof C, FnKeys<C>>]: C[K] };
```

Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L73)
Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L73)

## Type Declaration

Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/HttpError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
type HttpError = object & Record<string, any>;
```

Defined in: [fp-ts.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L20)
Defined in: [fp-ts.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L20)

## Type Declaration

Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/typescript/api-reference/fp/type-aliases/Left.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
type Left<E> = object;
```

Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9)
Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9)

## Type Parameters

Expand All @@ -31,7 +31,7 @@ Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js
_tag: "Left";
```

Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9)
Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9)

---

Expand All @@ -41,4 +41,4 @@ Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js
left: E;
```

Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9)
Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9)
6 changes: 3 additions & 3 deletions docs/apis-tools/typescript/api-reference/fp/type-aliases/Right.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
type Right<A> = object;
```

Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10)
Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10)

## Type Parameters

Expand All @@ -31,7 +31,7 @@ Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-j
_tag: "Right";
```

Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10)
Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10)

---

Expand All @@ -41,4 +41,4 @@ Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-j
right: A;
```

Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10)
Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10)
2 changes: 1 addition & 1 deletion docs/apis-tools/typescript/api-reference/fp/type-aliases/TaskEither.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang
type TaskEither<E, A> = () => Promise<Either<E, A>>;
```

Defined in: [fp-ts.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L12)
Defined in: [fp-ts.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L12)

## Type Parameters

Expand Down
Loading
Loading