Class Position

Returns the value that lies between the current postion and another

Example

import { staquia } from "staquia";

// Given a system like this
let zero = "!"; // Would be like 0
let first = "a"; // Would be like 1
let middle = "n"; // Would be like 14
let last = "z"; // Would be like 26

// The middle character between two positions
// can be seen as Math.ceil((first + last) / 2);
let n = staquia.position(first).core(last); // Will result in "n"

// When there is no room between 2 positions, the "middle" value
// from the system will be attached to the last position.
// This is where the "threshold" and "overflow" handling
// logic will be applied
let am = staquia.position("a").core("b"); // Will result in "am"

Gets the relative next position from another position

Example

// The character "a" is followed by "b" in the unicode standard
const nnnb = staquia.position("nnna").next();

Gets the relative next position from another position

Example

// The character "b" is followed by "a" in the unicode standard
const nnna = staquia.position("nnnb").next();

Compares an object or a string to see if it is equals to the current instance

Example

const original = staquia.position("nnnnnz");

// Can be compared with another instance
const instance = staquia.position("nnnnnz");
original.toEquals(instance);

// Can be compared with a valid position string
const string = "nnnnnz";
original.toEquals(string);

// Can be compared with a valid position object
const object = { n: "nnnnn", z: "z"};
original.toEquals(object);

Gets the n and z values

Example

// Asuming the "n" segment length is like below
let ln = 5;

// Create it as a string
const position = staquia.position("n");
postion.toObject

// Will look like this
let object = {
 n: "!!!!n",
 z: "!"
}

Concatenates the n value with the z

Example

// Asuming the "n" segment length is like below
let ln = 5;

// Create it as an object
const position = staquia.position({
 n: "n",
 z: "zzzz",
});

// Will print "!!!!nzzzz" as will attach leading zeroes
const string = position.toString();

Updates the position based on an input value

With this function the position instances can be compared as plain strings with the less than < and greater than > operators

Example

// Create your positions
const a = staquia.position("a");
const b = staquia.position("b");

// Just compare them as plain objects
a < b // Will return false
a > b // Will return true

Determines if an object is a position instance

Determines if a plain object is a valid position object