Class DefaultJsonSerializer

Utility service for transforming an AstNode into a JSON string and vice versa.

Implements

JsonSerializer

Index

Constructors

Properties

astNodeLocator commentProvider currentDocument ignoreProperties langiumDocuments nameProvider

Methods

addAstNodeRegionWithAssignmentsTo deserialize getRefNode linkNode replacer reviveReference serialize

Constructors

constructor

new DefaultJsonSerializer(services): DefaultJsonSerializer
Parameters
- services: LangiumCoreServices
Returns DefaultJsonSerializer
- Defined in packages/langium/src/serializer/json-serializer.ts:122

Properties

`Protected` `Readonly`astNodeLocator

astNodeLocator: AstNodeLocator

`Protected` `Readonly`commentProvider

commentProvider: CommentProvider

`Protected`currentDocument

currentDocument: undefined | LangiumDocument<AstNode>

The document that is currently processed by the serializer; this is used by the replacer function.

ignoreProperties

ignoreProperties: Set<string> = ...

The set of AstNode properties to be ignored by the serializer.

`Protected` `Readonly`langiumDocuments

langiumDocuments: LangiumDocuments

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

Methods

`Protected`addAstNodeRegionWithAssignmentsTo

addAstNodeRegionWithAssignmentsTo(node): undefined | AstNodeWithTextRegion
Parameters
- node: AstNodeWithTextRegion
Returns undefined | AstNodeWithTextRegion
- Defined in packages/langium/src/serializer/json-serializer.ts:203

deserialize

deserialize<T>(content, options?): T
Deserialize (parse) a JSON string into an AstNode.
Type Parameters
- T extends AstNode = AstNode
Parameters
- content: string
- Optionaloptions: JsonDeserializeOptions
Returns T
Implementation of JsonSerializer.deserialize
- Defined in packages/langium/src/serializer/json-serializer.ts:143

`Protected`getRefNode

getRefNode(root, uri, uriConverter?): string | AstNode
Parameters
- root: AstNode
- uri: string
- OptionaluriConverter: ((uri: string) => URI)
  - - (uri): URI
    - Parameters
      uri: string
      Returns URI
Returns string | AstNode
- Defined in packages/langium/src/serializer/json-serializer.ts:283

`Protected`linkNode

linkNode(node, root, options, container?, containerProperty?, containerIndex?): void
Parameters
- node: GenericAstNode
- root: AstNode
- options: JsonDeserializeOptions
- Optionalcontainer: AstNode
- OptionalcontainerProperty: string
- OptionalcontainerIndex: number
Returns void
- Defined in packages/langium/src/serializer/json-serializer.ts:227

`Protected`replacer

replacer(key, value, __namedParameters): unknown
Parameters
- key: string
- value: unknown
- __namedParameters: JsonSerializeOptions
Returns unknown
- Defined in packages/langium/src/serializer/json-serializer.ts:150

`Protected`reviveReference

reviveReference(container, property, root, reference, options): undefined | Reference<AstNode>
Parameters
- container: AstNode
- property: string
- root: AstNode
- reference: IntermediateReference
- options: JsonDeserializeOptions
Returns undefined | Reference<AstNode>
- Defined in packages/langium/src/serializer/json-serializer.ts:250

serialize

serialize(node, options?): string
Serialize an AstNode into a JSON string.
Parameters
- node: AstNode
  The AstNode to be serialized.
- Optionaloptions: JsonSerializeOptions
  Serialization options
Returns string
Implementation of JsonSerializer.serialize
- Defined in packages/langium/src/serializer/json-serializer.ts:129