Type Alias IPropagation<StatusMap, Success>

Propagation type.

IPropagation is a type gathering all possible status codes and their body data types as a discriminated union type. You can specify the status code and its body data type just by using conditional statement like below.

type Output = IPropagation<{
   200: ISeller.IAuthorized;
   400: TypeGuardError.IProps;
>};

const output: Output = await sdk.sellers.authenticate.join(input);
if (output.success) {
    // automatically casted to "ISeller.IAuthorized" type
    const authorized: ISeller.IAuthorized = output.data;
} else if (output.status === 400) {
    // automatically casted to "TypeGuardError.IProps" type
    const error: TypeGuardError.IProps = output.data;
} else {
    // unknown type when out of pre-defined status codes
    const result: unknown = output.data;
}
Copy

For reference, this IPropagation type is utilized by SDK library generated by @nestia/sdk, when you've configured INestiaConfig.propagate to be true. In that case, SDK functions generated by @nestia/sdk no more returns response DTO typed data directly, but returns this IPropagation typed object instead.