IFileAbstraction.md

node-taglib-sharp / Exports / IFileAbstraction

Interface: IFileAbstraction

This interface provides abstracted access to a file. It permits access to non-standard file systems and data retrieval methods.

Implemented by

• LocalFileAbstraction

Table of contents

Properties

• name
• readStream
• writeStream

Methods

• closeStream

Properties

name

• name: string

Name or identifier used by the implementation

Remarks

This value would typically represent a path or URL to be used when identifying the file system, but it could be any valid as appropriate for the implementation.

---

readStream

• readStream: IStream

Readable, seekable stream for the file referenced by the current instance.

Remarks

This property is typically used when constructing an instance of File. Upon completion of the constructor closeStream will be called to close the stream. If the stream is to be reused after this point, closeStream should be implemented in a way to keep it open.

---

writeStream

• writeStream: IStream

Writable, seekable stream for the file referenced by the current instance.

Remarks

This property is typically used when saving a file with save. Upon completion of the method, closeStream will be called to close the stream. If the stream is to be reused after this point, closeStream should be implemented in a way to keep it open

Methods

closeStream

▸ closeStream(stream): void

Closes a stream created by the current instance.

Parameters

Name	Type	Description
stream	IStream	Stream created by the current instance.

Returns

void