Skip to content

Libertas007/lion-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Libertas Object Notation parser

This library can be used to parse text in lion format.

Learn more about lion here: Libertas007/lion

Usage

import { parseText, stringifyDocument } from "lion-parser";

const document = parseText('@doc {example: "example"}');

console.log(stringifyDocument(document));

Functions overview

parseText

This function parses a string to a Lion document. If the input string is invalid, an error is thrown.

import { parseText } from "lion-parser";

const document = parseText('@doc {example: "example"}');

parseTextOrNull

Similar to the previous, this function parses a string to a Lion document. However, if the input string is invalid, it return null instead.

import { parseTextOrNull } from "lion-parser";

const document = parseTextOrNull('@doc {example: "example"}');

parseSchema

This function parses a string to a Lion schema. If the input string is invalid, an error is thrown.

import { parseSchema } from "lion-parser";

const schema = parseSchema("@definition {example: String}");

parseSchemaOrNull

Similar to the previous, this function parses a string to a Lion schema. However, if the input string is invalid, it return null instead.

import { parseSchemaOrNull } from "lion-parser";

const schema = parseSchemaOrNull("@definition {example: String}");

stringifyDocument

This function takes a Lion document and stringifies it.

import { parseText, stringifyDocument } from "lion-parser";

const document = parseText('@doc {example: "example"}');

console.log(stringifyDocument(document));

stringifySchema

This function takes a Lion document and stringifies it.

import { parseSchema, stringifySchema } from "lion-parser";

const document = parseText("@definition {example: String}");

console.log(stringifySchema(document));

analyzeText

This function checks for any errors, which might be in the specified string, and returns them as LionError[].

import { analyzeText } from "lion-parser";

const errors = analyzeText('@doc {example: "example"}');

analyzeSchema

This function checks for any errors, which might be in the specified string, and returns them as LionError[].

import { analyzeSchema } from "lion-parser";

const errors = analyzeSchema("@definition {example: String}");