@ronin/compiler 0.3.1 → 0.5.0

package/README.md

@@ -39,26 +39,47 @@ You will just need to make sure that, once you [create a pull request](https://d
 The programmatic API of the RONIN compiler looks like this:
 
 ```typescript
-import { compileQueryInput } from '@ronin/compiler';
+import {
+  compileQueries,
 
-const query = {
+  type Query,
+  type Schema,
+  type Statement
+} from '@ronin/compiler';
+
+const queries: Array<Query> = [{
   get: {
-    accounts: null,
-  },
-};
+    accounts: null
+  }
+}];
+
+const schemas: Array<Schema> = [{
+  slug: 'account'
+}];
+
+const statements: Array<Statements> = compileQueries(queries, schemas);
+// [{
+//   statement: 'SELECT * FROM "accounts" ORDER BY "ronin.createdAt" DESC LIMIT 101',
+//   params: [],
+//   returning: true,
+// }]
+```
 
-const schemas = [
-  {
-    slug: 'account',
-  },
-];
+#### Options
 
-const { writeStatements, readStatement } = compileQueryInput(query, schemas);
+To fine-tune the behavior of the compiler, you can pass the following options:
 
-console.log(readStatement);
-// SELECT * FROM "accounts" ORDER BY "ronin.createdAt" DESC LIMIT 101
+```typescript
+compileQueries(queries, schemas, {
+  // Instead of returning an array of values for every statement (which allows for
+  // preventing SQL injections), all values are inlined directly into the SQL strings.
+  // This option should only be used if the generated SQL will be manually verified.
+  inlineValues: true
+});
 ```
 
+#### Transpilation
+
 In order to be compatible with a wide range of projects, the source code of the `compiler` repo needs to be compiled (transpiled) whenever you make changes to it. To automate this, you can keep this command running in your terminal:
 
 ```bash