Skip to content

added service type as generic type argument #1291

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
wants to merge 4 commits into
base: next
Choose a base branch
from
+23 −23
Open

added service type as generic type argument #1291

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f20af9b
added service type override for lifecycle events, events, actions, an…
prasadmadanayake-q4us Jun 12, 2024
65b8d04
updated service schema interface
prasadmadanayake-q4us Jun 12, 2024
4bb0b0f
action schema this type fixed
prasadmadanayake-q4us Jun 12, 2024
96b5e04
event schema this type fixed
prasadmadanayake-q4us Jun 12, 2024
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
46 changes: 23 additions & 23 deletions src/service.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,31 @@ import type {
import type { TracingActionTags, TracingEventTags } from "./tracing/tracer";

declare namespace Service {
type ServiceSyncLifecycleHandler<S = ServiceSettingSchema> = (this: Service<S>) => void;
type ServiceAsyncLifecycleHandler<S = ServiceSettingSchema> = (
this: Service<S>
type ServiceSyncLifecycleHandler<S = ServiceSettingSchema, T = Service<S>> = (this: T) => void;
type ServiceAsyncLifecycleHandler<S = ServiceSettingSchema, T = Service<S>> = (
this: T
) => void | Promise<void>;

export interface ServiceSearchObj {
name?: string;
version?: string | number;
}

export interface ServiceSchema<S = ServiceSettingSchema> {
export interface ServiceSchema<S = ServiceSettingSchema, T = Service<S>> {
name: string;
version?: string | number;
settings?: S;
dependencies?: string | ServiceDependency | (string | ServiceDependency)[];
metadata?: any;
actions?: ServiceActionsSchema<S>;
actions?: ServiceActionsSchema<S, T>;
mixins?: Partial<ServiceSchema>[];
methods?: ServiceMethods;
methods?: ServiceMethods<S, T>;
hooks?: ServiceHooks;

events?: EventSchemas<S>;
created?: ServiceSyncLifecycleHandler<S> | ServiceSyncLifecycleHandler<S>[];
started?: ServiceAsyncLifecycleHandler<S> | ServiceAsyncLifecycleHandler<S>[];
stopped?: ServiceAsyncLifecycleHandler<S> | ServiceAsyncLifecycleHandler<S>[];
events?: EventSchemas<S, T>;
created?: ServiceSyncLifecycleHandler<S, T> | ServiceSyncLifecycleHandler<S, T>[];
started?: ServiceAsyncLifecycleHandler<S,T> | ServiceAsyncLifecycleHandler<S,T>[];
stopped?: ServiceAsyncLifecycleHandler<S,T> | ServiceAsyncLifecycleHandler<S,T>[];

// [key: string]: any;
}
Expand Down Expand Up @@ -99,13 +99,13 @@ declare namespace Service {
};
}

export interface ActionSchema {
export interface ActionSchema<S=ServiceSettingSchema, T=Service<S>> {
name?: string;
visibility?: ActionVisibility;
params?: ActionParams;
service?: Service;
cache?: boolean | ActionCacheOptions;
handler?: ActionHandler;
handler?: ActionHandler<S,T>;
tracing?: boolean | TracingActionOptions;
bulkhead?: BulkheadOptions;
circuitBreaker?: BrokerCircuitBreakerOptions;
Expand All @@ -121,13 +121,13 @@ declare namespace Service {
// [key: string]: any;
}

export type ActionHandler = (ctx: Context<any, any>) => Promise<any> | any;
export type ActionHandler<S=ServiceSettingSchema, T=Service<S>> = (this: T,ctx: Context<any, any>) => Promise<any> | any;

export type ServiceActionsSchema<S = ServiceSettingSchema> = {
[key: string]: ActionSchema | ActionHandler | boolean;
} & ThisType<Service<S>>;
export type ServiceActionsSchema<S = ServiceSettingSchema, T = Service<S>> = {
[key: string]: ActionSchema<S,T> & ThisType<T> | ActionHandler<S,T> | boolean;
} & ThisType<T>;

export type ServiceMethods = { [key: string]: (...args: any[]) => any } & ThisType<Service>;
export type ServiceMethods<S = ServiceSettingSchema, T = Service<S>> = { [key: string]: (...args: any[]) => any } & ThisType<T>;

export interface ServiceDependency {
name: string;
Expand Down Expand Up @@ -162,9 +162,9 @@ declare namespace Service {
error?: ServiceHooksError;
}

export type EventSchemaHandler = (ctx: Context) => void | Promise<void>;
export type EventSchemaHandler<S=ServiceSettingSchema, T=Service<S>> = (this:T, ctx: Context) => void | Promise<void>;

export interface EventSchema {
export interface EventSchema<S=ServiceSettingSchema, T=Service<S>> {
name?: string;
group?: string;
params?: ActionParams;
Expand All @@ -174,14 +174,14 @@ declare namespace Service {
throttle?: number;
strategy?: string | typeof Strategy;
strategyOptions?: Record<string, any>;
handler?: EventSchemaHandler;
handler?: EventSchemaHandler<S,T>;

// [key: string]: any;
}

export type EventSchemas<S = ServiceSettingSchema> = {
[key: string]: EventSchemaHandler | EventSchema;
} & ThisType<Service<S>>;
export type EventSchemas<S = ServiceSettingSchema, T = Service<S>> = {
[key: string]: EventSchemaHandler<S,T> | (EventSchema<S,T> & ThisType<T>);
} & ThisType<T>;

export interface WaitForServicesResult {
services: string[];
Expand Down