# soql-parser-js

> A JavaScript and TypeScript library for parsing, composing and formatting Salesforce SOQL queries. Parses a query into a typed Query data structure, composes that structure back into SOQL, validates syntax, and formats queries. Zero runtime dependencies.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [API](https://soql-parser-js.getjetstream.app/docs/api): Parse a SOQL query string into a Query data structure.
- [CLI](https://soql-parser-js.getjetstream.app/docs/cli): Install globally or use `npx` to interact with the cli.
- [Other Examples](https://soql-parser-js.getjetstream.app/docs/examples): Parsing a SOQL query can be completed by calling `parseQuery(soqlQueryString)`. A `Query` data structure will be returned.
- [Overview](https://soql-parser-js.getjetstream.app/docs/overview): **This library allows parsing and composing (aka generating) SOQL queries from Salesforce using JavaScript or Typescript.**