Skip to content

📑️ Add type declarations in order to enable better IDE integration #21

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
glippi wants to merge 3 commits into
base: master
Choose a base branch
from
Open

📑️ Add type declarations in order to enable better IDE integration #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d4b51d
📑️ Add type declarations in order to enable better IDE integration an…
glippi Apr 18, 2020
8cde124
🗑️ Delete comments
glippi Apr 20, 2020
fe8e97c
Fix Effect definition and improve types for registerEventHandler
glippi May 3, 2020
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
31 changes: 31 additions & 0 deletions packages/reffects/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
interface Event {
id: string;
payload?: object;
}

interface Effect {
[effectName: string]: object
}

interface Coeffect{
id: string;
data?: object;
}

type EventHandler = (coeffect?: Coeffect, payload?: object) => Effect;
Copy link
Contributor

@mariosanchez mariosanchez Apr 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should return an object with many Effects inside, not sure how to represent it in TypeScript :)

Copy link
Contributor

@mariosanchez mariosanchez Apr 21, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify, this is how an event handler return looks like:

return {
        'state.set': {
          todos: newTodos,
        },
        toast: {
          text: `"${text}" was marked as ${isDone ? 'undone' : 'done'}.`,
          milliseconds: 3000,
        },
      };


type EffectHandler = Function;

type CoeffectHandler = Function;

export function dispatch(event: Event): void;
export function dispatchMany(events: Event[]): void;
export function dispatchLater(event: Event): void;
export function registerEventHandler(eventId: string, handler: EventHandler, coeffectDescriptions?: Coeffect[]): void;
export function registerCoeffectHandler(coeffectId: string, handler: CoeffectHandler): void;
export function registerEffectHandler(effectId: string, handler: EffectHandler): void;
export function registerEventsDelegation(originalEvents: string[], targetEvent: string): void;
export function coeffect(id: string, data?: object): Coeffect;
export function getEffectHandler(effectId: string): EffectHandler;
export function getCoeffectHandler(coeffectId: string): CoeffectHandler;
export function getEventHandler(eventId: string): EventHandler;
1 change: 1 addition & 0 deletions packages/reffects/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"main": "dist/reffects.js",
"umd:main": "dist/reffects.umd.js",
"keywords": [],
"types": "index.d.ts",
"devDependencies": {
"@babel/core": "^7.4.3",
"@babel/preset-env": "^7.4.3",
Expand Down