feat(types): overridable Tailordb.Client constructor parameter #107
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Make
Tailordb.Clientconstructor parameter overridable through declaration merging, allowinglibrary consumers to customize the client configuration type while maintaining backward
compatibility.
Motivation
Previously, the
Tailordb.Clientconstructor had a fixed parameter type with only an optionalnamespacefield. This design made it impossible for library consumers to:namespace"main-db" | "sub-db")This PR introduces a flexible type system that allows consumers to extend or override the
client configuration through TypeScript's declaration merging.
Changes
Type System
UserClientConfiginterface: Empty by default, can be extended by consumers viadeclaration merging
DefaultClientConfiginterface: Contains the defaultnamespace?: stringfieldClientConfigtype: MergesUserClientConfigwithDefaultClientConfig, whereUserClientConfigtakes precedenceTesting Infrastructure
UserClientConfig(backward compatible)apiKey: string)timeout?: number)namespace: string)Test Configuration
tsconfig.jsonfor proper type isolation