Skip to content
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.

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

Add typescript definitions for getStorybook() #753

Merged
merged 7 commits into from
Apr 20, 2017
Merged
Changes from 1 commit
Commits
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
16 changes: 15 additions & 1 deletion config/storybook.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
declare var module: any; // dangerous

type RenderFunction = Function;

interface StoryDecorator {
(story: Function, context: { kind: string, story: string }): Object | null;
(story: RenderFunction, context: { kind: string, story: string }): Object;
}

interface Story {
Expand All @@ -13,3 +15,15 @@ export function addDecorator(decorator: StoryDecorator): void;
export function linkTo(name: string, ...params: any[]): void;
export function storiesOf(name: string, module: any): Story;
export function action(name: string, ...params: any[]): any;

type StoryObject = {
name: string,
render: RenderFunction,
};

type StoryBucket = {
Copy link
Member Author

Choose a reason for hiding this comment

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

Not 100% sure about the naming here, happy to take any suggestion.

kind: string,
stories: StoryObject[],
};

export function getStorybook(): StoryBucket[];