Skip to content

fix(type): config service get and getOrThrow methods return type #2072

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

Open
PongDev wants to merge 1 commit into
base: master
Choose a base branch
from
+48 −7
Open

fix(type): config service get and getOrThrow methods return type #2072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 20 additions & 7 deletions lib/config.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,11 @@ export class ConfigService<
* @param propertyPath
* @param options
*/
get<T = K, P extends Path<T> = any, R = PathValue<T, P>>(
get<
T = K,
P extends Path<T> = any,
R extends PathValue<T, P> = PathValue<T, P>,
>(
propertyPath: P,
options: ConfigGetOptions,
): ValidatedResult<WasValidated, R>;
Expand All @@ -114,7 +118,11 @@ export class ConfigService<
* @param defaultValue
* @param options
*/
get<T = K, P extends Path<T> = any, R = PathValue<T, P>>(
get<
T = K,
P extends Path<T> = any,
R extends PathValue<T, P> = PathValue<T, P>,
>(
propertyPath: P,
defaultValue: NoInferType<R>,
options: ConfigGetOptions,
Expand Down Expand Up @@ -171,10 +179,11 @@ export class ConfigService<
* @param propertyPath
* @param options
*/
getOrThrow<T = K, P extends Path<T> = any, R = PathValue<T, P>>(
propertyPath: P,
options: ConfigGetOptions,
): Exclude<R, undefined>;
getOrThrow<
T = K,
P extends Path<T> = any,
R extends PathValue<T, P> = PathValue<T, P>,
>(propertyPath: P, options: ConfigGetOptions): Exclude<R, undefined>;
/**
* Get a configuration value (either custom configuration or process environment variable)
* based on property path (you can use dot notation to traverse nested object, e.g. "database.host").
Expand All @@ -196,7 +205,11 @@ export class ConfigService<
* @param defaultValue
* @param options
*/
getOrThrow<T = K, P extends Path<T> = any, R = PathValue<T, P>>(
getOrThrow<
T = K,
P extends Path<T> = any,
R extends PathValue<T, P> = PathValue<T, P>,
>(
propertyPath: P,
defaultValue: NoInferType<R>,
options: ConfigGetOptions,
Expand Down
28 changes: 28 additions & 0 deletions tests/e2e/optional-generic.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,34 @@ describe('Optional Generic()', () => {
expect(port).toEqual('default');
});

it(`should compile error when return wrong type`, () => {
const configService =
moduleRef.get<ConfigService<{ PORT: string }>>(ConfigService);

// @ts-expect-error: PORT is a string, not a number. Should throw an error
const port: number | undefined = configService.get('PORT', { infer: true });

// @ts-expect-error: PORT is a string, not a number. Should throw an error
const portWithDefaultValue: number = configService.get('PORT', '', {
infer: true,
});
});

it(`should compile error when return wrong type (getOrThrow)`, () => {
const configService =
moduleRef.get<ConfigService<{ PORT: string }>>(ConfigService);

// @ts-expect-error: PORT is a string, not a number. Should throw an error
const port: number = configService.getOrThrow('PORT', {
infer: true,
});

// @ts-expect-error: PORT is a string, not a number. Should throw an error
const portWithDefaultValue: number = configService.getOrThrow('PORT', '', {
infer: true,
});
});

afterEach(async () => {
await app.close();
});
Expand Down