H5P NodeJS Library
    Preparing search index...

    Class InstalledLibrary

    Stores information about installed H5P libraries.

    Implements

    Index

    Constructors

    constructor

    Properties

    author? coreApi? description? dropLibraryCss? dynamicDependencies? editorDependencies? embedTypes? fullscreen? h? license? machineName majorVersion metadataSettings? minorVersion patchVersion preloadedCss? preloadedDependencies? preloadedJs? restricted runnable title w?

    Methods

    compare compareVersions fromMetadata fromName

    Constructors

    • Parameters

      • machineName: string
      • majorVersion: number
      • minorVersion: number
      • patchVersion: number
      • restricted: boolean = false
      • OptionaloptionalProperties: Partial<IInstalledLibrary>

      Returns InstalledLibrary

    Properties

    author?: string
    coreApi?: { majorVersion: number; minorVersion: number }

    The core API required to run the library.

    description?: string
    dropLibraryCss?: { machineName: string }[]
    dynamicDependencies?: ILibraryName[]
    editorDependencies?: ILibraryName[]
    embedTypes?: ("div" | "iframe")[]
    fullscreen?: 0 | 1
    h?: number
    license?: string
    machineName: string

    The name used to identify the library (e.g. H5P.Example)

    majorVersion: number

    The major version of the library (e.g. 1)

    metadataSettings?: { disable: 0 | 1; disableExtraTitleField: 0 | 1 }
    minorVersion: number

    The minor version of the library (e.g. 0)

    patchVersion: number
    preloadedCss?: IPath[]
    preloadedDependencies?: ILibraryName[]
    preloadedJs?: IPath[]
    restricted: boolean = false

    If set to true, the library can only be used be users who have this special privilege.

    runnable: boolean | 0 | 1
    title: string
    w?: number

    Methods

    • Compares libraries by giving precedence to major version, then minor version, then if present patch version.

      Parameters

      Returns number

      a negative value: if this library is older than the other library a positive value: if this library is newer than the other library zero: if both libraries are the same (or if it can't be determined, because the patch version is missing in the other library)

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods