# @beisen/helper

> ----

Latest version **1.0.7** (published 2019-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @beisen/helper
pnpm add @beisen/helper
yarn add @beisen/helper
bun add @beisen/helper
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-11-01 |
| First published | 2019-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Unpacked size | 34.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | liugenpeng |
| Maintainers | beisencorp, lgm, liugenpeng, neozw |

## Links

- npm: https://www.npmjs.com/package/@beisen/helper
- npm.io page: https://npm.io/package/@beisen/helper

## Recent versions

- 1.0.7 (latest) — 2019-11-01
- 1.0.6 — 2019-10-31
- 1.0.5 — 2019-10-31
- 1.0.4 — 2019-07-27
- 1.0.3 — 2019-07-26
- 1.0.2 — 2019-07-26
- 1.0.1 — 2019-07-23
- 1.0.0 — 2019-07-22
- 0.1.6 — 2019-07-22
- 0.1.5 — 2019-07-22
- 0.1.4 — 2019-07-21
- 0.1.3 — 2019-07-21
- 0.1.2 — 2019-07-21
- 0.1.1 — 2019-07-21
- 0.1.0 — 2019-07-21

## README

### 域名助手
----

```
根据BSGlobal中domain值生成域名的工具(BSGlobal.domain必须存在)
```

#### 安装

```
  npm i -S @beisen/helper@latest
  or
  yarn add @beisen/helper@latest

```

#### API介绍

#### 1. generateHost(host)
返回值: `string`<br>
根据三级域名生成整体域名
##### host
类型: `string`<br>
三级域名的名称. 必须为`string`类型.

##### 示例

```
// 承载页上BSGlobal.domain = 'beisen.cn'

import BSHelper from '@beisen/helper';

const demoHost = BSHelper.generateHost('demo');

// demoHost === '//demo.beisen.cn'

```

#### 2. getHostByType(type)
返回值: `string`<br>
根据type获取平台域名(iTalent/多租赁/审批/租户配置中心等).
##### type
类型: `string`<br>
平台域名. 枚举，必须为`string`<br>
类型可选值：<br>

type|站点|备注
---|:--:|---:
italent |iTalent | -
tm|iTalent 移动端| -
setting |iTalent 设置站点| -
account | account | -
cloud|多租赁| -
ocean |ocean | -
appcenter|appcenter| -
robot |机器人 | 机器人
operationCloud|operationcloud| -
appstore | 应用商店 | -
approval|审批中心| -
tms|tms后台| -
landingsite | landingsite | -
docCloud | 文件预览 | -
settingCloud | 实施态 | -
devCloud | 开发态 | -
service | 帮助文档 | -


##### 示例

```
// 承载页上BSGlobal.domain = 'beisen.cn'
import BSHelper from '@beisen/helper';
const demoHost = BSHelper.getHostByType('cloud');
// demoHost === '//cloud.beisen.cn'
```
#### 3. getUserInfo(type)
返回值: `Object`<br>
获取当前登录人信息(BSGloabl中loginUserInfo字段).

##### 示例
```
import BSHelper from '@beisen/helper';
const userInfo = BSHelper.getUserInfo();
```

#### 4. getTenantInfo()
返回值: `Object`<br>
获取当前登录人租户信息(BSGloabl中tenantInfo字段).

##### 示例

```
import BSHelper from '@beisen/helper';
const tenantInfo = BSHelper.getTenantInfo();
```
#### 5. getUserId()
返回值: `number`<br>
获取当前登录人Id.

##### 示例
```
import BSHelper from '@beisen/helper';
const userId = BSHelper.getUserId();
```
#### 6. getTenantId()
返回值: `number`<br>
获取当前登录人租户Id.

##### 示例
```
import BSHelper from '@beisen/helper';
const tenantId = BSHelper.getTenantId();
```

#### 7. env.isDevelopment()
返回值: `boolean`<br>
获取当前是否为开发环境.

##### 示例
```
import BSHelper from '@beisen/helper';
const tenantId = BSHelper.env.isDevelopment();
```

#### 8. env.isTesting()
返回值: `boolean`<br>
获取当前是否为测试环境.

##### 示例
```
import BSHelper from '@beisen/helper';
const isTesting = BSHelper.env.isTesting();
```

#### 9. env.isProduction()
返回值: `boolean`<br>
获取当前是否为线上.

##### 示例
```
import BSHelper from '@beisen/helper';
const isProdction = BSHelper.env.isProduction();
```

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