Skip to content

Commit 912cec9

Browse files
jwulfgithub-actions[bot]
authored andcommitted
docs: update TypeScript SDK API reference (next)
1 parent b2bad44 commit 912cec9

File tree

1,903 files changed

+19532
-17220
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,903 files changed

+19532
-17220
lines changed

docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
1516
function classifyDomainError(err): DomainErrorTag;
1617
```
1718

18-
Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L42)
19+
Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L42)
1920

2021
## Parameters
2122

docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
15-
function eventuallyTE<E, A>(thunk, predicate, opts): TaskEither<E, A>;
16+
function eventuallyTE<E, A>(
17+
thunk,
18+
predicate,
19+
opts): TaskEither<E, A>;
1620
```
1721

18-
Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L177)
22+
Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L177)
1923

2024
## Type Parameters
2125

docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
1516
function foldDomainError<A>(handlers): (err) => A;
1617
```
1718

18-
Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L51)
19+
Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L51)
1920

2021
## Type Parameters
2122

docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
1516
function retryTE<E, A>(task, opts): TaskEither<E, A>;
1617
```
1718

18-
Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L128)
19+
Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L128)
1920

2021
## Type Parameters
2122

docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
15-
function withTimeoutTE<E, A>(task, ms, onTimeout?): TaskEither<E, A>;
16+
function withTimeoutTE<E, A>(
17+
task,
18+
ms,
19+
onTimeout?): TaskEither<E, A>;
1620
```
1721

18-
Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L155)
22+
Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L155)
1923

2024
## Type Parameters
2125

docs/apis-tools/typescript/api-reference/fp/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
## Type Aliases
1516

1617
- [DomainError](type-aliases/DomainError.md)
@@ -36,25 +37,25 @@ The Functional Programming API is a **technical preview**. Its surface may chang
3637

3738
Re-exports [CamundaFpClient](../index/type-aliases/CamundaFpClient.md)
3839

39-
---
40+
***
4041

4142
### createCamundaFpClient
4243

4344
Re-exports [createCamundaFpClient](../index/functions/createCamundaFpClient.md)
4445

45-
---
46+
***
4647

4748
### Either
4849

4950
Re-exports [Either](../index/type-aliases/Either.md)
5051

51-
---
52+
***
5253

5354
### isLeft
5455

5556
Re-exports [isLeft](../index/functions/isLeft.md)
5657

57-
---
58+
***
5859

5960
### isRight
6061

docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
15-
type DomainError =
16+
type DomainError =
1617
| CamundaValidationError
1718
| EventualConsistencyTimeoutError
1819
| HttpError
1920
| Error;
2021
```
2122

22-
Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L24)
23+
Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L24)

docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
1516
type DomainErrorTag = "validation" | "timeout" | "http" | "generic";
1617
```
1718

18-
Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L40)
19+
Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L40)

docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,12 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
15-
type FnKeys<C> = {
16-
[K in keyof C]: C[K] extends (a: any) => any ? K : never;
17-
}[keyof C];
16+
type FnKeys<C> = { [K in keyof C]: C[K] extends (a: any) => any ? K : never }[keyof C];
1817
```
1918

20-
Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L72)
19+
Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L72)
2120

2221
## Type Parameters
2322

docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,12 @@ mdx:
1111
The Functional Programming API is a **technical preview**. Its surface may change in future releases without following semver.
1212
:::
1313

14+
1415
```ts
15-
type Fpify<C> = {
16-
[K in FnKeys<C>]: C[K] extends (a: infer A) => infer R
17-
? (a: A) => TaskEither<DomainError, Awaited<R>>
18-
: never;
19-
} & object & { [K in Exclude<keyof C, FnKeys<C>>]: C[K] };
16+
type Fpify<C> = { [K in FnKeys<C>]: C[K] extends (a: infer A) => infer R ? (a: A) => TaskEither<DomainError, Awaited<R>> : never } & object & { [K in Exclude<keyof C, FnKeys<C>>]: C[K] };
2017
```
2118

22-
Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L73)
19+
Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/1f60cc68113c00cf1b1f797688e57d3d1d077645/src/fp-ts.ts#L73)
2320

2421
## Type Declaration
2522

0 commit comments

Comments
 (0)