Skip to content

Latest commit

 

History

History
12 lines (9 loc) · 1.13 KB

file-info-object.md

File metadata and controls

12 lines (9 loc) · 1.13 KB

File Info Object

JSON Schema $Ref Parser supports plug-ins, such as resolvers and parsers. These plug-ins can have methods such as canRead(), read(), canParse(), and parse(). All of these methods accept the same object as their parameter: an object containing information about the file being read or parsed.

The file info object currently only consists of a few properties, but it may grow in the future if plug-ins end up needing more information.

Property Type Description
url string The full URL of the file. This could be any type of URL, including "http://", "https://", "file://", "ftp://", "mongodb://", or even a local filesystem path (when running in Node.js).
extension string The lowercase file extension, such as ".json", ".yaml", ".txt", etc.
data string Buffer etc. The raw file contents, in whatever form they were returned by the resolver that read the file.