Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 2.7 KB

API.md

File metadata and controls

46 lines (36 loc) · 2.7 KB
Raw

Functions

metadata(options) ⇒ Promise.<Array.<object>>

Returns the metadata of the given source. Returns a Promise or uses the passed callback.

metadataSync(options) ⇒ Array.<object>

Returns the metadata of the given source synchroniously.

metadata(options) ⇒ Promise.<Array.<object>>

Returns the metadata of the given source. Returns a Promise or uses the passed callback.

Kind: global function
Returns: Promise.<Array.<object>> - A promise that contains the metadata for the media in an Array of Objects
Export:

Param Type Default Description
options object
options.source string | Array.<string> | Buffer The media for which we want to extract the metadata
[options.tags] Array.<string> List of metadata tags to whitelist or blacklist (add '-' before each tag). See ExifTool Tag Names for available tags.
[options.useBufferLimit] boolean true Allows the limiting the size of the buffer that is piped into ExifTool
[options.maxBufferSize] number 10000 Size of the buffer that is piped into ExifTool
[options.callback] metadataCallback Callback that receives the metadata

metadataSync(options) ⇒ Array.<object>

Returns the metadata of the given source synchroniously.

Kind: global function
Returns: Array.<object> - An array of objects that contains the metadata for each media
Export:

Param Type Default Description
options object
options.source string | Array.<string> | Buffer The media for which we want to extract the metadata
[options.tags] Array.<string> List of metadata tags to whitelist or blacklist (add '-' before each tag). See ExifTool Tag Names for available tags.
[options.useBufferLimit] boolean true Allows the limiting the size of the buffer that is piped into ExifTool
[options.maxBufferSize] number 10000 Size of the buffer that is piped into ExifTool