units
Typed lengths and other measures. Every length a kit function takes is a units.* value, never a bare number.
Every example below is a complete script that passes the kit's checks; the kit's tests run each one.
units.mm: A length in millimetres.units.m: A length in metres.units.in: A length in inches.units.ft: A length in feet.units.of: A quantity of any kind in any unit the unit library knows (an airflow, a load, a pressure).units.in_: A measure's value in a unit (units.in_(width, "in")is 24 for a 24 in width).
units.mm
A length in millimetres.
ts
mm(value: number): MeasureTopics: units, metric, millimetre
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "layout",
reads: { levels: true },
parameters: {},
run(ctx) {
building.walls(ctx, { level: "L1", points: [{ x: units.mm(0), y: units.mm(0) }, { x: units.mm(6000), y: units.mm(0) }], thickness: units.mm(200) });
},
});units.m
A length in metres.
ts
m(value: number): MeasureTopics: units, metric, metre
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "layout",
reads: { levels: true },
parameters: {},
run(ctx) {
building.walls(ctx, { level: "L1", points: [{ x: units.m(0), y: units.m(0) }, { x: units.m(6), y: units.m(0) }], thickness: units.m(0.2) });
},
});units.in
A length in inches.
ts
in(value: number): MeasureTopics: units, imperial, inch
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "layout",
reads: { levels: true },
parameters: {},
run(ctx) {
building.walls(ctx, { level: "L1", points: [{ x: units.in(0), y: units.in(0) }, { x: units.in(240), y: units.in(0) }], thickness: units.in(8) });
},
});units.ft
A length in feet.
ts
ft(value: number): MeasureTopics: units, imperial, foot, feet
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "layout",
reads: { levels: true },
parameters: {},
run(ctx) {
building.walls(ctx, { level: "L1", points: [{ x: units.ft(0), y: units.ft(0) }, { x: units.ft(20), y: units.ft(0) }], thickness: units.in(8) });
},
});units.of
A quantity of any kind in any unit the unit library knows (an airflow, a load, a pressure).
ts
of(kind: string, value: number, unit: string): MeasureTopics: units, airflow, cfm, quantity
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "layout",
reads: { levels: true },
parameters: {},
run(ctx) {
const tall = units.of("length", 3, "m");
building.walls(ctx, { level: "L1", points: [{ x: units.m(0), y: units.m(0) }, { x: units.m(5), y: units.m(0) }], thickness: units.mm(150), height: tall });
},
});units.in_
A measure's value in a unit (units.in_(width, "in") is 24 for a 24 in width).
ts
in_(m: Measure, unit: string): numberTopics: units, convert, number
Example script
ts
import { defineScript, units, routes, parts, building, equipment, documents, checks } from "@permitzip/bim-script";
export default defineScript({
kind: "part",
reads: {},
parameters: { width: { type: "quantity", kind: "length", unit: "in", label: "Width", default: units.in(24) } },
run(ctx, v) {
const inches = Math.round(units.in_(v.width, "in"));
const b = parts.part("Box", { type: `${inches}`, category: "generic" });
b.box({ length: v.width, width: units.in(12), height: units.in(12) });
ctx.parts.define("acme.box." + inches, b.build());
},
});