IFClite TypeScript API
    Preparing search index...

    Interface ProjectParams

    Project-level options

    interface ProjectParams {
        Author?: string;
        Currency?: string;
        Description?: string;
        GuidSource?: () => string;
        LengthUnit?: string;
        Name?: string;
        Organization?: string;
        Schema?: "IFC2X3" | "IFC4" | "IFC4X3";
        Timestamp?: number | Date;
    }
    Index
    Author?: string
    Currency?: string

    Project currency (e.g. 'CHF'), written as an IfcMonetaryUnit in the IfcUnitAssignment. THERE IS NO DEFAULT: leave it out and the file states no currency, which is a different answer from a guessed one and is the answer the cost read model gives back.

    Description?: string
    GuidSource?: () => string

    Deterministic GlobalId source: called once per generated GlobalId and must return a valid 22-character IFC GUID - e.g. () => generateIfcGuid(rng) with a seeded RandomSource from @ifc-lite/encoding. Defaults to the platform CSPRNG. Values already used by this creator are retried, so the source must not repeat indefinitely.

    LengthUnit?: string

    Length unit: 'METRE' (default), 'MILLIMETRE', 'FOOT'

    Name?: string
    Organization?: string
    Schema?: "IFC2X3" | "IFC4" | "IFC4X3"
    Timestamp?: number | Date

    Fixed creation instant (epoch milliseconds or Date) used for the FILE_NAME header timestamp, IfcOwnerHistory.CreationDate, and the default work-schedule/work-plan CreationDate. Defaults to the wall clock; set it (together with GuidSource) for byte-reproducible output.