Skip to content

chore(Typescript): Updates ServiceMethod and ServiceMethodDynamicSegments to mark methodOptions as required when payload is defined by definition. #709

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

Merged
jbottigliero merged 2 commits into from
Dec 12, 2025
Merged

chore(Typescript): Updates ServiceMethod and ServiceMethodDynamicSegments to mark methodOptions as required when payload is defined by definition. #709

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64262f2
chore(Typescript): Updates ServiceMethod and ServiceMethodDynamicSegm…
jbottigliero Dec 12, 2025
6fb5447
chore: update to generic HasRequiredMethodOptions
jbottigliero Dec 12, 2025
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
36 changes: 24 additions & 12 deletions src/services/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,23 +87,35 @@ export type ServiceMethodOptions = BaseServiceMethodOptions | undefined | never;

export type Segment = string | Record<string, string>;

export type ServiceMethod<O extends ServiceMethodOptions, R extends Response = Response> = (
methodOptions?: O & BaseServiceMethodOptions,
sdkOptions?: SDKOptions,
) => Promise<R>;
type HasRequiredMethodOptions<O extends ServiceMethodOptions> = Partial<O> extends O ? false : true;

export type ServiceMethod<O extends ServiceMethodOptions, R extends Response = Response> =
HasRequiredMethodOptions<O> extends true
? (methodOptions: O & BaseServiceMethodOptions, sdkOptions?: SDKOptions) => Promise<R>
: (methodOptions?: O & BaseServiceMethodOptions, sdkOptions?: SDKOptions) => Promise<R>;

export type ServiceMethodDynamicSegments<
S extends Segment,
O extends ServiceMethodOptions,
R extends Response = Response,
> = (
segments: S,
methodOptions?: O & {
query?: BaseServiceMethodOptions['query'];
headers?: BaseServiceMethodOptions['headers'];
},
sdkOptions?: SDKOptions,
) => Promise<R>;
> =
HasRequiredMethodOptions<O> extends true
? (
segments: S,
methodOptions: O & {
query?: BaseServiceMethodOptions['query'];
headers?: BaseServiceMethodOptions['headers'];
},
sdkOptions?: SDKOptions,
) => Promise<R>
: (
segments: S,
methodOptions?: O & {
query?: BaseServiceMethodOptions['query'];
headers?: BaseServiceMethodOptions['headers'];
},
sdkOptions?: SDKOptions,
) => Promise<R>;

/**
* Provides a type-safe union of a subset of object keys.
Expand Down