@sdk/core
Interfaces
| Interface | Description |
|---|---|
| OffsetBasedPaginationResponse | OffsetBasedPaginationResponse is an interface that defines the shape of a response object for an offset-based pagination query. It's a generic interface where T represents the type of individual items in the response. |
Type Aliases
| Type alias | Description |
|---|---|
| AssetArtifactId | Id of an artifact in an asset. |
| AssetInstanceId | Id of virtual assets. Also known as GroupedAsset in the platform. |
| Extends | The Extends type is a utility type that is taking two type parameters, T and U. The extends keyword here is being used for a conditional type check. It sets a constraint where the type U must be a subtype (or the same type) of T. This essentially means that U should either be the same type as T, or it should include all of the properties of T (in case of object types). |
| ExtractField | ExtractField is a utility type that extracts the type of a specific field from a type T. This type takes two parameters: - T, the type from which the field type is to be extracted. - K, the key of the field to be extracted from T. |
| FileSystemEntity | A file system entity that can be a asset, a folder or something else. |
| Filesystem | A list of folder content that can contain other folders. |
| Flatten | The Flatten type takes an array type and returns the type of the elements in the array. It uses conditional types and type inference to achieve this. If A is an array of some type I, it returns I. If A is not an array, it returns never. |
| FolderId | Id of an folder in the filesystem. |
| LabelId | Label (tags that can be attached to entities and fildered uppon). |
| LookAtPoint | Represents a point in 3D space with a focus on a target, including orientation angles (pitch, yaw, roll). The coordinate system is defined by the type parameter ReferenceT, ensuring that points from different coordinate systems are not accidentally mixed. |
| Option | A type representing a value that may be null. |
| PageNumberOneIndexed | PageNumberZeroIndexed is a utility type that represents a page number in a one-indexed pagination system (i.e., where the first page is numbered 1). |
| PageNumberZeroIndexed | PageNumberZeroIndexed is a utility type that represents a page number in a zero-indexed pagination system (i.e., where the first page is numbered 0). |
| ProjectId | Id of an project. |
| ProjectMemberId | Project member id. This is not to be confused with an UserId. The API tells us these are the same but they cant. We are keeping this special ID to block the devs from accidentally interchanging these two. |
| Result | A type representing a value that may be an error. |
| ResultError | Utility type to extract the type of the error from a Result type. |
| ResultValue | Utility type to extract the type of the value from a Result type. |
| SimpleValidationError | Error type that contains a single reason for causing an error. |
| TargetOrientation | Represents a directional orientation in 3D space. This includes: - A target position defined by coordinates (x, y, z) - The orientation angles: pitch, yaw, and roll - The distance from an origin point to the target |
| Vector3 | - |
Variables
| Variable | Description |
|---|---|
| Option | - |
| Result | - |
Functions
| Function | Description |
|---|---|
| AssetArtifactId | - |
| AssetInstanceId | - |
| FolderId | - |
| LabelId | - |
| ProjectId | - |
| ProjectMemberId | - |
| SimpleValidationError | - |
| oneIndexedPageToZeroIndexedPage | - |
| zeroIndexedPageToOneIndexedPage | - |