IFClite TypeScript API
    Preparing search index...

    Class BsddNamespace

    bim.bsdd — buildingSMART Data Dictionary lookup

    Discover schema-defined properties, quantities, and classifications for any IFC entity type from the bSDD REST API.

    const info = await bim.bsdd.fetchClassInfo('IfcWall');
    for (const prop of info.classProperties) {
      console.log(prop.propertySet, prop.name, prop.dataType);
    }
    Index
    constructor
    cacheStats clearCache dataTypeLabel fetchClassByUri fetchClassInfo getEntityAttributes getPropertySets getQuantitySets ifcClassUri ifcClassUrl search searchRelatedClasses

    • Get cache statistics.

      Returns { entries: number; oldestMs: number }

    • Clear the bSDD cache.

      Returns void

    • Map bSDD dataType string to a human-friendly label.

      Parameters

      • dt: string | null

      Returns string

    • Fetch class info by full bSDD URI (not just IFC type name). Useful for non-IFC dictionaries (Uniclass, OmniClass, etc.).

      Parameters

      • classUri: string

      Returns Promise<BsddClassInfo | null>

    • Fetch full class info (including properties) for an IFC entity type.

      Results are cached for 10 minutes (configurable). Returns null if bSDD has no data for this type (HTTP 404). Other HTTP failures — most importantly 429 rate-limits — are re-thrown as BsddHttpError so callers can react instead of silently treating them as "missing".

      Parameters

      • ifcType: string

      Returns Promise<BsddClassInfo | null>

    • Get entity-level attributes (properties with no propertySet).

      Parameters

      • ifcType: string

      Returns Promise<BsddClassProperty[]>

    • Get only the property sets (Pset_*) for an IFC type. Groups properties by their propertySet name.

      Parameters

      • ifcType: string

      Returns Promise<Map<string, BsddClassProperty[]>>

    • Get only the quantity sets (Qto_*) for an IFC type. Groups quantities by their propertySet name.

      Parameters

      • ifcType: string

      Returns Promise<Map<string, BsddClassProperty[]>>

    • Build the bSDD class URI for an IFC entity type.

      Parameters

      • ifcType: string

      Returns string

    • Build the bSDD search URL for an IFC entity type (for browser links).

      Parameters

      • ifcType: string

      Returns string

    • Search bSDD for classes related to an IFC entity type across all dictionaries.

      Returns lightweight results. Use fetchClassByUri() on a specific result to get full property details.

      Parameters

      • ifcType: string

      Returns Promise<BsddSearchResult[]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods