Interface Buffer

Buffer类型接口

Hierarchy

Buffer

Index

Methods

Methods

alloc

alloc(size: number): void

给Buffer对象分配一个固定大小的字节数组内存。

Parameters
- size: number
  
  字节数组大小
Returns void

bytes

bytes(): any

获取Buffer对象字节数组。

Returns any

copy

copy(target: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): void

拷贝Buffer对象指定区间[sourceStart, sourceEnd)的字节内容到目标Buffer对象区间[target, ]，

请务必保证目标Buffer对象的内存空间足够。
example
```
import * as buffer from 'buffer';

let source = buffer.from("1234567890");

let target = buffer.empty();
target.alloc(3);
source.copy(target, 0, 5, 8);

console.log(target.toString()); // 678
```
Parameters
- target: Buffer
  
  目标Buffer对象
- Optional targetStart: number
  
  目标起始位置, 默认值为0
- Optional sourceStart: number
  
  源始起始位置，默认值为0
- Optional sourceEnd: number
  
  源结束位置，默认为源Buffer对象的大小
Returns void

equals

equals(otherBuffer: Buffer): boolean

判断两个Buffer对象是否相等，比较原则是按照字节数组进行比较。

Parameters
- otherBuffer: Buffer
Returns boolean

get

get(i: number): number

获取Buffer对象指定位置的字节值。

Parameters
- i: number
  
  位置索引
Returns number

goBuffer

goBuffer(): any

deprecated

该API已经声明在未来版本废弃。

Returns any

set

set(i: number, value: number): void

设置Buffer对象指定位置的字节值

Parameters
- i: number
  
  位置索引
- value: number
  
  字节值
Returns void

size

size(): number

获取Buffer对象字节数组大小。

Returns number

slice

slice(start?: number, end?: number): Buffer

从Buffer对象的一个切片区间[start, end)，并返回一个新的Buffer对象。需要特别注意是：新的Buffer对象，与原Buffer对象共享底层的字节数组内存。
example
```
import * as buffer from 'buffer';

let buf = buffer.from("1234567890");
let slice = buf.slice(5, 8);

console.log(buf.toString()); // 1234567890
console.log(slice.toString()); // 678

slice.set(1, 65);

console.log(buf.toString()); // 123456A890
console.log(slice.toString()); // 6A8
```
Parameters
- Optional start: number
  
  起始位置, 默认值为0
- Optional end: number
  
  结束位置, 默认值为原Buffer的大小。
Returns Buffer

toString

toString(encoding?: Encoding): string

把Buffer对象字节数组转换为字符串内容

Parameters
- Optional encoding: Encoding
  
  字符串编码格式，默认为utf8。
Returns string