![\"Traqula](\"../../assets/white-on-red/logo-white-on-red-lettered-social.png\"){kind=logo}
\n\n \n
\n A query language transpiler framework for JavaScript\n
\n\n# Traqula SPARQL 1.1 generator\n\n[](https://www.npmjs.com/package/@traqula/generator-sparql-1-1)\n\nTraqula Generator SPARQL 1.1 is a [SPARQL 1.1](https://www.w3.org/TR/sparql11-query/#grammar) query generator for TypeScript.\nIt can generate SPARQL given the AST created by [Traqula parser SPARQL 1.1](https://github.com/comunica/traqula/tree/main/engines/parser-sparql-1-1).\n\n## Installation\n\n```bash\nnpm install @traqula/generator-sparql-1-1\n```\n\nor\n\n```bash\nyarn add @traqula/generator-sparql-1-1\n```\n\n## Import\n\nEither through ESM import:\n\n```javascript\nimport { Generator } from '@traqula/generator-sparql-1-1';\n```\n\n_or_ CJS require:\n\n```javascript\nconst Generator = require('@traqula/generator-sparql-1-1').Generator;\n```\n\n## Usage\n\nThis package contains a `Generator` that is able to generate SPARQL 1.1 queries:\n\n```typescript\nimport { Parser } from '@traqula/parser-sparql-1-1';\nimport { Generator } from '@traqula/generator-sparql-1-1';\nconst query = `SELECT * WHERE { ?s ?p ?o }`\nconst parser = new Parser();\nconst ast = parser.parse(query)\n\nconst generator = new Generator();\nconst queryString = generator.generate(ast);\n```\n\nNote that a single generator cannot generate multiple queries in parallel.\n\n## Configuration\n\nOptionally, the following parameters can be set in to the generator:\n\n* `astFactory`: A custom AstFactory that is able to create the various AST nodes. _(default: `new AstFactory`)_\n* `indentInc`: the number of spaces the built-in 'pretty print' mode must print for a single indentation level. _(default: `2`)_.\n* `origSource`: the original query string the ast is constructed from.\n* `[traqulaIndentation]` from `@traqula/core`: the current number of spaces to print on a newline.\nWhenever this number is negative, no newline will be printed. _(default: 0)_\n* `[traqulaNewlineAlternative]` from `@traqula/core`: the character that should be printed instead of a newline in case `[traqulaIndentation]` is negative. _(default: ' ')_\n\n> [!note]\n> To create a generator without pretty print:\n> ```typescript\n> import { Generator } from '@traqula/generator-sparql-1-1';\n> import { traqulaIndentation } from '@traqula/core';\n> const flatGenerator = new Generator({\n> indentInc: 0,\n> [traqulaIndentation]: -1,\n> })\n> ```\n\n## Round-tripping generation\n\nBy default, the generator will emit the round tripped query string where possible.\nIn order to create an AST that supports round-tripping, you should make sure the [parser is set up correctly](../parser-sparql-1-1/README.md#collecting-round-tripping-information).\n","readmeFilename":"README.md"}