Skip to content

Latest commit

 

History

History
69 lines (40 loc) · 1.51 KB

API.md

File metadata and controls

69 lines (40 loc) · 1.51 KB

API of baldrick-whisker

List of functions and variables for baldrick-whisker

Functions:

mergeObjects

⎔ Merge several JSON, YAML, elm documents into one

Parameters

  • inputContents: Array of InputContent: a list of JSON and YAML payload to merge

Returns

the merged JsonObject

See merge-objects.ts - L104

parseElmFunctions

⎔ Parse an Elm file content to retrieve the functions

Parameters

  • content: string: Elm file content

Returns

a list of information about each function

See parse-elm-function.ts - L113

readInputFile

⎔ Read a supported input file (JSON, YAML, Elm, Markdown)

Parameters

  • fileId: FileId: a file identifier

Returns

a structure content representing the file

See file-io.ts - L76

saveObjectFile

⎔ Save a JSON object as a JSON or YAML file

Parameters

  • fileId: FileId: a file identifier
  • content: JsonObject: some JSON or YAML content
  • flags: string: drop if the extension must be dropped

See file-io.ts - L154