# @kbfe/kos

> 一款基于react-redux的数据流管理框架，简单轻量，目标是在多端体系下均能使用，与单页和多页方案无关，KOS配合脚手架生成的应用模板，来提供单页多页应用的使用场景

Latest version **0.1.0** (published 2018-06-17) · 0 weekly downloads

## Install

```sh
npm install @kbfe/kos
pnpm add @kbfe/kos
yarn add @kbfe/kos
bun add @kbfe/kos
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-06-17 |
| First published | 2018-06-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | zetay |

## Links

- npm: https://www.npmjs.com/package/@kbfe/kos
- npm.io page: https://npm.io/package/@kbfe/kos

## Dependencies (11)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [react](https://npm.io/package/react.md) ^16.2.0
- [redux](https://npm.io/package/redux.md) 3
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [history](https://npm.io/package/history.md) ^4.7.2
- [react-dom](https://npm.io/package/react-dom.md) ^16.2.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.1
- [react-redux](https://npm.io/package/react-redux.md) ^5.0.7
- [redux-logger](https://npm.io/package/redux-logger.md) 3
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0

## Recent versions

- 0.1.0 (latest) — 2018-06-17

## README

# KOS

一款基于react-redux的数据流管理框架，简单轻量，目标是在多端体系下均能使用，与单页和多页方案无关，KOS配合脚手架生成的应用模板，来提供单页多页应用的使用场景




## KOS

#### KOS.use(middleware)

* **说明：** 新增middleware
* **参数：** 
 + **middleware：** redux中间件
* **返回值：** 无


#### KOS.start(App,Container='#main')

* **说明：** 启动应用，单页应用和多页应用均调用这个API
* **参数：** 
 + **App：** React.Component
 + **Container：** React.Component渲染到的DOM节点，默认是id为main的节点

* **说明：** 用于启动一个应用程序


#### KOS.Wrapper(config)(Component)

* **说明：** 将Component使用Wrapper组件进行包装后，挂在到connect下面，用户将Model和View进行包装
* **参数：**
 + **config.model：** 需要绑定的model，model说明详见 [Model](#)
 + **config.autoLoad：** 在执行到Wrapper的componentDidMount的时候，是否自动执行Model.setup方法
* **返回值：** 和Model结合之后的高阶组件
* **特别说明：**
在项目中，通常建议的使用方式是：

```js
import React from 'react';
import KOS form '@ali/kos';
import model from './model';

@KOS.Wrapper({model})
const class App extends React.Component({
  render(){
    return <div></div>
  }
})
```

#### KOS.registerModel(mode)

* **说明：** 注册model，KOS.Wrapper高阶组件会调用
* **参数：** 
 + **model：** 需要注册的model
* **返回值：** 返回Model对象，注意：此处的Model对象非`KOS.Wrapper({model})`，时传入的model

#### KOS.getModel(namespace)

* **说明：** 根据namespace获取Model对象
* **参数：** 
 + **namepace：**

---
_Source: https://npm.io/package/@kbfe/kos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._