Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParseOpts

Hierarchy

  • ParseOpts

Indexable

[id: string]: any

Index

Properties

decrypt

decrypt: boolean

If true, tagged #gpg values will be decrypted. NodeJS only and requires GPG with all keys used to encrypt the values installed on host.

defaultvalue

false

includes

includes: boolean

If true, parser will include referenced source files and read tagged #file values.

defaultvalue

true

prefixes

prefixes: boolean

If true, IDs of the prefix:name form, will be expanded using pre-declared @prefixes. If enabled and a prefix cannot be resolved, the parser will throw an error.

Prefixes can be overridden on a per-file basis. If an included file defines its own prefixes, they will only be in scope for triples defined in that file.

defaultvalue

false

prune

prune: boolean

Only used if resolve option is enabled. If true, nodes with only the reserved $id property (and no other user defined properties) will be removed from the graph after parsing is complete.

Such nodes are usually only indirectly created through forward node references and they're only removed as top-level items in the result graph object. Any references from other nodes will remain intact.

defaultvalue

false

resolve

resolve: boolean

If true, #ref-tagged values will be resolved and used as value instead of their referred node ID. Circular dependencies ARE supported.

If false, #ref values will be stored as NodeRef values in the result object to allow them to be identified as references.

In both cases, if the prefixes option is enabled, the referenced IDs will/might first be expanded (iff they match the prefix:name pattern).

defaultvalue

false

Generated using TypeDoc