Class DefaultJsonSerializer

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

Implements

JsonSerializer

Index

Constructors

constructor

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

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: AstNodeWithTextRegion,
): undefined | AstNodeWithTextRegion
Parameters
- node: AstNodeWithTextRegion
Returns undefined | AstNodeWithTextRegion
- Defined in packages/langium/src/serializer/json-serializer.ts:226

deserialize

deserialize<T extends AstNode = AstNode>(
content: string,
options?: JsonDeserializeOptions,
): 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:145

`Protected`getRefNode

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

`Protected`linkNode

linkNode(
    node: GenericAstNode,
    root: AstNode,
    options: JsonDeserializeOptions,
    container?: AstNode,
    containerProperty?: string,
    containerIndex?: number,
): 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:250

`Protected`replacer

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

`Protected`reviveReference

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

serialize

serialize(node: AstNode, options?: JsonSerializeOptions): 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:131

Class DefaultJsonSerializer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DefaultJsonSerializer

Properties

Protected ReadonlyastNodeLocator

Protected ReadonlycommentProvider

ProtectedcurrentDocument

ignoreProperties

Protected ReadonlylangiumDocuments

Protected ReadonlynameProvider

Methods

ProtectedaddAstNodeRegionWithAssignmentsTo

Parameters

Returns undefined | AstNodeWithTextRegion

deserialize

Type Parameters

Parameters

Returns T

ProtectedgetRefNode

Parameters

Returns string | AstNode

ProtectedlinkNode

Parameters

Returns void

Protectedreplacer

Parameters

Returns unknown

ProtectedreviveReference

Parameters

Returns undefined | Reference<AstNode> | MultiReference<AstNode>

serialize

Parameters

Returns string

Settings

On This Page

`Protected` `Readonly`astNodeLocator

`Protected` `Readonly`commentProvider

`Protected`currentDocument

`Protected` `Readonly`langiumDocuments

`Protected` `Readonly`nameProvider

`Protected`addAstNodeRegionWithAssignmentsTo

`Protected`getRefNode

`Protected`linkNode

`Protected`replacer

`Protected`reviveReference