rekit-core - Documentation

The default module of the rekit-core package. It does two things:

Wraps modularized APIs to Rekit core commands.
Exports other modules. i.e. require('rekit-core').component equals to require('rekit-core/component').

Source:

index.js, line 3

Members

(static, constant) action

Source:

index.js, line 50

Quick access to rekit-core/action.

(static, constant) app

Source:

index.js, line 26

Quick access to rekit-core/app.

(static, constant) component

Source:

index.js, line 32

Quick access to rekit-core/component.

(static, constant) feature

Source:

index.js, line 56

Quick access to rekit-core/feature.

(static, constant) style

Source:

index.js, line 38

Quick access to rekit-core/style.

(static, constant) test

Source:

index.js, line 44

Quick access to rekit-core/test.

(static, constant) utils

Source:

index.js, line 62

Quick access to rekit-core/utils.

(static, constant) vio

Source:

index.js, line 74

Quick access to rekit-core/vio.

(static, constant) vio

Source:

index.js, line 68

Quick access to rekit-core/vio.

Methods

(static) addAction(feature, name)

Source:

index.js, line 220

Add an action and its unit test.

Parameters:

Name	Type	Description
`feature`	string	the feature where to create the action.
`name`	string	the action name, will be converted to camel case.

(static) addAsyncAction(feature, name)

Source:

index.js, line 181

Add an async action using redux-thunk and its unit test.

Parameters:

Name	Type	Description
`feature`	string	the feature where to create the action.
`name`	string	the action name, will be converted to camel case.

(static) addComponent(feature, name, args)

Source:

index.js, line 100

Add a component including unit test and style files. It wraps APIs from component, style and test.

Example

Create a container component

const rekitCore = require('rekit-core');

// Add a component named 'TopicList' which is connected to Redux store.
rekitCore.addComponent('home', 'topic-list', { connect: true });

// Write the changes to disk. Otherwise only in memory, see more at rekitCore/vio
rekitCore.vio.flush();

Parameters:

Name	Type	Description
`feature`	string	the feature where to create the component.
`name`	string	the component name, will be converted to pascal case.
`args`	object	other args.

(static) addFeature(name)

Source:

index.js, line 274

Add a feature with one sample component. Besides creating feature folder and files, it also registers reducer, router config, style to root config of the app.

Parameters:

Name	Type	Description
`name`	string	the feature name.

(static) handleCommand()

Source:

index.js, line 337

Handle the parse result of Rekit command, like rekit add component home/hello.

(static) moveAction(source, target)

Source:

index.js, line 256

Move/rename an action including unit test.

Parameters:

Name	Type	Description
`source`	object	which action to be moved, in form of { name: {string}, feature: {string} }.
`target`	object	where to move, in form of { name: {string}, feature: {string} }.

(static) moveAsyncAction(source, target)

Source:

index.js, line 207

Move/rename an async action including unit test.

Parameters:

Name	Type	Description
`source`	ElementArg	Which action to be moved.
`target`	ElementArg	Where to move.

(static) moveComponent(source, target)

Source:

index.js, line 161

Move/rename a component including unit test and style files. It wraps APIs from component, style and test.

Example

Rename TopicList to Topics

const rekitCore = require('rekit-core');

// Rename the component from 'TopicList' to 'Topics'
rekitCore.moveComponent({ feautre: 'home', name: 'topic-list' }, { feautre: 'home', name: 'topics' });

// Write the changes to disk. Otherwise only in memory, see more at rekitCore/vio
rekitCore.vio.flush();

Parameters:

Name	Type	Description
`source`	object	which component to be moved, in form of { name: {string}, feature: {string} }.
`target`	object	where to move, in form of { name: {string}, feature: {string} }.

(static) moveFeature(oldName, newName)

Source:

index.js, line 306

Rename a feature

Parameters:

Name	Type	Description
`oldName`	string	Old name of the feature.
`newName`	string	New name of the feature.

(static) removeAction(feature, name)

Source:

index.js, line 238

Remove an action and its unit test.

Parameters:

Name	Type	Description
`feature`	string	the feature of the action.
`name`	string	the action name, will be converted to camel case.

(static) removeAsyncAction(feature, name)

Source:

index.js, line 194

Remove an async action and its unit test.

Parameters:

Name	Type	Description
`feature`	string	the feature of the action.
`name`	string	the action name, will be converted to camel case.

(static) removeComponent(feature, name)

Source:

index.js, line 136

Remove a component including unit test and style files. It wraps APIs from component, style and test.

Example

Remove a container component

const rekitCore = require('rekit-core');

// Remove a component named 'TopicList' which is connected to Redux store.
rekitCore.removeComponent('home', 'topic-list');

// Write the changes to disk. Otherwise only in memory, see more at rekitCore/vio
rekitCore.vio.flush();

Parameters:

Name	Type	Description
`feature`	string	the feature where to create the component.
`name`	string	the component name, will be converted to pascal case.

(static) removeFeature(name)

Source:

index.js, line 291

Remove a feature.

Parameters:

Name	Type	Description
`name`	string	the feature name.

Type Definitions

ElementArg

Source:

index.js, line 12

Properties:

Name	Type	Description
`feature`	string	The feature of the element.
`name`	string	The name of the element.

The combination of feature and name of an element like component.

Type:

Object