StorageEntry

Parameters and properties

• revisionOptional
  string | undefined
  Object revision for a transport inventory entry; absent for local filesystem inventory.
• nameRequired
  string
  Basename of the entry, or the full object key for a transport inventory.
• pathRequired
  string
  Host path of the entry, or the object key for a transport inventory.
• kindRequired
  StorageEntryKind
  file, directory, symlink, other or unknown, read without following symbolic links. unknown means the entry could not be read or lay past the entry limit; transport objects are file.
• modifiedAtOptional
  string | undefined
  Latest modification time as an ISO timestamp, including the scanned children of a directory.
• completeRequired
  boolean
  false when this entry or one of its children hit a scan limit or could not be read.
• bytesRequired
  number
  Sum of regular file sizes in this entry and its scanned children; symbolic links and directories count 0. The object size for a transport.
• filesRequired
  number
  Number of regular files counted in the scanned storage.
• directoriesRequired
  number
  Number of directories counted in the scanned storage.
• symlinksRequired
  number
  Number of symbolic links counted without traversing their targets.
• otherRequired
  number
  Number of filesystem entries that are neither regular files, directories nor symbolic links.

Signature

export interface StorageEntry extends StorageUsage {
  readonly revision?: string;
  readonly name: string;
  readonly path: string;
  kind: StorageEntryKind;
  modifiedAt?: string;
  complete: boolean;
}

Related contracts

• StorageEntryKind
• StorageUsage