Skip to content

Commit a57df99

Browse files
authored
docs: Export missing ApplicationFailureOptions (#823)
1 parent a632f40 commit a57df99

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,10 @@ Breaking changes marked with a :boom:
127127

128128
`originalRunId` is a concept related to resetting workflows. None of the instances of `originalRunId` in the SDK seem to do with resetting, so they were changed to `firstExecutionRunId` and `signaledRunId` for handles returned by `WorkflowClient.start` / `@temporalio/workflow:startChild` and `WorkflowClient.signalWithStart` respectively.
129129

130+
- :boom: Use error constructor name as `applicationFailureInfo.type` ([#683](https://github.com/temporalio/sdk-typescript/pull/683))
131+
132+
Now uses `err.constructor.name` instead of `err.name` by default, since `.name` is still 'Error' for classes that extend Error.
133+
130134
- Various improvements and fixes ([#660](https://github.com/temporalio/sdk-typescript/pull/660))
131135

132136
- Record memory usage in stress tests
@@ -158,7 +162,6 @@ Breaking changes marked with a :boom:
158162
- [`docs`] Add links to API and other categories ([#676](https://github.com/temporalio/sdk-typescript/pull/676))
159163
- [`docs`] `Connection.service` -> `.workflowService` ([#696](https://github.com/temporalio/sdk-typescript/pull/696))
160164
- [`docs`] Remove maxIsolateMemoryMB ([#700](https://github.com/temporalio/sdk-typescript/pull/700))
161-
- Use error constructor name as `applicationFailureInfo.type` ([#683](https://github.com/temporalio/sdk-typescript/pull/683))
162165
- Don't drop details from core errors ([#705](https://github.com/temporalio/sdk-typescript/pull/705))
163166

164167
### Features

packages/common/src/failure.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ export class ApplicationFailure extends TemporalFailure {
112112
/**
113113
* Create a new `ApplicationFailure` from an Error object.
114114
*
115-
* First calls `ensureApplicationFailure(error)`, and then overrides any fields provided in `overrides`.
115+
* First calls {@link ensureApplicationFailure | `ensureApplicationFailure(error)`} and then overrides any fields
116+
* provided in `overrides`.
116117
*/
117118
public static fromError(error: Error | unknown, overrides?: ApplicationFailureOptions): ApplicationFailure {
118119
const failure = ensureApplicationFailure(error);
@@ -157,7 +158,7 @@ export class ApplicationFailure extends TemporalFailure {
157158
}
158159
}
159160

160-
interface ApplicationFailureOptions {
161+
export interface ApplicationFailureOptions {
161162
/**
162163
* Error message
163164
*/

0 commit comments

Comments
 (0)