Class Project

An opened source file. Reading it again is the expensive part, so keep one per file.

Index

Methods

convert inspect matchProfile settings open

Methods

convert

convert(options: ConvertOptions): Promise<ConvertResult>
Parameters
- options: ConvertOptions
Returns Promise<ConvertResult>
- Defined in project.ts:325

inspect

inspect(): Inspection
Returns Inspection
- Defined in project.ts:316

matchProfile

matchProfile(profiles: ProfileCatalog | ProfileSource): Promise<ProfileChoice>
The profile auto-matching would pick for this file.
Parameters
- profiles: ProfileCatalog | ProfileSource
Returns Promise<ProfileChoice>
- Defined in project.ts:321

settings

settings(): Record<string, unknown>
The project's own settings (Metadata/project_settings.config), as a copy: for a settings diff.

Returns Record<string, unknown>
- Defined in project.ts:312

`Static`open

open(bytes: Uint8Array, options?: OpenOptions): Project
Reads a .3mf. Throws Any2orcaError (invalid_file, too_large or invalid_project) if it can't be used.
Parameters
- bytes: Uint8Array
- options: OpenOptions = {}
Returns Project
- Defined in project.ts:290