The main entry point to the BIM.works API. This is usually a short-lived object, but there is no reason to not use it for longer. For better organization, the BIM.works API is namespaced in about a dozen different namespaces. These namespaces are also used in the JS SDK. Each namespaced API is available as a readonly attribute on the BimWorksClient.

Hierarchy

  • BimWorksClient

Constructors

Properties

bim: Bim
checks: Checks
client: Client
fs: Fs
geometry2d: Geometry2d
geometry3d: Geometry3d
gis: Gis
ifc: Ifc
registerExpiredTokenHandler: ((handler: ((oldAuth: AuthToken) => Promise<AuthToken>)) => void)

Type declaration

    • (handler: ((oldAuth: AuthToken) => Promise<AuthToken>)): void
    • Parameters

      • handler: ((oldAuth: AuthToken) => Promise<AuthToken>)
          • (oldAuth: AuthToken): Promise<AuthToken>
          • Parameters

            • oldAuth: AuthToken

            Returns Promise<AuthToken>

      Returns void

render: Render
tokens: Tokens
upload: Upload

Methods

  • Parameters

    • apiToken: AuthToken

    Returns Promise<void> | Promise<Error>

  • Parameters

    • username: string
    • password: string

    Returns Promise<void> | Promise<Error>

  • Parameters

    • auth: AuthToken

    Returns Promise<void> | Promise<Error>

Generated using TypeDoc