Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SCMAPI

System Configuration Manager (SCM) API.

Hierarchy

  • SCMAPI

Index

Properties

Methods

Properties

scmPath

scmPath: string

SCM storage path.

Methods

createRoot

  • createRoot(name: string, description?: string): void

  • Creates a root.

    Parameters

    • name: string

      The name of the root to create.

    • Optional description: string

      The description of this root.

    Returns void

get

  • get(path: string): any

  • Gets an object at the specified path.

    Parameters

    • path: string

      The path of the object to retrieve.

    Returns any

getIndex

  • Returns the index for the specified root.

    Parameters

    • name: string

      The name of the root to find the index for.

    Returns SCMIndex

loadAll

  • loadAll(scmPathOverride?: string): Promise<void>

  • [system] Loads all SCM configuration.

    Parameters

    • Optional scmPathOverride: string

      SCM root directory path on the filesystem.

    Returns Promise<void>

ls

  • Lists entries in the specified path.

    Parameters

    • path: string

      The path to use.

    Returns SCMItem[]

remove

  • remove(path: string): boolean | void

  • Removes an object.

    Parameters

    • path: string

      The path to remove the object from.

    Returns boolean | void

removeAndSync

  • removeAndSync(path: string): Promise<boolean | void>

  • Removes an object.

    Parameters

    • path: string

      The path to remove the object from.

    Returns Promise<boolean | void>

set

  • set(path: string, value: string): void

  • Sets an object at the specified path.

    Parameters

    • path: string

      The path of the item to set.

    • value: string

      The value to set.

    Returns void

setAndSync

  • setAndSync(path: string, value: string): Promise<void>

  • Sets an object at the specified path and immediately synchronizes the change.

    Parameters

    • path: string

      The path of the item to set.

    • value: string

      The value to set.

    Returns Promise<void>

syncAll

  • syncAll(): Promise<void>

  • Flushes the current sys config to disk.

    Returns Promise<void>

syncRoot

  • syncRoot(name: string): Promise<void>

  • Synchronizes the specified root.

    Parameters

    • name: string

      The name of the root to sync.

    Returns Promise<void>

Generated using TypeDoc