wip w/ aotds
This commit is contained in:
parent
8c026314f5
commit
33ded1448e
@ -40,7 +40,7 @@
|
|||||||
"typescript": "^4.4.3"
|
"typescript": "^4.4.3"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "dist/index.js",
|
"main": "src/index.js",
|
||||||
"name": "updux",
|
"name": "updux",
|
||||||
"description": "Updeep-friendly Redux helper framework",
|
"description": "Updeep-friendly Redux helper framework",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
26
types/actions.d.ts
vendored
Normal file
26
types/actions.d.ts
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
export type ActionGenerator<TType extends string = string, TPayloadGen = undefined> = {
|
||||||
|
type: TType;
|
||||||
|
} & (TPayloadGen extends Function
|
||||||
|
? (...args: Parameters<TPayloadGen>) => {
|
||||||
|
type: TType;
|
||||||
|
payload: ReturnType<TPayloadGen>;
|
||||||
|
}
|
||||||
|
: (...args: any[]) => { type: TType; payload?: unknown });
|
||||||
|
|
||||||
|
interface Action {
|
||||||
|
<T extends string = string>(actionType: T): ActionGenerator<T>;
|
||||||
|
<T extends string = string, F extends Function = Function>(
|
||||||
|
actionType: T,
|
||||||
|
payloadGen: F
|
||||||
|
): ActionGenerator<T, F>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an action generator.
|
||||||
|
*/
|
||||||
|
export const action: Action;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility type for payload generators that are passthroughs.
|
||||||
|
*/
|
||||||
|
export type Payload<T = unknown> = (arg: T) => T;
|
14
types/index.d.ts
vendored
14
types/index.d.ts
vendored
@ -5,12 +5,8 @@ type Mutation<TState = unknown> = (
|
|||||||
action: Record<string, unknown>
|
action: Record<string, unknown>
|
||||||
) => (state: TState) => TState;
|
) => (state: TState) => TState;
|
||||||
|
|
||||||
type ActionGenerator = { type: string } & ((...args: any[]) => {
|
export * from './actions';
|
||||||
type: string;
|
|
||||||
payload?: unknown;
|
|
||||||
});
|
|
||||||
|
|
||||||
declare module 'updux' {
|
|
||||||
/**
|
/**
|
||||||
* Configuration object typically passed to the constructor of the class Updux.
|
* Configuration object typically passed to the constructor of the class Updux.
|
||||||
*/
|
*/
|
||||||
@ -101,11 +97,3 @@ declare module 'updux' {
|
|||||||
setSelector(name: string, selector: Selector);
|
setSelector(name: string, selector: Selector);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates an action generator.
|
|
||||||
*/
|
|
||||||
export function action(
|
|
||||||
actionType: string,
|
|
||||||
payloadFunction?: Function
|
|
||||||
): ActionGenerator;
|
|
||||||
}
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
import { printType, expectAssignable, expectType } from 'tsd';
|
import { printType, expectAssignable, expectType } from 'tsd';
|
||||||
|
|
||||||
import { Updux } from '.';
|
import { Updux, ActionGenerator, action } from '.';
|
||||||
|
|
||||||
const dux = new Updux({});
|
const dux = new Updux({});
|
||||||
expectType<unknown>( dux.initial );
|
expectType<unknown>( dux.initial );
|
||||||
@ -12,3 +12,16 @@ expectType<unknown>( dux.initial );
|
|||||||
|
|
||||||
expectAssignable<{initial: {a:string}}>(dux);
|
expectAssignable<{initial: {a:string}}>(dux);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ActionGenerator
|
||||||
|
() => {
|
||||||
|
let a = action('a');
|
||||||
|
expectAssignable<{type: string}>(a);
|
||||||
|
expectAssignable<() => {payload?: unknown}>(a);
|
||||||
|
|
||||||
|
let b = action('b', (() => ({})) as unknown as (name: string) => { name: string } );
|
||||||
|
const c = b("foo");
|
||||||
|
expectAssignable<{payload: { name: string } }>(c);
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user