kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-06-02 19:43:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

@feathersjs/feathers + @feathersjs/socketio: Minor fixes (#23822)

Browse Source 
* [@feathersjs] add @feathersjs/socket-commons import to @feathersjs/socketio and @feathersjs/primus packages

* [@feathersjs] fix ts version in @feathersjs/socketio and @feathersjs/primus packages

* [@feathersjs] really fix ts version in @feathersjs/socketio and @feathersjs/primus packages

* add express reexports

* @feathersjs/feathers: add generic default type to `Application` interface
@feathersjs/feathers: make Params.paginate optional
@feathersjs/socketio: make callback optional

* change Hook return type from undefined to void

* Update index.d.ts

* disable tslint rule 'void-return' for specific callback

* Update index.d.ts

* Update index.d.ts
This commit is contained in:
Jan Lohage
2018-02-26 20:52:21 +01:00
committed by Andy
parent fe309837c4
commit d2afdde5ba
3 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
types/feathersjs__feathers/index.d.ts vendored
View File

@@ -3,7 +3,7 @@
// Definitions by: Jan Lohage <https://github.com/j2L4e>, Abraao Alves <https://github.com/AbraaoAlves>
// Definitions: https://github.com/feathersjs-ecosystem/feathers-typescript
// TypeScript Version: 2.2
// TypeScript Version: 2.3
/// <reference types="node" />
@@ -30,7 +30,7 @@ export type ServerSideParams = Params;
export interface Params {
query?: Query;
paginate: false | Pick<PaginationOptions, 'max'>;
paginate?: false | Pick<PaginationOptions, 'max'>;
[key: string]: any; // (JL) not sure if we want this
}
@@ -42,10 +42,11 @@ export interface Paginated<T> {
data: T[];
}
export type Hook = <T>(hook: HookContext<T>) => (Promise<HookContext<T>> | undefined);
// tslint:disable-next-line void-return
export type Hook = <T>(hook: HookContext<T>) => (Promise<HookContext<T>> | void);
export interface HookContext<T> {
app?: Application<any>;
app?: Application;
data?: T;
error?: any;
id?: string | number;
@@ -89,7 +90,7 @@ export interface ServiceMethods<T> {
}
export interface SetupMethod {
setup(app: Application<any>, path: string): void;
setup(app: Application, path: string): void;
}
export interface ServiceOverloads<T> {
@@ -106,7 +107,7 @@ export interface ServiceAddons<T> extends EventEmitter {
export type Service<T> = ServiceOverloads<T> & ServiceAddons<T> & ServiceMethods<T>;
export interface Application<ServiceTypes> extends EventEmitter {
export interface Application<ServiceTypes = any> extends EventEmitter {
get(name: string): any;
set(name: string, value: any): this;
@@ -129,7 +130,7 @@ export interface Application<ServiceTypes> extends EventEmitter {
service(location: string): Service<any>;
use(path: string, service: Partial<ServiceMethods<any> & SetupMethod> | Application<any>, options?: any): this;
use(path: string, service: Partial<ServiceMethods<any> & SetupMethod> | Application, options?: any): this;
version: string;
}

6
types/feathersjs__socket-commons/index.d.ts vendored
View File

@@ -28,8 +28,10 @@ declare module '@feathersjs/feathers' {
interface Application<ServiceTypes> {
channel(...names: string[]): Channel;
publish<T>(callback: (data: T, hook: HookContext<T>) => Channel | Channel[]): Application<ServiceTypes>;
// tslint:disable-next-line void-return
publish<T>(callback: (data: T, hook: HookContext<T>) => Channel | Channel[] | void): Application<ServiceTypes>;
publish<T>(event: string, callback: (data: T, hook: HookContext<T>) => Channel | Channel[]): Application<ServiceTypes>;
// tslint:disable-next-line void-return
publish<T>(event: string, callback: (data: T, hook: HookContext<T>) => Channel | Channel[] | void): Application<ServiceTypes>;
}
}

2
types/feathersjs__socketio/index.d.ts vendored
View File

@@ -7,6 +7,6 @@
/// <reference types="socket.io" />
/// <reference types="feathersjs__socket-commons"/>
export default function feathersSocketIO(callback: (io: SocketIO.Server) => void): () => void;
export default function feathersSocketIO(callback?: (io: SocketIO.Server) => void): () => void;
export default function feathersSocketIO(options: number | SocketIO.ServerOptions, callback?: (io: SocketIO.Server) => void): () => void;
export default function feathersSocketIO(port: number, options?: SocketIO.ServerOptions, callback?: (io: SocketIO.Server) => void): () => void;