1.0.31 • Published 4 months ago

app-lib-node v1.0.31

Weekly downloads
-
License
ISC
Repository
github
Last release
4 months ago

一、背景介绍

二、功能描述

三、注意事项

四、使用案列

五、todo列表

六、API

Constants

Functions

NODE_INNER_MODULES

nodejs内置所有模块

  • 常用于webpack编译umd排除使用

Kind: global constant

isExistFile(path) ⇒ boolean

同步判断磁盘文件是否存在

Kind: global function
Returns: boolean - 是否存在 true 存在 false 不存在

ParamTypeDescription
pathstring相对路径

resolve(pathName) ⇒ string

相对路径获取的据对路径

Kind: global function
Returns: string - 据对路径地址

ParamTypeDescription
pathNamestring相对路径地址

isGlobalInstall() ⇒ boolean

判断当前命令是否未全局安装

  • 向上两层判断是否存在node.exe

Kind: global function
Returns: boolean - 是否为全局安装

isExistBin(relativePath, name) ⇒ boolean

是否存在bind

Kind: global function
Returns: boolean - 是否存在bin

ParamTypeDescription
relativePathstring相对路径
namestring组件名称

getBin(compnentName) ⇒ string

获取nodejs的bin执行位置

Kind: global function
Returns: string - 组件的路径

  • tips
  1. 开发模式直接获取当前目录的下的指定配置路径
  2. 局部查找
  3. 全局组件内部
  4. 全局外部
ParamTypeDescription
compnentNamestring组件名称

isDev() ⇒ boolean

是否为app 定义的开发模式

Kind: global function
Returns: boolean - 是否为开发模式

  • tips
  1. cross-env 中不支持中划线 eg:APP-MODLE
  2. MODE 或在 M 值为 DEV 或者DEVELOP, develop,dev
  3. 主要用于该工程的开发模式

getTemplate() ⇒ string

获取模版位置

Kind: global function
Returns: string - 模版位置

readFile(path, options) ⇒ promise

读文件【异步】

Kind: global function
Returns: promise - data | 读取的文件内容

ParamTypeDescription
pathstring | Buffer | URL | integer文件路径
optionsobjectndoejs的配置

readFileSync(path, options) ⇒ string

读文件【同步】

Kind: global function
Returns: string - 文件内容

ParamTypeDescription
pathstring | Buffer | URL | integer文件路径
optionsobjectndoejs的配置

writeFile(path, options) ⇒ promise

写文件【异步】

Kind: global function
Returns: promise - data | 读取的文件内容

ParamTypeDescription
pathstring | Buffer | URL | integer文件路径
optionsobjectndoejs的配置

writeFileSync(path, options) ⇒ string

写文件【同步】

Kind: global function
Returns: string - 文件内容

ParamTypeDescription
pathstring | Buffer | URL | integer文件路径
optionsobjectndoejs的配置

writeFileSyncAndCreate(path, options) ⇒ string

写文件【同步】 不存在文件夹则创建

Kind: global function
Returns: string - 文件内容

ParamTypeDescription
pathstring | Buffer | URL | integer文件路径
optionsobjectndoejs的配置

isExistDir(path) ⇒ boolean

是否为文件夹

Kind: global function
Returns: boolean - 是否为文件夹

ParamTypeDescription
pathstring文件夹路径

getParentDir(path, dirName, layer) ⇒ object

获取指定路径的父级目录包含的文件夹名

Kind: global function
Returns: object - 找的父级的路径

  • example
 {
  path : null 标识不存在 否则标识存在的路径
  layer: number 查到的层级
 }
ParamTypeDefaultDescription
pathstring当前的路径
dirNamestring文件夹名称
layernumber0当前目录到找到目录目录的层级

copyFile(src, dest, isForce, flags) ⇒ promise

复制文件

  • 不存在目录则创建 但是一定是两边都包含文件 否则会报错 operation not permitted, copyfile xxx

Kind: global function

ParamTypeDefaultDescription
srcstring源地址
deststring目标地址
isForcestring文件存在是否强制覆盖 默认false
flagsnumber0复制标识

copyFileSync(src, dest)

单文件强制复制文件

不存在目录则创建 但是一定是两边都包含文件 否则会报错 operation not permitted, copyfile xxx

Kind: global function

ParamTypeDescription
srcstring源文件路径
deststring目标文件路径

mkdir(path, options) ⇒ null

创建目录【同步】

Kind: global function
Returns: null - 无返回

  • tips
  1. https://nodejs.org/docs/latest-v13.x/api/fs.html#fs_fs_mkdir_path_options_callback
ParamTypeDescription
pathstring路径
optionsobject参数

yesOrNo(tips, defaultValue) ⇒ promise

录取用户输入

Kind: global function
Returns: promise - 读取结果

ParamTypeDefaultDescription
tipsstring提示信息
defaultValuestring"yes"默认值

readline(tips, isAlowEmpty) ⇒ promise

录取用户输入

Kind: global function
Returns: promise - 读取结果

ParamTypeDefaultDescription
tipsstring提示信息
isAlowEmptybooleanfalse运行为空

updateContent(options) ⇒ string

文本中添加或者覆盖指定内容

Kind: global function
Returns: string - 新文本

ParamTypeDescription
optionsobject参数
options.contentobject文本内容
options.startflagobject开始标识
options.endFalgobject结束标识
options.appContentobject最佳或者替换的内容
options.isRepalceobject是否为替换 默认是追加 false
options.isStartobject不存在时 追加最前面 默认是后面
options.isInnerStartobject追加文档时 追加在heade与oldcontent之间 默认在尾部
options.spaceobject与标识符的间隔
options.newHeaderobject不存在时候 添加头部内容

getRootPath(relativePath) ⇒ string

获取安装类库的据对目录

Kind: global function
Returns: string - 主目录路径

ParamTypeDefaultDescription
relativePathstring"./"执行文件的相对目录 默认 ../../

getMainPath(relativePath) ⇒ string

当前安装 或者执行命令 的路径

Kind: global function
Returns: string - 新路径

  • tips 默认执行的bin文件 在工程目录的下两层 到当前组件的跟目录层 上一侧目录都为当前组件的目录
ParamTypeDefaultDescription
relativePathstring"../../"相对路径

getBinPath() ⇒ string

获取当前组件bin的路径

Kind: global function
Returns: string - bin路径

readdirSync(path) ⇒ array

读取目录【同步】

Kind: global function
Returns: array - 文件目录

ParamTypeDescription
pathstring目录路径 * @param {object} options 读取配置

delDir(path)

嵌套删除子文件夹和文件

Kind: global function

ParamTypeDescription
pathstring路径

delFile(path)

删除文件【同步】

Kind: global function

ParamTypeDescription
pathstring文件路径

isSysUsePort(port) ⇒ boolean

系统判断端口使用 // TODO 采用静态编译方式 处理静态文件

Kind: global function
Returns: boolean - 事都被占用

ParamTypeDescription
portnumber端口号

getCanUsePort(port) ⇒ number

获取到能够使用的端口

  • 动态自增的方式 直到可用的端口

Kind: global function
Returns: number - 可用的端口

ParamType
portnumber

copyProjectFile(from, to, defaultIsSucess)

复制文件 【异步】

Kind: global function

ParamTypeDefaultDescription
fromstring相对发布组件的目录
tostring相对生成的目录
defaultIsSucessboolean0不存在文件的时候是否默认为成功 默认为成功

copyProjectFileSync(from, to, defaultIsSucess)

复制文件 【同步】

Kind: global function

ParamTypeDefaultDescription
fromstring相对发布组件的目录
tostring相对生成的目录
defaultIsSucessboolean0不存在文件的时候是否默认为成功 默认为成功

copyFolder(source, target)

嵌套复制文件夹 【同步】

Kind: global function

ParamTypeDescription
sourcestring源路径
targetstring目标路径

getLocalIP() ⇒ string

获取本机IP

  • windows验证 其他环境还未验证

Kind: global function
Returns: string - ip地址

  • tips
  1. 目前值返回IPv4 后续可以扩展IPv6

七、发布日志

app-lib-nodenodeumdappbir
app-lib-execapp-lib-logapp-lib-nobuild
app-lib-commondapp-lib-todoapp-lib-trans-storageappbir
1.0.31

4 months ago