跳到主要内容

@ones-op/node-file（已废弃）

已废弃

由于 “@ones-op/node-file” 包存在 bug，当 ONES 版本超过 v3.14.0 时候，请使用 “@ones-op/node-fs” 包进行替换。

我们提供了一套文件操作的相关接口，允许插件开发者对插件文件工作目录下的文件进行操作。

要求​

ONES
v3.6.0+

API​

createFile​

创建文件

Params​

参数说明类型默认值必填
name文件名称string-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { createFile } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testCreateFile() {
  try {
    await createFile('./tmp/test/test.txt')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

makeDir​

创建文件夹

Params​

参数说明类型默认值必填
name文件夹名称string-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { makeDir } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testMakeDir() {
  try {
    await makeDir('./tmp/test/test.txt')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

rename​

修改文件名

Params​

参数说明类型默认值必填
originalPath原文件路径（名称）string-是
newPath新文件路径（名称）string-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { rename } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testRename() {
  try {
    await rename('./tmp/test/test3.txt', './tmp/test/test4.txt')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

remove​

移除文件

Params​

参数说明类型默认值必填
name文件名称string-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { remove } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testRemove() {
  try {
    await remove('./tmp/test/test4.txt')('./tmp/test/test.txt')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

isExist​

判断是否存在该文件或文件夹

Params​

参数说明类型默认值必填
name名称string-是

Returns​

参数说明类型
是否存在存在返回 true，不存在返回 falsebool

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { isExist } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testIsExist() {
  try {
    Logger.info('======isExist', await isExist('./tmp/test/test.txt'))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

isFile​

判断是否为文件类型

Params​

参数说明类型默认值必填
name名称string-是

Returns​

参数说明类型
是否为文件是返回 true，否返回 falsebool

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { isFile } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testIsFile() {
  try {
    Logger.info('======isFile', await isFile('./tmp/test/test.txt'))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

isDir​

判断是否文件夹类型

Params​

参数说明类型默认值必填
name名称string-是

Returns​

参数说明类型
判断是否文件夹类型是返回 true，否返回 falsebool

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { isDir } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testIsDir() {
  try {
    Logger.info('======isDir', await isDir('./tmp'))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

copy​

复制文件

Params​

参数说明类型默认值必填
originalPath文件路径（名称）string-是
newPath目的地路径（名称）string-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { copy } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testCopy() {
  try {
    await copy('./tmp/test/test.txt', './tmp/test/test2.txt')
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

list​

获取文件夹目录

Params​

参数说明类型默认值必填
name名称string-是

Returns​

参数说明类型
文件夹目录列表文件夹目录列表string[]

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { list } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testList() {
  try {
    Logger.info('======List', await list('./tmp/test'))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

read​

读取文件

Params​

参数说明类型默认值必填
name文件路径string-是

Returns​

参数说明类型
文件内容文件内容Uint8Array

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { read } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testRead() {
  try {
    Logger.info('======read', Unit8Array2String((await read('./tmp/test/test.txt')) as Uint8Array))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

readLines​

读取文件指定行

Params​

参数说明类型默认值必填
name文件路径string-是
lineBegin开始行数number-是
lineEnd结束行数number-是

Returns​

参数说明类型
指定行内容文件信息string

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { readLines } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testReadLines() {
  try {
    const lines = await readLines('./tmp/test/test.txt', 0, 1)
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

writeStrings​

文件写入字符串

Params​

参数说明默认值必填类型
name文件路径-是string
content写入内容-是string[]

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { writeStrings } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testWriteStrings() {
  try {
    await writeStrings('./tmp/test/test.txt', ['hello world!\n'])
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

appendStrings​

文件追加写入字符串

Params​

参数说明类型默认值必填
name文件路径string-是
content开始行数string[]-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { appendStrings } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testAppendStrings() {
  try {
    await appendStrings('./tmp/test/test.txt', ['hello world!'])
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

writeBytes​

文件写入字节流

Params​

参数说明类型默认值必填
name文件路径string-是
byteSlice写入字节内容Uint8Array-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400

Example​

import { writeBytes } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testWriteBytes() {
  try {
    await writeBytes('./tmp/test/test.txt', String2Unit8Array('hello bytes!\n'))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

appendBytes​

文件追加写入字节流

Params​

参数说明类型默认值必填
name文件路径string-是
byteSlice追加写入字节内容Uint8Array-是

Error​

errcodereasonlevelstatusCode
InvalidParameterInvalid parameter.error400
File.CannotFindTargetFileNo such file or directory.error400

Example​

import { appendBytes } from '@ones-op/node-file'
import { Logger } from '@ones-op/node-logger'

export async function testAppendBytes() {
  try {
    await appendBytes('./tmp/test/test.txt', Object2Unit8Array({ name: 'hello bytes!' }))
  } catch (error) {
    Logger.error('ERROR: ', error)
  }
}

Type​

FileError​

参数说明类型
level错误等级string
reason错误原因string
statusCode对应的 http 状态码string
errcode错误码string
最后于 更新