Skip to content
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

Add type to check optional Client Configuration #858

Merged
merged 5 commits into from
Aug 7, 2023
Merged

Add type to check optional Client Configuration #858

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2d7874
chore(types): add CheckOptionalClientConfig
trivikr Aug 7, 2023
409f271
chore: yarn changeset
trivikr Aug 7, 2023
df64dde
fix: format TypeScript code
trivikr Aug 7, 2023
bc4a43e
chore: switch changeset to minor
trivikr Aug 7, 2023
8d0ebaf
fix(types): move Exact type to util.ts
trivikr Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/curvy-pumas-return.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@smithy/types": minor
---

Add type to check optional Client Configuration
10 changes: 10 additions & 0 deletions packages/types/src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@ import { Command } from "./command";
import { MiddlewareStack } from "./middleware";
import { MetadataBearer } from "./response";

export type Exact<Type1, Type2> = [Type1] extends [Type2] ? ([Type2] extends [Type1] ? true : false) : false;
trivikr marked this conversation as resolved.
Show resolved Hide resolved

/**
* @public
*
* A type which checks if the client configuration is optional.
* If all entries of the client configuration are optional, it allows client creation without passing any config.
*/
export type CheckOptionalClientConfig<T> = Exact<Partial<T>, T> extends true ? [] | [T] : [T];

/**
* @public
*
Expand Down