RevoEngine Documentation

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 22 methods. Search the docs for an exact method name, or use this index:

storage.explore()
storage.resolveFolderPath()
storage.ensureFolderPath()
storage.getFile()
storage.getFileData()
storage.getFileStats()
storage.getEntry()
storage.createFolder()
storage.putObject()
storage.createUploadSession()
storage.extendUploadSession()
storage.getUploadSession()
storage.uploadPart()
storage.finalizeUploadSession()
storage.abortUploadSession()
storage.updateEntry()
storage.moveEntry()
storage.archiveEntry()
storage.restoreEntry()
storage.deleteEntry()
storage.getDownload()
storage.getText()

`storage.explore()`

Lists files and folders from the default explorer namespace.

Signature

static explore(query?: StorageExploreRequest): Promise<StorageExploreResult>;

Example

const listing = await storage.explore({ parentStorageEntryId: folderId });

`storage.resolveFolderPath()`

Resolves an exact active folder path relative to the default explorer root. Notes:

Matching is case-insensitive and follows each parent/name segment; this is not a broad term search.
Leading and trailing slashes are optional.
Missing, archived, deleted, or inaccessible paths fail without creating folders.

Signature

static resolveFolderPath(path: string): Promise<StorageEntryView>;

Example

const folder = await storage.resolveFolderPath('exports/daily');

`storage.ensureFolderPath()`

Resolves a folder path and idempotently creates any missing segments. Notes:

No-op in debug mode.
Existing folders are never mutated.
ACL options apply to every newly created segment.

Signature

static ensureFolderPath(
      path: string,
      options?: StorageEnsureFolderPathOptions,
    ): Promise<StorageEntryView>;

Example

const folder = await storage.ensureFolderPath('exports/daily', {
  restricted: true,
});

`storage.getFile()`

Returns metadata for a file entry in the default explorer namespace.

Signature

static getFile(
      storageEntryId: string,
      includeDeleted?: boolean,
    ): Promise<StorageEntryView>;

Example

const file = await storage.getFile(storageEntryId);

`storage.getFileData()`

Reads storage file content. Notes:

Text file batch reads reuse cached stats and auto-build them if missing.
Binary reads return a base64 string.
Direct reads are limited to 10 MB unless you request a ranged buffer.

Signature

static getFileData(
      storageEntryId: string,
      options?: StorageFileReadOptions,
    ): Promise<any>;

Example

const lines = await storage.getFileData(storageEntryId, { batchNumber: 1 });

`storage.getFileStats()`

Detects encoding, newline separator, and line batches for a text file. Notes:

Derived stats are cached on the storage entry metadata for later batch reads.

Signature

static getFileStats(
      storageEntryId: string,
      options?: StorageFileStatsOptions,
    ): Promise<StorageFileStats>;

Example

const stats = await storage.getFileStats(storageEntryId, {
  separator: '\n',
  batchSize: 5000,
});

`storage.getEntry()`

Returns metadata for any storage entry in the default explorer namespace.

Signature

static getEntry(
      storageEntryId: string,
      includeDeleted?: boolean,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.getEntry(storageEntryId);

`storage.createFolder()`

Creates a folder in the default explorer namespace. Notes:

No-op in debug mode.

Signature

static createFolder(data: StorageFolderInput): Promise<StorageEntryView>;

Example

const folder = await storage.createFolder({ name: 'Exports' });

`storage.putObject()`

Uploads a small object in one request in the default explorer namespace. Notes:

No-op in debug mode.

Signature

static putObject(data: StoragePutObjectInput): Promise<StorageEntryView>;

Example

const file = await storage.putObject({
  name: 'summary.md',
  data: '# Daily summary',
  mimeType: 'text/markdown',
  computeStats: 'sync',
});

`storage.createUploadSession()`

Opens an upload session for a file in the default explorer namespace. Notes:

No-op in debug mode.
Use this instead of storage.appendFile(...); uploads are resumable and finalized explicitly.

Signature

static createUploadSession(
      data: StorageUploadSessionInput,
    ): Promise<{ session: StorageUploadSession; upload: StorageUploadTarget }>;

Example

const upload = await storage.createUploadSession({
  name: 'archive.zip',
  contentTypeHint: 'application/zip',
  uploadMode: 'incremental',
});
await storage.uploadPart(upload.session.storageUploadSessionId, {
  data: chunkBase64,
  dataEncoding: 'base64',
});
const result = await storage.finalizeUploadSession(
  upload.session.storageUploadSessionId,
);

`storage.extendUploadSession()`

Extends the TTL for an active upload session. Notes:

No-op in debug mode.

Signature

static extendUploadSession(
      storageUploadSessionId: string,
    ): Promise<StorageUploadSession>;

Example

const session = await storage.extendUploadSession(storageUploadSessionId);

`storage.getUploadSession()`

Returns the current upload session state together with uploaded part manifests. Notes:

No-op in debug mode.
Multipart sessions expose uploaded parts with computed byte ranges.

Signature

static getUploadSession(
      storageUploadSessionId: string,
    ): Promise<StorageUploadSessionView>;

Example

const state = await storage.getUploadSession(storageUploadSessionId);

`storage.uploadPart()`

Uploads one part into an active multipart upload session. Notes:

No-op in debug mode.

Signature

static uploadPart(
      storageUploadSessionId: string,
      partNumber: number | StorageUploadPartInput,
      data?: StorageUploadPartInput,
    ): Promise<StorageUploadPartResult>;

Example

await storage.uploadPart(storageUploadSessionId, 2, {
  data: nextChunk,
  dataEncoding: 'utf8',
});

Example (incremental numbering):
await storage.uploadPart(storageUploadSessionId, {
  data: nextChunk,
  dataEncoding: 'utf8',
});

Example (repair a specific multipart chunk):
await storage.uploadPart(storageUploadSessionId, 7, {
  data: repairedChunk,
  dataEncoding: 'utf8',
});

`storage.finalizeUploadSession()`

Finalizes an upload session and materializes the storage entry. Notes:

No-op in debug mode.

Signature

static finalizeUploadSession(
      storageUploadSessionId: string,
      data?: StorageUploadSessionFinalizeInput,
    ): Promise<{ session: StorageUploadSession; entry: StorageEntryView }>;

Example

const result = await storage.finalizeUploadSession(storageUploadSessionId, {
  computeStats: 'async',
});

`storage.abortUploadSession()`

Cancels an active upload session. Notes:

No-op in debug mode.

Signature

static abortUploadSession(
      storageUploadSessionId: string,
    ): Promise<StorageUploadSession>;

Example

await storage.abortUploadSession(storageUploadSessionId);

`storage.updateEntry()`

Updates mutable storage entry fields such as name, metadata, or ACLs. Notes:

No-op in debug mode.

Signature

static updateEntry(
      storageEntryId: string,
      data: StorageEntryUpdateInput,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.updateEntry(storageEntryId, {
  name: 'report-final.csv',
  version: currentVersion,
});

`storage.moveEntry()`

Moves an entry to another folder or provider root. Notes:

No-op in debug mode.

Signature

static moveEntry(
      storageEntryId: string,
      data: StorageEntryMoveInput,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.moveEntry(storageEntryId, {
  parentStorageEntryId: destinationFolderId,
  version: currentVersion,
});

`storage.archiveEntry()`

Archives an entry without deleting its backing object. Notes:

No-op in debug mode.

Signature

static archiveEntry(
      storageEntryId: string,
      data: StorageVersionInput,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.archiveEntry(storageEntryId, { version: currentVersion });

`storage.restoreEntry()`

Restores an archived or deleted storage entry. Notes:

No-op in debug mode.

Signature

static restoreEntry(
      storageEntryId: string,
      data: StorageRestoreInput,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.restoreEntry(storageEntryId, { version: currentVersion });

`storage.deleteEntry()`

Soft-deletes a storage entry. Notes:

No-op in debug mode.

Signature

static deleteEntry(
      storageEntryId: string,
      data: StorageVersionInput,
    ): Promise<StorageEntryView>;

Example

const entry = await storage.deleteEntry(storageEntryId, { version: currentVersion });

`storage.getDownload()`

Generates a signed download URL for a storage file.

Signature

static getDownload(
      storageEntryId: string,
      preview?: boolean,
    ): Promise<StorageDownload>;

Example

const download = await storage.getDownload(storageEntryId, true);

`storage.getText()`

Reads a text window from a storage file.

Signature

static getText(
      storageEntryId: string,
      options?: StorageTextReadOptions,
    ): Promise<StorageTextContent>;

Example

const excerpt = await storage.getText(storageEntryId, {
  startLine: 1,
  endLine: 50,
});

​storage.explore()

​Signature

​Example

​storage.resolveFolderPath()

​Signature

​Example

​storage.ensureFolderPath()

​Signature

​Example

​storage.getFile()

​Signature

​Example

​storage.getFileData()

​Signature

​Example

​storage.getFileStats()

​Signature

​Example

​storage.getEntry()

​Signature

​Example

​storage.createFolder()

​Signature

​Example

​storage.putObject()

​Signature

​Example

​storage.createUploadSession()

​Signature

​Example

​storage.extendUploadSession()

​Signature

​Example

​storage.getUploadSession()

​Signature

​Example

​storage.uploadPart()

​Signature

​Example

​storage.finalizeUploadSession()

​Signature

​Example

​storage.abortUploadSession()

​Signature

​Example

​storage.updateEntry()

​Signature

​Example

​storage.moveEntry()

​Signature

​Example

​storage.archiveEntry()

​Signature

​Example

​storage.restoreEntry()

​Signature

​Example

​storage.deleteEntry()

​Signature

​Example

​storage.getDownload()

​Signature

​Example

​storage.getText()

​Signature

​Example

`storage.explore()`

Signature

Example

`storage.resolveFolderPath()`

Signature

Example

`storage.ensureFolderPath()`

Signature

Example

`storage.getFile()`

Signature

Example

`storage.getFileData()`

Signature

Example

`storage.getFileStats()`

Signature

Example

`storage.getEntry()`

Signature

Example

`storage.createFolder()`

Signature

Example

`storage.putObject()`

Signature

Example

`storage.createUploadSession()`

Signature

Example

`storage.extendUploadSession()`

Signature

Example

`storage.getUploadSession()`

Signature

Example

`storage.uploadPart()`

Signature

Example

`storage.finalizeUploadSession()`

Signature

Example

`storage.abortUploadSession()`

Signature

Example

`storage.updateEntry()`

Signature

Example

`storage.moveEntry()`

Signature

Example

`storage.archiveEntry()`

Signature

Example

`storage.restoreEntry()`

Signature

Example

`storage.deleteEntry()`

Signature

Example

`storage.getDownload()`

Signature

Example

`storage.getText()`

Signature

Example