The BimWorksClientFactory is the only way to create BimWorksClient objects. It should normally be a long-lived instance. All of the "create*" methods in this class return a Promise that will resolve to a BimWorksClient when successful. Otherwise the Promise will fail.



  • Create an anonymous client. The returned BimWorksClient will usually not be very usefull as anonymous users can't do much in This can be useful for getting information about the deployed version for example, or to simply test connectivity.

    Returns Promise<BimWorksClient>

  • Create a new BimWorksClient based on the provided username/password. This method is not recommended, on most cases using an API Token or Auth Token is safer/more stable.


    • username: string
    • password: string

    Returns Promise<BimWorksClient>