npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pdfless/pdfless-js

v1.0.510

Published

Pdfless-js is a javascript library

Downloads

258

Readme

Introduction

The Official Pdfless javascript to consume Pdfless API

This library allows you to quickly and easily generate PDF document.

Prerequisites

Pdfless account is required, sign up for free.

Installation

Using the Node Package Manager (CLI):

npm i @pdfless/pdfless-js

Supported Operations

The library supports the following operation:

  • Create a PDF document: Create a PDF document based on selected template identifier and defined payload.
  • Get workspace information: Retrieve workspace information based on API key.
  • List document templates: Paginated list of document templates.

Create a PDF document

Import PdfService as a default import and instantiate it as new PdfService(apiKey) with your workspace API key. Use generate(command) function to generate PDF with a GeneratePDFCommand command.

|Property|Required|Type|Description| |---|---|---|---| |template_id|Yes|string|Select a document template of workspace.| |payload|Yes|string|If your document contains variables, enter data in JSON format corresponding to defined variables. You can read more about this here.|

import { PdfService } from '@pdfless/pdfless-js';

async function main(): Promise<void> {
  try {
    // Create the Pdf service
    const pdfService = = new PdfService("ak_xxxxxxxxxxxxx");
    
    // Generate PDF with sample payload in JSON
    const payload: GeneratePDFCommand = {
        firstName: "Nicolas",
        lastName: "Law",
        companyName: "Synapsium",
        articles: [
            { name: "tshirt", price: 10, quantity: 4 },
            { name: "short", price: 20, quantity: 1 }
        ]
    };
    const generatePDFCommand = { 
        template_id: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        payload: JSON.stringify(payload)
    }
    pdfService.generate(generatePDFCommand);
  } catch (err) {
    console.log(err);
  }
}

main();

Get workspace information

You can use this function to check if your workspace exists or already available.

Import WorkspaceService as a default import and instantiate it as new WorkspaceService(apiKey) with your workspace API key.

import { WorkspaceService } from '@pdfless/pdfless-js';

async function main(): Promise<void> {
  try {
    // Create the Workspace service
    const workspaceService = = new WorkspaceService("ak_xxxxxxxxxxxxx");
    
    // Get workspace information 
    workspaceService.get();
  } catch (err) {
    console.log(err);
  }
}

main();

List document templates

Import TemplateService as a default import and instantiate it as new TemplateService(apiKey) with your workspace API key.

|Property|Required|Type|Description|Default |---|---|---|---|---| |page|Yes|number|Page number.|1| |pageSize|Yes|number|Number of item by page.|25|

import { TemplateService } from '@pdfless/pdfless-js';


async function main(): Promise<void> {
  try {
    // Create the Template service
    const templateService = = new TemplateService("ak_xxxxxxxxxxxxx");
    
    // List template of current workspace
    templateService.list(1, 50);
  } catch (err) {
    console.log(err);
  }
}

main();