Nimble Prime Musketeers

    @gdyfe/consoles-service
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    ConsolesService

    基于 Rollup + Typescript 开发的广电云父框架服务,包含环境读取服务、父子框架通信服务、登录中心服务


    Features

    • 基于 postMessage 二次封装 FrameSocket 实现握手通信、消息队列、心跳机制等特性
    • 接入日志记录,记录登出接口请求来源、记录环境设置时因意外情况走进异常处理逻辑的情况

    Installing

    script

    1. 下载 dist/consoles-service.min.js 至本地
    2. 使用 script 标签引入到 html 的头部(请放置在所有 js 资源之前)
    3. 配置使用 consolesService
    <html>
      <head>
        <meta charset="UTF-8" />
        <script src="../dist/consoles-service.min.js"></script>
        <script>
          // 所有插件都已经包含在consolesService
          console.log(consolesService)
        </script>
      </head>
    </html>

    package

    npm i @gdyfe/consolesService --save # Install via NPM
    yarn add @gdyfe/consolesService # Install via Yarn
    import consolesService from '@gdyfe/consolesService'
    // or
    import { authKeySetter, IframeMsg, loginCenter } from '@gdyfe/consolesService'

    API

    authKeySetter

    import { authKeySetter } from '@gdyfe/consolesService'
    authKeySetter.getEnvConfig()

    events

    方法名 Description Return
    getEnvConfig 获取环境信息 {CONSOLE_TYPE_KEY:'',LOGIN_TOKEN_KEY:''}

    IframeMsg

    import { IframeMsg } from '@gdyfe/consolesService'
    const iframeMsg = new IframeMsg()
    
    // 使用示例
    iframeMsg.postMsg({
    	cmd: 'xxxx',
      data: {}
    })
    iframeMsg.listenMsg(event => {
    	const data = event.data
    	switch(data.cmd){...}
    })
    
    

    events

    方法名 描述 返回值
    postMsg 用于发送消息
    listenMsg 用于接收消息

    loginCenter

    import { loginCenter } from '@gdyfe/consolesService'
    const userLogin = loginCenter({
      env: 'test',
      baseURL: '',
      token: 'test123123',
      referSign: '',
    })
    userLogin
      .loginOut()
      .then(res => {
        // 成功处理
      })
      .catch(err => {
        // 异常处理
      })

    parameter

    参数 说明 类型 可选值 default
    env 当前环境(必填) string "TEST" | "PRE" |""
    baseURL 网关地址(必填) string "//consoleapi.guangdianyun.tv/v1"
    token 用户 token(必填) string
    referSign 请求来源标记(可选) string

    events

    方法名 描述 返回值
    loginOut 用于登出云平台用户 Promise,接口返回结果

    License

    MIT

    Install

    npm i @gdyfe/consoles-service

    DownloadsWeekly Downloads

    8

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    36.3 kB

    Total Files

    23

    Last publish

    Collaborators

    • whzcorcd
    • laev
    • shelter01