gi-nx / getUsage
ts
function getUsage(usageName: string): Usage;Get a single usage definition by name.
getUsage(usageName: string): Usage
Parameters
| Parameter | Type | Description |
|---|---|---|
usageName | string | The name of the usage to retrieve (e.g. 'Residential', 'Commercial'). |
Returns
Usage
The Usage definition, containing default property values and join configuration.
Example
typescript
const residential = await rpc.invoke("getUsage", ["Residential"]);
console.log(residential.default.height); // e.g. 20