LiquidJS

https://liquidjs.com
Admin
LiquidJS is a simple, expressive and safe Shopify and GitHub Pages compatible template engine in...
Tokens:184,046
Snippets:1,733
Trust Score:9.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### start

Source: https://liquidjs.com/api/classes/ParseStream.html

Starts the parsing process and returns the ParseStream instance for chaining.

```APIDOC
## start

### Description
Starts the parsing process and returns the ParseStream instance for chaining.

### Method
start

### Signature
start(): ParseStream<T>

### Returns
ParseStream<T>
```

--------------------------------

### listeners method example

Source: https://liquidjs.com/api/interfaces/_internal_.EventEmitter.html

Shows how to use the listeners method to get a copy of the array of listeners for a specific event. The example uses a server object and prints the listeners for the 'connection' event.

```javascript
server.on('connection', (stream) => {  
  console.log('someone connected!');  
});  
console.log(util.inspect(server.listeners('connection')));  
// Prints: [ [Function] ]
```

--------------------------------

### Custom output delimiters example

Source: https://liquidjs.com/tutorials/options.html

Shows using outputDelimiterLeft and outputDelimiterRight to set delimiters to <%= and %> to avoid conflicts with other languages. The example outputs a welcome message with the username variable.

```liquid
<%= username | append: ", welcome to LiquidJS!" %>
```

--------------------------------

### raw tag output example

Source: https://liquidjs.com/tags/raw.html

The output of the raw tag example, showing the content as-is without processing.

```text
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
```

--------------------------------

### Install LiquidJS via npm

Source: https://liquidjs.com/api/index.html

Installs the LiquidJS package for Node.js projects.

```bash
npm install liquidjs
```

--------------------------------

### Buffer.write() example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Writes a string to a buffer at a specified offset and logs the number of bytes written and the buffer content. The example shows writing a Unicode string and a short string with an offset.

```javascript
import { Buffer } from 'node:buffer';  

const buf = Buffer.alloc(256);  

const len = buf.write('\u00bd + \u00bc = \u00be', 0);  

console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);  
// Prints: 12 bytes: ½ + ¼ = ¾  

const buffer = Buffer.alloc(10);  

const length = buffer.write('abcd', 8);  

console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);  
// Prints: 2 bytes : ab
```

--------------------------------

### Basic division output: 4

Source: https://liquidjs.com/filters/divided_by.html

Output of the previous example: the string '4'.

```text
4
```

--------------------------------

### readBigUInt64LE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads an unsigned 64-bit little-endian integer from a Buffer. The example creates a Buffer and logs the result, which is 18446744069414584320n.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);  
  
console.log(buf.readBigUInt64LE(0));  
// Prints: 18446744069414584320n
```

--------------------------------

### upcase filter input example (already uppercase)

Source: https://liquidjs.com/filters/upcase.html

Example input for the upcase filter with an already uppercase string.

```liquid
{{ "APPLE" | upcase }}
```

--------------------------------

### Output of find_exp example

Source: https://liquidjs.com/filters/find_exp.html

Expected output of the find_exp example: the first object in the array that satisfies the expression, serialized as JSON.

```json
{"graduation_year":2014,"name":"John"}
```

--------------------------------

### unshift filter output example

Source: https://liquidjs.com/filters/unshift.html

The output of the unshift example, showing the array with 'apples' prepended, resulting in a list of apples, oranges, and peaches.

```text
- apples
- oranges
- peaches
```

--------------------------------

### readUIntLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a little-endian unsigned integer with a specified byte length (up to 6 bytes). The example reads 6 bytes at offset 0 and prints the hexadecimal result.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);  
  
console.log(buf.readUIntLE(0, 6).toString(16));  
// Prints: ab9078563412
```

--------------------------------

### readIntLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a little-endian signed integer of specified byteLength (up to 6 bytes) from a Buffer. The example shows reading 6 bytes at offset 0 prints -546f87a9cbee.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);  
  
console.log(buf.readIntLE(0, 6).toString(16));  
// Prints: -546f87a9cbee
```

--------------------------------

### readDoubleLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a 64-bit little-endian double from a Buffer. The example logs the result and shows that an invalid offset throws ERR_OUT_OF_RANGE.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);  
  
console.log(buf.readDoubleLE(0));  
// Prints: 5.447603722011605e-270  
console.log(buf.readDoubleLE(1));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### readInt8 example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a signed 8-bit integer from a Buffer. The example shows reading at offsets 0 and 1 prints -1 and 5, and reading at offset 2 throws ERR_OUT_OF_RANGE.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([-1, 5]);  
  
console.log(buf.readInt8(0));  
// Prints: -1  
console.log(buf.readInt8(1));  
// Prints: 5  
console.log(buf.readInt8(2));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### writeIntLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Writes a signed integer as little-endian with a specified byte length (up to 6 bytes). The value must be a signed integer; behavior is undefined otherwise. The example writes 0x1234567890ab with byteLength 6 and prints the resulting Buffer.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.allocUnsafe(6);  
  
buf.writeIntLE(0x1234567890ab, 0, 6);  
  
console.log(buf);  
// Prints: <Buffer ab 90 78 56 34 12>
```

--------------------------------

### Buffer.includes() usage example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Demonstrates how to use Buffer.includes() to search for strings, numbers, and Buffer objects within a buffer. The example shows various cases including searching with a byte offset and using a sliced buffer. The output comments indicate the expected boolean results.

```javascript
import { Buffer } from 'node:buffer';  

const buf = Buffer.from('this is a buffer');  

console.log(buf.includes('this'));  
// Prints: true  
console.log(buf.includes('is'));  
// Prints: true  
console.log(buf.includes(Buffer.from('a buffer')));  
// Prints: true  
console.log(buf.includes(97));  
// Prints: true (97 is the decimal ASCII value for 'a')  
console.log(buf.includes(Buffer.from('a buffer example')));  
// Prints: false  
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));  
// Prints: true  
console.log(buf.includes('this', 4));  
// Prints: false
```

--------------------------------

### Buffer.equals example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Compares two Buffer instances for exact byte equality. The example shows that Buffer.from('ABC') equals Buffer.from('414243', 'hex') and does not equal Buffer.from('ABCD').

```javascript
import { Buffer } from 'node:buffer';  
  
const buf1 = Buffer.from('ABC');  
const buf2 = Buffer.from('414243', 'hex');  
const buf3 = Buffer.from('ABCD');  
  
console.log(buf1.equals(buf2));  
// Prints: true  
console.log(buf1.equals(buf3));  
// Prints: false
```

--------------------------------

### Render a file with renderFile

Source: https://liquidjs.com/tutorials/render-file.html

Creates a Liquid engine with root and extname options, then renders 'hello' with data. Outputs 'name: alice'.

```javascript
var engine = new Liquid({
    root: path.resolve(__dirname, 'views/'),  // root for layouts/includes lookup
    extname: '.liquid'          // used for layouts/includes, defaults ""
});
engine
    .renderFile("hello", {name: 'alice'})   // will read and render `views/hello.liquid`
    .then(console.log)  // outputs "Alice"

```

--------------------------------

### upcase filter output example (already uppercase)

Source: https://liquidjs.com/filters/upcase.html

Output of the upcase filter for the input 'APPLE'.

```text
APPLE
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/Liquid.html

Creates a new Liquid instance with optional configuration options.

```APIDOC
## constructor

### Description
Creates a new Liquid instance with optional configuration options.

### Method
constructor

### Parameters
- **opts** (LiquidOptions) - Optional - Configuration options for the Liquid instance.

### Returns
- **Liquid** - A new Liquid instance.
```

--------------------------------

### rawListeners: Get raw listeners including wrappers

Source: https://liquidjs.com/api/interfaces/_internal_.EventEmitter.html

Returns a copy of the listeners array, including wrappers created by once(). The example shows how to access the original listener and its behavior.

```javascript
import { EventEmitter } from 'node:events';  
const emitter = new EventEmitter();  
emitter.once('log', () => console.log('log once'));  
  
// Returns a new Array with a function `onceWrapper` which has a property  
// `listener` which contains the original listener bound above  
const listeners = emitter.rawListeners('log');  
const logFnWrapper = listeners[0];  
  
// Logs "log once" to the console and does not unbind the `once` event  
logFnWrapper.listener();  
  
// Logs "log once" to the console and removes the listener  
logFnWrapper();  
  
emitter.on('log', () => console.log('log persistently'));  
// Will return a new Array with a single function bound by `.on()` above  
const newListeners = emitter.rawListeners('log');  
  
// Logs "log persistently" twice  
newListeners[0]();  
emitter.emit('log');
```

--------------------------------

### tablerow with offset:3

Source: https://liquidjs.com/tags/tablerow.html

Uses the offset parameter to start the tablerow after the third product. The output is not shown.

```liquid
{% tablerow product in collection.products cols:2 offset:3 %}
  {{ product.title }}
{% endtablerow %}
```

--------------------------------

### Quick start: parse and render a Liquid template

Source: https://liquidjs.com/api/index.html

Imports the Liquid class, creates an engine, and renders a template with a context object. The output is 'Hello, Liquid!'.

```javascript
import { Liquid } from 'liquidjs'  

const engine = new Liquid()  
const html = await engine.parseAndRender(  
  'Hello, {{ name | capitalize }}!',  
  { name: 'liquid' }  
)  
//=> 'Hello, Liquid!'
```

--------------------------------

### Buffer.copy to another Buffer

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Copies a region of one Buffer to another Buffer using the copy method. The example copies bytes 16-19 from buf1 to buf2 starting at byte 8, and prints the result.

```javascript
import { Buffer } from 'node:buffer';  

// Create two `Buffer` instances.  
const buf1 = Buffer.allocUnsafe(26);  
const buf2 = Buffer.allocUnsafe(26).fill('!');  

for (let i = 0; i < 26; i++) {  
  // 97 is the decimal ASCII value for 'a'.  
  buf1[i] = i + 97;  
}  

// Copy `buf1` bytes 16 through 19 into `buf2` starting at byte 8 of `buf2`.  
buf1.copy(buf2, 8, 16, 20);  
// This is equivalent to:  
// buf2.set(buf1.subarray(16, 20), 8);  

console.log(buf2.toString('ascii', 0, 25));  
// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
```

--------------------------------

### rstrip filter output example

Source: https://liquidjs.com/filters/rstrip.html

Shows the resulting string after applying the rstrip filter, with trailing whitespace removed.

```text
BEGIN          So much room for activities!END
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/_internal_.Render.html

Creates a new Render instance.

```APIDOC
## constructor

### Description
Creates a new Render instance.

### Method
constructor

### Returns
- Render

```

--------------------------------

### copyWithin(target, start, end?)

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Copies a section of the array identified by start and end to the same array starting at position target. Returns the this object.

```APIDOC
## copyWithin(target, start, end?)

### Description
Copies a section of the array identified by start and end to the same array starting at position target. Returns the this object.

### Method
copyWithin

### Parameters
#### Parameters
- **target** (number) - Required - If target is negative, it is treated as length+target where length is the length of the array.
- **start** (number) - Required - If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- **end** (number) - Optional - If not specified, length of the this object is used as its default value.

### Returns
this
```

--------------------------------

### Output of the reject_exp example

Source: https://liquidjs.com/filters/reject_exp.html

The output shows the original list of products and the filtered list after applying reject_exp, which excludes kitchen items.

```text
All products:
- Vacuum
- Spatula
- Television
- Garlic press

Kitchen products:
- Vacuum
- Television
```

--------------------------------

### new Context(env?, opts?, renderOptions?, __namedParameters?)

Source: https://liquidjs.com/api/classes/Context.html

Creates a new Context instance with optional environment, options, render options, and named parameters for liquid instance and limits.

```APIDOC
## new Context(env?, opts?, renderOptions?, __namedParameters?)

### Description
Creates a new Context instance.

### Parameters
- **env** (object) - Optional - Initial environment scope. Default: `{}`.
- **opts** (NormalizedFullOptions) - Optional - Normalized full options. Default: `defaultOptions`.
- **renderOptions** (RenderOptions) - Optional - Render options. Default: `{}`.
- **__namedParameters** (object) - Optional - Named parameters.
  - **liquid** (any) - Optional - Reference to the Liquid instance.
  - **memoryLimit** (Limiter) - Optional - Memory limit.
  - **renderLimit** (Limiter) - Optional - Render limit.

### Returns
Context
```

--------------------------------

### upcase filter input example

Source: https://liquidjs.com/filters/upcase.html

Example input for the upcase filter with a mixed-case string.

```liquid
{{ "Parker Moore" | upcase }}
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/_internal_.Loader.html

Creates a new Loader instance with the given options.

```APIDOC
## new Loader(options)

### Description
Creates a new Loader instance with the given options.

### Parameters
- **options** (LoaderOptions) - Required - The options for the loader.

### Returns
- **Loader** - A new Loader instance.
```

--------------------------------

### readFloatBE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a 32-bit big-endian float from a Buffer. The example logs the result, which is 2.387939260590663e-38.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([1, 2, 3, 4]);  
  
console.log(buf.readFloatBE(0));  
// Prints: 2.387939260590663e-38
```

--------------------------------

### extname option example

Source: https://liquidjs.com/tutorials/options.html

Shows how the extname option appends .liquid to filenames without an extension. With extname set to .liquid, {% render "foo" %} loads foo.liquid, while {% render "foo.html" %} loads foo.html directly.

```liquid
{% render "foo" %}  there's no extname, adds `.liquid` and loads foo.liquid
{% render "foo.html" %}  there is an extname already, loads foo.html directly
```

--------------------------------

### readDoubleBE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a 64-bit big-endian double from a Buffer. The example logs the result, which is 8.20788039913184e-304.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);  
  
console.log(buf.readDoubleBE(0));  
// Prints: 8.20788039913184e-304
```

--------------------------------

### readInt32BE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a signed 32-bit big-endian integer from a Buffer. The example logs the result, which is 5.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0, 0, 0, 5]);  
  
console.log(buf.readInt32BE(0));  
// Prints: 5
```

--------------------------------

### readInt16BE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a signed 16-bit big-endian integer from a Buffer. The example logs the result, which is 5.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0, 5]);  
  
console.log(buf.readInt16BE(0));  
// Prints: 5
```

--------------------------------

### emit method example

Source: https://liquidjs.com/api/interfaces/_internal_.EventEmitter.html

Shows how to use the emit method with multiple listeners. It creates an EventEmitter, registers three listeners for the 'event' event, and emits the event with parameters. The output demonstrates the order of listener invocation and the parameters passed.

```javascript
import { EventEmitter } from 'node:events';  
const myEmitter = new EventEmitter();  
  
// First listener  
myEmitter.on('event', function firstListener() {  
  console.log('Helloooo! first listener');  
});  
// Second listener  
myEmitter.on('event', function secondListener(arg1, arg2) {  
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);  
});  
// Third listener  
myEmitter.on('event', function thirdListener(...args) {  
  const parameters = args.join(', ');  
  console.log(`event with parameters ${parameters} in third listener`);  
});  
  
console.log(myEmitter.listeners('event'));  
  
myEmitter.emit('event', 1, 2, 3, 4, 5);  
  
// Prints:  
// [  
//   [Function: firstListener],  
//   [Function: secondListener],  
//   [Function: thirdListener]  
// ]  
// Helloooo! first listener  
// event with parameters 1, 2 in second listener  
// event with parameters 1, 2, 3, 4, 5 in third listener
```

--------------------------------

### new Token(kind, input, begin, end, file?)

Source: https://liquidjs.com/api/classes/Token.html

Creates a new Token instance with the specified kind, input string, begin and end positions, and optional file name.

```APIDOC
## new Token(kind, input, begin, end, file?)

### Description
Creates a new Token instance with the specified kind, input string, begin and end positions, and optional file name.

### Parameters
- **kind** (TokenKind) - Required - The kind of the token.
- **input** (string) - Required - The input string.
- **begin** (number) - Required - The beginning position.
- **end** (number) - Required - The ending position.
- **file** (string) - Optional - The file name.

### Returns
Token
```

--------------------------------

### Render template from file with CLI

Source: https://liquidjs.com/tutorials/setup.html

Use the @ character followed by a path to read the template from a file.

```bash
npx liquidjs --template @./some-template.liquid
```

--------------------------------

### Basic Drop usage with properties and methods

Source: https://liquidjs.com/tutorials/drops.html

Create a custom class extending Drop to provide properties and methods for template variables. The example shows a SettingsDrop with a property 'foo' and a method 'bar', rendered in a template.

```javascript
import { Liquid, Drop } from 'liquidjs'

class SettingsDrop extends Drop {
  constructor() {
    super()
    this.foo = 'FOO'
  }
  bar() {
    return 'BAR'
  }
}

const engine = new Liquid()
const template = `foo: {{settings.foo}}, bar: {{settings.bar}}`
const context = { settings: new SettingsDrop() }
// Outputs: "foo: FOO, bar: BAR"
engine.parseAndRender(template, context).then(html => console.log(html))
```

--------------------------------

### replace_first filter output example

Source: https://liquidjs.com/filters/replace_first.html

Output of the replace_first filter example, showing the string with the first occurrence replaced.

```text
Take your protein pills and put my helmet on
```

--------------------------------

### Buffer.readBigUInt64BE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads an unsigned big-endian 64-bit integer from a Buffer at a given offset. The example prints 4294967295n.

```javascript
import { Buffer } from 'node:buffer';  

const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);  

console.log(buf.readBigUInt64BE(0));  
// Prints: 4294967295n
```

--------------------------------

### unless tag example

Source: https://liquidjs.com/tags/unless.html

Renders the block only if the condition is not met. In this example, the message is shown because the product title is not 'Awesome Shoes'.

```liquid
{% unless product.title == "Awesome Shoes" %}
  These shoes are not awesome.
{% endunless %}
```

```text
These shoes are not awesome.
```

--------------------------------

### Command and output for rendering

Source: https://liquidjs.com/tutorials/render-file.html

Running `node index.js` produces the output 'name: alice'.

```text
> node index.js
name: alice

```

--------------------------------

### Render template from stdin with CLI

Source: https://liquidjs.com/tutorials/setup.html

Use the @- syntax to read the template from stdin.

```bash
echo '{{"hello" | capitalize}}' | npx liquidjs --template @-
```

--------------------------------

### readUInt32BE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads an unsigned big-endian 32-bit integer from a Buffer. The example shows reading at offset 0 prints 12345678.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);  
  
console.log(buf.readUInt32BE(0).toString(16));  
// Prints: 12345678
```

--------------------------------

### writeUIntLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Writes a 6-byte unsigned integer to a buffer in little-endian format and prints the resulting buffer. The output shows the buffer contents as <Buffer ab 90 78 56 34 12>.

```javascript
import { Buffer } from 'node:buffer';  

const buf = Buffer.allocUnsafe(6);  

buf.writeUIntLE(0x1234567890ab, 0, 6);  

console.log(buf);  
// Prints: <Buffer ab 90 78 56 34 12>
Copy
```

--------------------------------

### Directory structure for template rendering

Source: https://liquidjs.com/tutorials/render-file.html

Shows the expected directory layout with index.js and views containing hello.liquid and world.liquid.

```text
.
├── index.js
└── views/
  ├── hello.liquid
  └── world.liquid

```

--------------------------------

### readFloatLE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a 32-bit little-endian float from a Buffer. The example logs the result and shows that an invalid offset throws ERR_OUT_OF_RANGE.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([1, 2, 3, 4]);  
  
console.log(buf.readFloatLE(0));  
// Prints: 1.539989614439558e-36  
console.log(buf.readFloatLE(1));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### Use a plugin: engine.plugin(require('./upup.js'))

Source: https://liquidjs.com/tutorials/plugins.html

Passes the plugin function to the `.plugin()` method, then renders a template using the 'upup' filter. The output is 'FOO'.

```javascript
const engine = new Liquid()

engine.plugin(require('./upup.js'));
engine
    .parseAndRender('{{ "foo" | upup }}')
    .then(console.log)  // outputs "FOO"
```

--------------------------------

### subarray(start?, end?)

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices. Inherited from TypedArray.prototype.subarray().

```APIDOC
## subarray(start?, end?)

### Description
Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start` and `end` indices. Specifying `end` greater than `buf.length` will return the same result as that of `end` equal to `buf.length`. This method is inherited from `TypedArray.prototype.subarray()`. Modifying the new `Buffer` slice will modify the memory in the original `Buffer` because the allocated memory of the two objects overlap.

### Method
subarray

### Parameters
- **start** (number) - Optional - Where the new `Buffer` will start.
- **end** (number) - Optional - Where the new `Buffer` will end (not inclusive).

### Returns
Buffer

### Since
v3.0.0
```

--------------------------------

### Create Liquid engine with cache option

Source: https://liquidjs.com/tutorials/options.html

Shows how to instantiate a Liquid engine with the cache option set to true. The cache option defaults to false and enables a default LRU cache of size 1024 when true.

```javascript
const { Liquid } = require('liquidjs')
const engine = new Liquid({
    cache: true
})
```

--------------------------------

### new Output(token, liquid)

Source: https://liquidjs.com/api/classes/Output.html

Constructs a new Output instance with the given token and liquid engine.

```APIDOC
## new Output(token, liquid)

### Description
Creates a new Output instance.

### Constructor
`new Output(token: OutputToken, liquid: Liquid): Output`

### Parameters
- **token** (OutputToken) - Required - The output token.
- **liquid** (Liquid) - Required - The liquid engine instance.

### Returns
- **Output** - The constructed Output instance.
```

--------------------------------

### readInt16LE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a signed 16-bit little-endian integer from a Buffer. The example logs the result and shows that an invalid offset throws ERR_OUT_OF_RANGE.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0, 5]);  
  
console.log(buf.readInt16LE(0));  
// Prints: 1280  
console.log(buf.readInt16LE(1));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### url_decode filter input example

Source: https://liquidjs.com/filters/url_decode.html

Example input using the url_decode filter on a URL-encoded string. The filter decodes percent-encoding and plus signs to spaces.

```liquid
{{ "%27Stop%21%27+said+Fred" | url_decode }}
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/Hash.html

Creates a new Hash instance from an input string or tokenizer, optionally with Jekyll-style parsing.

```APIDOC
## constructor

### Description
Creates a new Hash instance from an input string or tokenizer, optionally with Jekyll-style parsing.

### Signature
`new Hash(input, jekyllStyle?)`

### Parameters
- **input** (string | Tokenizer) - Required - The input string or tokenizer to parse.
- **jekyllStyle** (string | boolean) - Optional - Whether to use Jekyll-style parsing.

### Returns
- **Hash** - The new Hash instance.
```

--------------------------------

### slice(start?, end?)

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices. Deprecated: use subarray instead.

```APIDOC
## slice(start?, end?)

### Description
Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start` and `end` indices. This method is not compatible with `Uint8Array.prototype.slice()`. To copy the slice, use `Uint8Array.prototype.slice()`.

### Method
slice

### Parameters
- **start** (number) - Optional - Where the new `Buffer` will start.
- **end** (number) - Optional - Where the new `Buffer` will end (not inclusive).

### Returns
Buffer

### Since
v0.3.0

### Deprecated
Use `subarray` instead.
```

--------------------------------

### new TagToken(input, begin, end, options, file?)

Source: https://liquidjs.com/api/classes/TagToken.html

Creates a new TagToken instance with the given input string, begin and end positions, options, and optional file.

```APIDOC
## new TagToken(input, begin, end, options, file?)

### Description
Creates a new TagToken instance.

### Constructor
`new TagToken(input, begin, end, options, file?)`

### Parameters
- **input** (string) - Required - The input string.
- **begin** (number) - Required - The beginning position.
- **end** (number) - Required - The ending position.
- **options** (NormalizedFullOptions) - Required - The normalized full options.
- **file** (string) - Optional - The file name.

### Returns
TagToken
```

--------------------------------

### for loop with offset parameter

Source: https://liquidjs.com/tags/for.html

Begins the loop at the specified index. The example uses offset:2 on an array of 1..6, outputting 3456.

```liquid
<!-- for array = [1,2,3,4,5,6] -->
{% for item in array offset:2 %}
  {{- item -}}
{% endfor %}
```

```text
3456
```

--------------------------------

### readUInt16BE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads an unsigned big-endian 16-bit integer from a Buffer. The example shows reading at offset 0 prints 1234 and at offset 1 prints 3456.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0x12, 0x34, 0x56]);  
  
console.log(buf.readUInt16BE(0).toString(16));  
// Prints: 1234  
console.log(buf.readUInt16BE(1).toString(16));  
// Prints: 3456
```

--------------------------------

### prepend with variable

Source: https://liquidjs.com/filters/prepend.html

Assigns a URL variable and prepends it to a string. The output is 'example.com/index.html'.

```liquid
{% assign url = "example.com" %}
{{ "/index.html" | prepend: url }}
```

```text
example.com/index.html
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/RawTag.html

Creates a new RawTag instance with the given tag token, remaining tokens, and Liquid instance.

```APIDOC
## constructor

### Description
Creates a new RawTag instance.

### Method
constructor

### Parameters
- **tagToken** (TagToken) - Required - The tag token.
- **remainTokens** (TopLevelToken[]) - Required - The remaining tokens.
- **liquid** (Liquid) - Required - The Liquid instance.

### Returns
RawTag
```

--------------------------------

### toString(encoding?, start?, end?): string

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Decodes the buffer to a string according to the specified character encoding. Optionally decodes only a subset of the buffer using start and end offsets.

```APIDOC
## toString(encoding?, start?, end?): string

### Description
Decodes `buf` to a string according to the specified character encoding in `encoding`. `start` and `end` may be passed to decode only a subset of `buf`. If `encoding` is `'utf8'` and a byte sequence in the input is not valid UTF-8, then each invalid byte is replaced with the replacement character `U+FFFD`.

### Method
toString

### Signature
`toString(encoding?, start?, end?): string`

### Parameters
- **encoding** (BufferEncoding) - Optional - The character encoding to use.
- **start** (number) - Optional - The byte offset to start decoding at.
- **end** (number) - Optional - The byte offset to stop decoding at (not inclusive).

### Returns
- **string** - The decoded string.

### Since
v0.1.90

### Example
```javascript
import { Buffer } from 'node:buffer';

const buf1 = Buffer.allocUnsafe(26);
for (let i = 0; i < 26; i++) {
  buf1[i] = i + 97;
}
console.log(buf1.toString('utf8'));
// Prints: abcdefghijklmnopqrstuvwxyz
console.log(buf1.toString('utf8', 0, 5));
// Prints: abcde

const buf2 = Buffer.from('tést');
console.log(buf2.toString('hex'));
// Prints: 74c3a97374
console.log(buf2.toString('utf8', 0, 3));
// Prints: té
console.log(buf2.toString(undefined, 0, 3));
// Prints: té
```
```

--------------------------------

### Render a partial template from partials directory

Source: https://liquidjs.com/tags/render.html

Shows the basic usage of the render tag to include a partial template. The partial file is specified with a .liquid extension. The result shows the rendered output.

```liquid
// index.liquid
Contents
{% render 'footer.liquid' %}

// footer.liquid
Footer

// result
Contents
Footer
```

--------------------------------

### renderFile

Source: https://liquidjs.com/api/classes/Liquid.html

Renders a file with the given context and render options.

```APIDOC
## renderFile

### Description
Renders a file with the given context and render options.

### Method
renderFile

### Parameters
- **file** (string) - Required - The path to the file to render.
- **ctx** (object | Context) - Optional - The context to render with.
- **renderFileOptions** (RenderFileOptions) - Optional - Options for rendering.

### Returns
- **Promise<any>** - A promise that resolves to the rendered output.
```

--------------------------------

### readInt32LE example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads a signed 32-bit little-endian integer from a Buffer. The example shows reading at offset 0 prints 83886080, and reading at offset 1 throws ERR_OUT_OF_RANGE.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([0, 0, 0, 5]);  
  
console.log(buf.readInt32LE(0));  
// Prints: 83886080  
console.log(buf.readInt32LE(1));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### Basic layout usage with default-layout.liquid and page.liquid

Source: https://liquidjs.com/tags/layout.html

Shows how to use the layout tag to render a template inside a layout. The layout file defines a block, and the page provides content for that block. The result is the layout with the block replaced by the page's content.

```liquid
// default-layout.liquid
Header
{% block %}{% endblock %}
Footer

// page.liquid
{% layout "default-layout.liquid" %}
{% block %}My page content{% endblock %}

// result
Header
My page content
Footer
```

--------------------------------

### raw tag input example

Source: https://liquidjs.com/tags/raw.html

Use the raw tag to output content that contains Liquid-like syntax without processing. The example shows Handlebars expressions inside raw tags.

```liquid
{% raw %}
  In Handlebars, {{ this }} will be HTML-escaped, but
  {{{ that }}} will not.
{% endraw %}
```

--------------------------------

### Run LiquidJS from the CLI with npx

Source: https://liquidjs.com/api/index.html

Renders a Liquid template from the command line using npx, passing template and context as arguments.

```bash
npx liquidjs --template 'Hello, {{ name }}!' --context '{"name": "Liquid"}'
```

--------------------------------

### constructor

Source: https://liquidjs.com/api/classes/Parser.html

Creates a new Parser instance with the given Liquid instance.

```APIDOC
## new Parser(liquid)

### Description
Creates a new Parser instance with the given Liquid instance.

### Parameters
- **liquid** (Liquid) - Required - The Liquid instance to use for parsing.

### Returns
Parser
```

--------------------------------

### new NumberToken(input, begin, end, file?)

Source: https://liquidjs.com/api/classes/NumberToken.html

Creates a new NumberToken instance with the given input string, start and end positions, and optional file name.

```APIDOC
## new NumberToken(input, begin, end, file?)

### Description
Creates a new NumberToken instance.

### Constructor
`new NumberToken(input, begin, end, file?)`

### Parameters
- **input** (string) - Required - The input string.
- **begin** (number) - Required - The start position.
- **end** (number) - Required - The end position.
- **file** (string) - Optional - The file name.

### Returns
- **NumberToken** - The new NumberToken instance.
```

--------------------------------

### readUInt8 example

Source: https://liquidjs.com/api/interfaces/_internal_.Buffer.html

Reads an unsigned 8-bit integer from a buffer. The example shows reading at offsets 0, 1, and 2, where offset 2 throws ERR_OUT_OF_RANGE because it exceeds the buffer length.

```javascript
import { Buffer } from 'node:buffer';  
  
const buf = Buffer.from([1, -2]);  
  
console.log(buf.readUInt8(0));  
// Prints: 1  
console.log(buf.readUInt8(1));  
// Prints: 254  
console.log(buf.readUInt8(2));  
// Throws ERR_OUT_OF_RANGE.
```

--------------------------------

### Multiple named blocks in layout and page

Source: https://liquidjs.com/tags/layout.html

Shows how to define multiple named blocks in a layout and provide content for each block in the page. The result is the same as the basic example.

```liquid
// default-layout.liquid
{% block header %}{% endblock %}
{% block content %}{% endblock %}
{% block footer %}{% endblock %}

// page.liquid
{% layout "default-layout.liquid" %}
{% block header %}Header{% endblock %}
{% block content %}My page content{% endblock %}
{% block footer %}Footer{% endblock %}
```
Tokens:
Raw