Class FileHandle<P>

Type parameters

P: Path

Hierarchy

FileHandle

Constructors

constructor

Properties

Accessors

fd

Methods

Constructors

constructor

new FileHandle(fd: number, baseFs: FakeFS<P>): FileHandle

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:76
Parameters
- fd: number
- baseFs: FakeFS<P>
Returns FileHandle

Properties

[kBaseFs]

[kBaseFs]: FakeFS<P>

[kClosePromise]

[kClosePromise]: Promise<void> | undefined = undefined

[kCloseReject]

[kCloseReject]: function | undefined = undefined

[kCloseResolve]

[kCloseResolve]: function | undefined = undefined

[kFd]

[kFd]: number

[kRefs]

[kRefs]: number = 1

Accessors

fd

get fd(): number

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:83
Returns number

Methods

[kRef]

[kRef](caller: Function): void

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:350
Parameters
- caller: Function
Returns void

[kUnref]

[kUnref](): void

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:361
Returns void

appendFile

appendFile(data: string | Uint8Array, options?: ObjectEncodingOptions & FlagAndOpenMode | BufferEncoding | null): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:87
Parameters
- data: string | Uint8Array
- Optional options: ObjectEncodingOptions & FlagAndOpenMode | BufferEncoding | null
Returns Promise<void>

chmod

chmod(mode: number): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:109
Parameters
- mode: number
Returns Promise<void>

chown

chown(uid: number, gid: number): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:100
Parameters
- uid: number
- gid: number
Returns Promise<void>

close

close(): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:323
Returns Promise<void>

createReadStream

createReadStream(options?: CreateReadStreamOptions): ReadStream

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:118
Parameters
- Optional options: CreateReadStreamOptions
Returns ReadStream

createWriteStream

createWriteStream(options?: CreateWriteStreamOptions): WriteStream

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:122
Parameters
- Optional options: CreateWriteStreamOptions
Returns WriteStream

datasync

datasync(): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:127
Returns Promise<void>

read

read(options?: FileReadOptions<Buffer>): Promise<FileReadResult<Buffer>>
read(buffer: Buffer, offset?: number | null, length?: number | null, position?: number | null): Promise<FileReadResult<Buffer>>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:136
Parameters
- Optional options: FileReadOptions<Buffer>
Returns Promise<FileReadResult<Buffer>>
- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:137
Parameters
- buffer: Buffer
- Optional offset: number | null
- Optional length: number | null
- Optional position: number | null
Returns Promise<FileReadResult<Buffer>>

readFile

readFile(options?: object | null): Promise<Buffer>
readFile(options: object | BufferEncoding): Promise<string>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:185
Parameters
- Optional options: object | null
Returns Promise<Buffer>
- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:191
Parameters
- options: object | BufferEncoding
Returns Promise<string>

readLines

readLines(options?: CreateReadStreamOptions): Interface

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:216
Parameters
- Optional options: CreateReadStreamOptions
Returns Interface

readv

readv(buffers: ReadonlyArray<NodeJS.ArrayBufferView>, position?: undefined | number): Promise<ReadVResult>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:319
Parameters
- buffers: ReadonlyArray<NodeJS.ArrayBufferView>
- Optional position: undefined | number
Returns Promise<ReadVResult>

stat

stat(opts?: StatOptions & object): Promise<Stats>
stat(opts: StatOptions & object): Promise<BigIntStats>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:223
Parameters
- Optional opts: StatOptions & object
Returns Promise<Stats>
- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:228
Parameters
- opts: StatOptions & object
Returns Promise<BigIntStats>

sync

sync(): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:132
Returns Promise<void>

truncate

truncate(len?: undefined | number): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:242
Parameters
- Optional len: undefined | number
Returns Promise<void>

utimes

utimes(atime: string | number | Date, mtime: string | number | Date): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:252
Parameters
- atime: string | number | Date
- mtime: string | number | Date
Returns Promise<void>

write

write(...args: WriteArgsString): Promise<object>
write<TBuffer>(...args: WriteArgsBuffer<TBuffer>): Promise<object>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:269
Parameters
- Rest ...args: WriteArgsString
Returns Promise<object>
- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:270
Type parameters
- TBuffer: Uint8Array
Parameters
- Rest ...args: WriteArgsBuffer<TBuffer>
Returns Promise<object>

writeFile

writeFile(data: string | Uint8Array, options?: ObjectEncodingOptions & FlagAndOpenMode & Abortable | BufferEncoding | null): Promise<void>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:256
Parameters
- data: string | Uint8Array
- Optional options: ObjectEncodingOptions & FlagAndOpenMode & Abortable | BufferEncoding | null
Returns Promise<void>

writev

writev(buffers: Array<NodeJS.ArrayBufferView>, position?: undefined | number): Promise<WriteVResult>

- Defined in packages/yarnpkg-fslib/sources/patchFs/FileHandle.ts:290
Parameters
- buffers: Array<NodeJS.ArrayBufferView>
- Optional position: undefined | number
Returns Promise<WriteVResult>

Generated using TypeDoc