Class PCDCollection

constructor

• new PCDCollection(packages, pcds?, folders?): PCDCollection

• Parameters

  • packages: PCDPackage<any, any, any, any>[]
  • Optional pcds: PCD<unknown, unknown>[]
  • Optional folders: Record<string, string>

  Returns PCDCollection

Readonly changeEmitter

folders

add

• add(pcd, options?): void

• Parameters

  • pcd: PCD<unknown, unknown>
  • Optional options: AddPCDOptions

  Returns void

addAll

• addAll(pcds, options?): void

• Parameters

  • pcds: PCD<unknown, unknown>[]
  • Optional options: AddPCDOptions

  Returns void

bulkSetFolder

• bulkSetFolder(pcdIds, folder): void

• Parameters

  • pcdIds: string[]
  • folder: string

  Returns void

deserialize

• deserialize(serialized, options?): Promise<PCD<unknown, unknown>>

• Parameters

  • serialized: SerializedPCD<PCD<unknown, unknown>>
  • Optional options: {
        fallbackDeserializeFunction?: FallbackDeserializeFunction;
    }

    • Optional fallbackDeserializeFunction?: FallbackDeserializeFunction

  Returns Promise<PCD<unknown, unknown>>

deserializeAll

• deserializeAll(serialized, options?): Promise<PCD<unknown, unknown>[]>

• Parameters

  • serialized: SerializedPCD<PCD<unknown, unknown>>[]
  • Optional options: {
        fallbackDeserializeFunction?: FallbackDeserializeFunction;
    }

    • Optional fallbackDeserializeFunction?: FallbackDeserializeFunction

  Returns Promise<PCD<unknown, unknown>[]>

deserializeAllAndAdd

• deserializeAllAndAdd(serialized, options?): Promise<void>

• Parameters

  • serialized: SerializedPCD<PCD<unknown, unknown>>[]
  • Optional options: {
        fallbackDeserializeFunction?: FallbackDeserializeFunction;
        upsert?: boolean;
    }

    • Optional fallbackDeserializeFunction?: FallbackDeserializeFunction

    • Optional upsert?: boolean

  Returns Promise<void>

deserializeAndAdd

• deserializeAndAdd(serialized, options?): Promise<void>

• Parameters

  • serialized: SerializedPCD<PCD<unknown, unknown>>
  • Optional options: {
        fallbackDeserializeFunction?: FallbackDeserializeFunction;
        upsert?: boolean;
    }

    • Optional fallbackDeserializeFunction?: FallbackDeserializeFunction

    • Optional upsert?: boolean

  Returns Promise<void>

getAll

• getAll(): PCD<unknown, unknown>[]

• Returns PCD<unknown, unknown>[]

getAllFolderNames

• getAllFolderNames(): string[]

• Returns string[]

getAllIds

• getAllIds(): string[]

• Returns string[]

getAllPCDsInFolder

• getAllPCDsInFolder(folder): PCD<unknown, unknown>[]

• Parameters

  • folder: string

  Returns PCD<unknown, unknown>[]

getById

• getById(id): undefined | PCD<unknown, unknown>

• Parameters

  • id: string

  Returns undefined | PCD<unknown, unknown>

getByIds

• getByIds(ids): PCD<unknown, unknown>[]

• Parameters

  • ids: string[]

  Returns PCD<unknown, unknown>[]

getFolderOfPCD

• getFolderOfPCD(pcdId): undefined | string

• Parameters

  • pcdId: string

  Returns undefined | string

getFoldersInFolder

• getFoldersInFolder(folderPath): string[]

• Parameters

  • folderPath: string

  Returns string[]

getHash

• getHash(): Promise<string>

• Generates a unique hash based on the contents. This hash changes whenever the set of pcds, or the contents of the pcds changes.

  Returns Promise<string>

getPCDsByType

• getPCDsByType(type): PCD<unknown, unknown>[]

• Parameters

  • type: string

  Returns PCD<unknown, unknown>[]

getPackage

• getPackage<T>(name): undefined | T

• Type Parameters

  • T extends PCDPackage<any, any, any, any> = PCDPackage<any, any, any, any>

  Parameters

  • name: string

  Returns undefined | T

getSize

• getSize(): number

• Returns number

hasPCDWithId

• hasPCDWithId(id): boolean

• Parameters

  • id: string

  Returns boolean

hasPackage

• hasPackage(name): boolean

• Parameters

  • name: string

  Returns boolean

isValidFolder

• isValidFolder(folderPath): boolean

• Parameters

  • folderPath: string

  Returns boolean

merge

• merge(other, options?): void

• Merges another PCD collection into this one. There is one option:

  • shouldInclude is a function used to filter out PCDs from the other collection during merging, e.g. to filter out duplicates or PCDs of a type that should not be copied.

  Parameters

  • other: PCDCollection
  • Optional options: {
        shouldInclude?: MergeFilterPredicate;
    }

    • Optional shouldInclude?: MergeFilterPredicate

  Returns void

remove

• remove(pcdId): Promise<void>

• Parameters

  • pcdId: string

  Returns Promise<void>

removeAllPCDsInFolder

• removeAllPCDsInFolder(folder): void

• Parameters

  • folder: string

  Returns void

replacePCDsInFolder

• replacePCDsInFolder(folder, pcds): void

• Parameters

  • folder: string
  • pcds: PCD<unknown, unknown>[]

  Returns void

serialize

• serialize(pcd): Promise<SerializedPCD<PCD<unknown, unknown>>>

• Parameters

  • pcd: PCD<unknown, unknown>

  Returns Promise<SerializedPCD<PCD<unknown, unknown>>>

serializeAll

• serializeAll(): Promise<SerializedPCD<PCD<unknown, unknown>>[]>

• Returns Promise<SerializedPCD<PCD<unknown, unknown>>[]>

serializeCollection

• serializeCollection(): Promise<string>

• Returns Promise<string>

setFolder

• setFolder(pcdId, folder): void

• Parameters

  • pcdId: string
  • folder: string

  Returns void

setPCDFolder

• setPCDFolder(pcdId, folder): void

• Parameters

  • pcdId: string
  • folder: string

  Returns void

size

• size(): number

• Returns number

tryExec

• tryExec(action, permissions): Promise<boolean>

• Parameters

  • action: PCDAction
  • permissions: PCDFolderPermission[]

  Returns Promise<boolean>

tryExecutingActionWithPermission

• tryExecutingActionWithPermission(action, permission): Promise<boolean>

• Parameters

  • action: PCDAction
  • permission: PCDFolderPermission

  Returns Promise<boolean>

Static deserialize

• deserialize(packages, serialized, options?): Promise<PCDCollection>

• Parameters

  • packages: PCDPackage<any, any, any, any>[]
  • serialized: string
  • Optional options: {
        fallbackDeserializeFunction?: FallbackDeserializeFunction;
    }

    • Optional fallbackDeserializeFunction?: FallbackDeserializeFunction

  Returns Promise<PCDCollection>