No Partying Mariachis

    @advisr/pptx-compose-2
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    pptx-compose npm version

    Parses Open Office XML generated PPTX to JSON

    Install

    $ npm install pptx-compose
    

    See changelog here for API updates and compatibility issues.

    Usage

    import PPTXCompose from "pptx-compose";
    
    // Initialize repo
    const composer = new PPTXCompose(options);
    
    // Parses a PPTX file to JSON
    const pptx = await composer.toJSON("/path/to/my.pptx");
    
    // Parses JSON output to PPTX
    const json = await composer.toPPTX("/path/to/my.json");

    CLI

    Composer is able to generate JSON from PPTX source directly from CLI, run:

    # Usage: convert [options] <input> <output>
    # Options:
    #   -V, --version  output the version number
    #   -i, --input    PPTX File
    #   -o, --output   Output JSON file (optional)
    #   -h, --help     display help for command
    
    $ node bin/convert ./path/to/my.pptx path/to/your/directory/generated.json

    Options

    attribute type default
    jszipBinary "nodebuffer" / "base64" / "text" / "binarystring" / \ "array" / "uint8array" / "arraybuffer" / "blob" nodebuffer
    jszipGenerateType "nodebuffer" / "base64" / "text" / "binarystring" / \ "array" / "uint8array" / "arraybuffer" / "blob" nodebuffer

    Methods

    PPTX Composer has following built-in methods:

    .toJSON(<pptx_file_path>, <options{Options & { output: string }}>)

    Parse PowerPoint file to JSON.

    const composer = new PPTXCompose();
    
    // Parses a PPTX file to JSON
    const pptx = await composer.toJSON("/path/to/my.pptx");
    
    // Convert a PPTX file to JSON file
    composer.toJSON("/path/to/my.pptx", {
      output: "/path/to/output/file.pptx",
    });

    .toPPTX(<json>, <options{Options & { output: string }}>)

    Convert JSON file to PPTX.

    const composer = new PPTXCompose('{ "my": "json" ... }');
    
    // Parses JSON output to PPTX
    const json = await composer.toPPTX("/path/to/my.json");
    
    // Convert JSON to PPTX file
    composer.toJSON("/path/to/my.json", {
      output: "/path/to/output/file.pptx",
    });

    License

    MIT

    Install

    npm i @advisr/pptx-compose-2

    DownloadsWeekly Downloads

    32

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    14.8 kB

    Total Files

    11

    Last publish

    Collaborators

    • jrohland