https://github.com/hecom-rn/loginprocess

登陆进程管理模块。
https://github.com/hecom-rn/loginprocess

Last synced: over 1 year ago
JSON representation

登陆进程管理模块。

• Host: GitHub
• URL: https://github.com/hecom-rn/loginprocess
• Owner: hecom-rn
• License: mit
• Created: 2019-05-14T12:07:56.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-14T07:20:10.000Z (about 5 years ago)
• Last Synced: 2024-04-25T05:21:06.102Z (about 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LoginProcess

[![npm version](https://img.shields.io/npm/v/@hecom/loginprocess.svg?style=flat)](https://www.npmjs.com/package/@hecom/loginprocess)

[![Build Status](https://travis-ci.org/hecom-rn/loginprocess.svg?branch=master)](https://travis-ci.org/hecom-rn/loginprocess)

这是登陆进度管理模块，包括触发事件、注册事件监听和占用的权重。

## 安装

```shell

npm install --save @hecom/loginprocess

```

## 使用方法

```javascript

import LoginProcess from '@hecom/loginprocess';

```

## 事件类型

* 登陆事件：类型为`[LoginEvent]`；数据为`forceUpdate`，表示是否强制更新。

* 登出事件：类型为`[LogoutEvent]`；数据为`forceClear`，表示是否强制清除持久化存储。

## 接口

* `register: (loginFunc, logoutFunc, flex, name) => void`：注册登陆或登出的接收通知的函数，以及进度条的进度项，包括权重`flex`和名称`name`。

* `registerEvent: (flex, name) => void`：只注册进度条的进度项，调用`register`完成操作。

* `triggerLogin: (forceUpdate) => void`：触发登陆事件，`forceUpdate`表示是否强制更新。

* `triggerLogout: (forceClear) => void`：触发登出事件，`forceClear`表示是否强制登出。

* `mark: (name, isSuccess, error) => void`：标记某个进度项为成功或失败状态。

* `startLoginProcess: () => promise`：开始登录时调用，返回登录状态。