Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ading2210/sandstone/llms.txt

Use this file to discover all available pages before exploring further.

The version export gives you the precise version string and git commit hash that were compiled into the Sandstone bundle when it was built. You can use these values to display build information to users, report them in bug reports, or guard against incompatible builds at runtime.

​
Import

import { version } from "./dist/sandstone.mjs";

​
Shape

export const version = {
  ver: __VERSION__,  // e.g. "0.2.0" or "0.2.0-dev"
  hash: __GIT_HASH__ // e.g. "a1b2c3d"
};
Both values are substituted by webpack at build time via DefinePlugin. They are plain strings in the compiled output.

​
Fields

​
ver
string
required
The Sandstone release version. This is taken from the version field in package.json. If the current commit does not have a matching git tag, the string -dev is appended — for example "0.2.0-dev" on an unreleased commit and "0.2.0" on a tagged release.
​
hash
string
required
The short git commit hash produced by git rev-parse --short HEAD at build time — for example "a1b2c3d". Use this to pin a bug report to an exact commit when the version string alone is ambiguous.

​
Usage example

import { version } from "./dist/sandstone.mjs";

// Display build info in the UI
versionElement.textContent = `v${version.ver} (${version.hash})`;

// Log to the console
console.log(`Sandstone v${version.ver} (${version.hash})`);
// → Sandstone v0.2.0-dev (a1b2c3d)

Build docs developers (and LLMs) love

Get started for freeTalk to us