Class ObjectUri

constructor

• new ObjectUri(str?: string, label?: string | undefined): ObjectUri

  Creates a new ObjectUri instance from a path string. ex: 'xyz', '@backend:xyz', 'collection/xyz', '@backend:collection/xyz'

  Parameters

  • str: string = ''

    Partial or full resource path.

  • label: string | undefined = ''

    Optional label describing the resource path.

  Returns ObjectUri

StaticDEFAULT

StaticMISSING_COLLECTION

backend

• get backend(): string | undefined

  Retrieves the target backend alias.

  Returns string | undefined

  The backend identifier, or undefined if not set.

class

• get class(): any

  Retrieves the model class bound to the URI.

  Returns any

  The model class reference.

• set class(objClass: any): void

  Binds a model class reference to resolve collection details.

  Parameters

  • objClass: any

    The model constructor class.

  Returns void

collection

• get collection(): string | undefined

  Retrieves the collection or table name context.

  Returns string | undefined

  The collection name, or undefined.

• set collection(collection: string | undefined): void

  Injects a specific collection or table context name.

  Parameters

  • collection: string | undefined

    The target collection name.

  Returns void

label

• get label(): string | undefined

  Retrieves the human-readable label representation.

  Returns string | undefined

  The descriptive label, or undefined.

• set label(label: string | undefined): void

  Sets the human-readable label representation.

  Parameters

  • label: string | undefined

    The descriptive string label.

  Returns void

literal

• get literal(): string

  Return the full path literal, including the backend alias.

  Returns string

  The fully qualified URI literal.

ownPath

• get ownPath(): string

  Returns the own path of the resource without the optional parents' paths.

  Returns string

  The own path segment string.

parent

• get parent(): ObjectUri | undefined

  Retrieves the parent ObjectUri context.

  Returns ObjectUri | undefined

  The parent ObjectUri reference, or undefined.

path

• get path(): string

  Returns the full path of the resource, including optional parents' paths.

  Returns string

  The computed path string.

• set path(path: string): void

  Overwrites the path and automatically recalculates collection details.

  Parameters

  • path: string

    The new relative path segment.

  Returns void

uid

• get uid(): string | undefined

  Retrieves the unique identifier of the resource.

  Returns string | undefined

  The unique ID string.

toJSON

• toJSON(): any

  Output pure object dictionary representation.

  Returns any

  Rendered JSON-like URI block representation.

toReference

• toReference(): { label: string | undefined; ref: string; uri: string }

  Returns references to locate the target object locally and remotely.

  Returns { label: string | undefined; ref: string; uri: string }

  An object detailing path, uri literal, and label.