Interface FileStreamParams

Hierarchy

Properties

nativeObject mode isReadable isWritable name path offset seekToEnd? source streamType contentMode

Methods

close readBlob readToEnd write

Properties

nativeObject

nativeObject: { [key: string]: any }

Type declaration

  • [key: string]: any

mode

mode: FileStreamType

Gets the mode of FileStream operation.

Android

Ios

Since

0.1

isReadable

isReadable: boolean

Checks whether the stream is readable.

Android

Ios

Since

0.1

isWritable

isWritable: boolean

Checks whether the stream is writable.

Android

Ios

Since

0.1

name

name: string

Gets the name of the file it belongs to.

Android

Ios

Since

0.1

path

path: string

Gets the path of the file it belongs to.

Android

Ios

Since

0.1

offset

offset: number

iOS only property. Gets the offset of the file stream set as padding.

Ios

Optional seekToEnd

seekToEnd?: (() => void)

Type declaration

    • (): void

    • Scans through the end of the file. See the example in the file and blob.

      IOS

      Returns void

source

source: IFile

streamType

streamType: FileStreamType

contentMode

contentMode: FileContentMode

Gets the content mode of FileStream operation.

Android

Ios

Since

0.1

Methods

close

  • Closes the FileStream instance. FileStream have to be closed when its job is done.

    Android

    Ios

    Since

    0.1

    Returns void

readBlob

  • Gets the Blob object from FileStream.

    Android

    Ios

    Deprecated

    since 1.1.10, you may use FileStream.readToEnd() function after you change contentMode of FileStream to FileStream.ContentMode.BINARY.

    Returns IBlob<any, MobileOSProps<{}, IBlobAndroidProps>>

readToEnd

  • Gets all characters or blob content from the file stream depending of IO.FileStream#ContentMode contentMode content mode. If FileStream not opened with IO.FileStream.StreamType#READ mode, returns null.

    Android

    Ios

    Since

    0.1

    Type Parameters

    Returns ContentType

write

  • Writes all characters or blob content into the file stream depending of IO.FileStream#ContentMode contentMode content mode. If the file stream opened with IO.FileStream.StreamType#READ, returns false.

    Android

    Ios

    Since

    0.1

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc