Interface ConfigFormat

ReadonlyfileExtension

apply

• apply(handle: unknown, changes: ConfigData): string

  Produce updated file text from a handle returned by parse.

  Parameters

  • handle: unknown

    the handle returned by parse for the text being updated.

  • changes: ConfigData

    the complete updated configuration data. The format reconciles the existing text with it, leaving unchanged content (including comments) untouched.

  Returns string

parse

• parse(text: string): { data: ConfigData; handle: unknown }

  Parse configuration file text.

  Parameters

  • text: string

  Returns { data: ConfigData; handle: unknown }

  the parsed data and an opaque handle retaining whatever the format needs to write changes back while preserving comments and layout (undefined if the format has nothing to retain).

  Throws

  if the text is not valid for this format.

serialize

• serialize(data: ConfigData): string

  Produce new file text from scratch.

  Parameters

  • data: ConfigData

  Returns string