Skip to main content

Files & System

Files and paths, processes and shells, the clipboard, storage, serialization, crypto, logging, and TypeScript compilation.

Commonly used

Guides

All APIs in this topic

Import modules with import * as Ui from 'LensStudio:Ui'.

Components, assets, and modules

APIDescription
LensStudio:AnalyticsProvides analytics functionality for logging events from within a Lens.
LensStudio:App
LensStudio:ClipboardModule providing clipboard read/write access for Lens Studio Editor.
LensStudio:CryptoCryptography module providing secure random value generation, UUIDs, and digest operations modeled after the Web Crypto API.
LensStudio:FileSystemBefore using anything in this namespace, make sure to import LensStudio:FileSystem and add filesystem in your plugin's module.json.
LensStudio:LoggerModule providing log collection and monitoring functionality for Lens Studio plugins.
LensStudio:ScopedStorage.js
LensStudio:Serialization
LensStudio:Shell
LensStudio:SubprocessBefore using anything in this namespace, make sure to import LensStudio:Subprocess and add subprocess in your plugin's module.json.
LensStudio:SysInfoProvides system information for Lens Studio.
LensStudio:TypeScriptModule exposing the editor TypeScript compilation API for triggering and inspecting project compilations.
LensStudio:UuidNamespace providing UUID creation and manipulation utilities.

Objects and data

APIDescription
Editor.BufferWraps a byte array for data serialization and deserialization.
Editor.CompressionProvides compression and decompression utilities.
Editor.PathA path in the filesystem, or Asset Manager.
SecureLocalStorageProvides encrypted storage for each plugin module's sensitive data, like access tokens.