mssql-ts-ffi

Appearance

mssql-ts-ffi / FilestreamHandle

Class: FilestreamHandle ​

Defined in: filestream.ts:14

A handle to a SQL Server FILESTREAM blob. Windows only. Requires an active transaction.

Implements ​

  • AsyncIterable<Uint8Array>
  • AsyncDisposable

Methods ​

[asyncDispose]() ​

[asyncDispose](): Promise<void>

Defined in: filestream.ts:138

Returns ​

Promise<void>

Implementation of ​

AsyncDisposable.[asyncDispose]

[asyncIterator]() ​

[asyncIterator](chunkSize?): AsyncIterableIterator<Uint8Array<ArrayBufferLike>>

Defined in: filestream.ts:101

Parameters ​

chunkSize? ​

number = 65536

Returns ​

AsyncIterableIterator<Uint8Array<ArrayBufferLike>>

Implementation of ​

AsyncIterable.[asyncIterator]

close() ​

close(): void

Defined in: filestream.ts:131

Returns ​

void

read() ​

read(maxBytes?): Promise<Uint8Array<ArrayBufferLike>>

Defined in: filestream.ts:66

Read up to maxBytes. Omit for entire blob.

Parameters ​

maxBytes? ​

number

Returns ​

Promise<Uint8Array<ArrayBufferLike>>

readAll() ​

readAll(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: filestream.ts:78

Returns ​

Promise<Uint8Array<ArrayBufferLike>>

toReadableStream() ​

toReadableStream(chunkSize?): ReadableStream<Uint8Array<ArrayBufferLike>>

Defined in: filestream.ts:110

Parameters ​

chunkSize? ​

number = 65536

Returns ​

ReadableStream<Uint8Array<ArrayBufferLike>>

toWritableStream() ​

toWritableStream(): WritableStream<Uint8Array<ArrayBufferLike>>

Defined in: filestream.ts:123

Returns ​

WritableStream<Uint8Array<ArrayBufferLike>>

write() ​

write(data): Promise<number>

Defined in: filestream.ts:80

Parameters ​

data ​

Uint8Array

Returns ​

Promise<number>

writeFrom() ​

writeFrom(source): Promise<number>

Defined in: filestream.ts:88

Parameters ​

source ​

ReadableStream<Uint8Array<ArrayBufferLike>>

Returns ​

Promise<number>

isAvailable() ​

static isAvailable(ffi): boolean

Defined in: filestream.ts:61

Check if FILESTREAM is available on this platform.

Parameters ​

ffi ​

RuntimeFFI

Returns ​

boolean