Skip to content

Commit 425c786

Browse files
authored
Merge pull request #674 from ninthsun91/docs/typo-propagation
fix: Typo in sdk docs - missing status code 200
2 parents 4de3179 + 893d23a commit 425c786

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

website/pages/docs/sdk/sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ export namespace IPropagation {
691691

692692
Returns `IPropagation` typed instance instead of throwing exception.
693693

694-
When you configure propagate property of `nestia.config.ts` file, all of SDK functions generated by `@nestia/sdk` will perform propagation mode. The propagation mode means that never throwing exception (`HttpError`) even when response status code is not (or 201), but just returning the `IPropagation` typed object, which can specify its body data type through discriminated union determined by status code.
694+
When you configure propagate property of `nestia.config.ts` file, all of SDK functions generated by `@nestia/sdk` will perform propagation mode. The propagation mode means that never throwing exception (`HttpError`) even when response status code is not 200 (or 201), but just returning the `IPropagation` typed object, which can specify its body data type through discriminated union determined by status code.
695695

696696
Looking at below code tabs one by one, then you may understand exactly, what the propagation mode is. As you can see from below example code, [`@TypedException()`](../core/TypedException) decorator function can be utilized to define the failure type with specific status code. Also, if returned status code is out of pre-defined, the `IPropagation.data` type would be automatically casted to `unknown` type.
697697

0 commit comments

Comments
 (0)