For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /lynxtron/api/@lynx-js/lynxtron/Class.Archive.md.
  • English
  • @lynx-js/lynxtron / Archive

    Archive

    Constructors

    new Archive()

    new Archive(asarPath: string): Archive

    Create an archive handle from a .asar path.

    Parameters

    ParameterType
    asarPathstring

    Returns

    Archive

    Defined in

    apis/api/asar.d.ts:82

    Methods

    copyFileOut()

    copyFileOut(filePath: string): string | false

    Copy the file out into a temporary file and returns the new path.

    Parameters

    ParameterType
    filePathstring

    Returns

    string | false

    Defined in

    apis/api/asar.d.ts:102


    getFdAndValidateIntegrityLater()

    getFdAndValidateIntegrityLater(): number

    Return the file descriptor.

    Returns

    number

    Defined in

    apis/api/asar.d.ts:106


    getFileInfo()

    getFileInfo(filePath: string): false | AsarFileInfo

    Reads the offset and size of file.

    Parameters

    ParameterType
    filePathstring

    Returns

    false | AsarFileInfo

    Defined in

    apis/api/asar.d.ts:86


    readdir()

    readdir(dirPath: string): false | string[]

    Returns all files under a directory.

    Parameters

    ParameterType
    dirPathstring

    Returns

    false | string[]

    Defined in

    apis/api/asar.d.ts:94


    realpath()

    realpath(filePath: string): string | false

    Returns the path of file with symbol link resolved.

    Parameters

    ParameterType
    filePathstring

    Returns

    string | false

    Defined in

    apis/api/asar.d.ts:98


    stat()

    stat(filePath: string): false | AsarFileStat

    Returns a fake result of fs.stat(path).

    Parameters

    ParameterType
    filePathstring

    Returns

    false | AsarFileStat

    Defined in

    apis/api/asar.d.ts:90

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.