@types/react-native-pdf-lib
TypeScript icon, indicating that this package has built-in type declarations

0.2.3 • Public • Published

Installation

npm install --save @types/react-native-pdf-lib

Summary

This package contains type definitions for react-native-pdf-lib (https://github.com/Hopding/react-native-pdf-lib#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-pdf-lib.

index.d.ts

declare let PDFLib: {
    getDocumentsDirectory(): string;
};

export default PDFLib;

export class PDFDocument {
    static create(path: string): PDFDocument;

    addPages(pages: PDFPage[]): PDFDocument;

    /* Saves the document and returns the path to the file it wrote */
    write(): Promise<string>;
}

export interface SetMediaBoxOptions {
    x?: number | undefined;
    y?: number | undefined;
}

export interface TextDrawingOptions {
    x?: number | undefined;
    y?: number | undefined;
    color?: string | undefined;
    fontName?: string | undefined;
    fontSize?: number | undefined;
}

export interface RectangleDrawingOptions {
    x?: number | undefined;
    y?: number | undefined;
    width?: number | undefined;
    height?: number | undefined;
    color?: string | undefined;
}

export interface ImageDrawingOptions {
    x?: number | undefined;
    y?: number | undefined;
    width?: number | undefined;
    height?: number | undefined;
}

export class PDFPage {
    static create(): PDFPage;

    setMediaBox(width: number, height: number, options?: SetMediaBoxOptions): PDFPage;

    drawText(text: string, options?: TextDrawingOptions): PDFPage;
    drawRectangle(options?: RectangleDrawingOptions): PDFPage;
    drawImage(imageUri: string, options?: ImageDrawingOptions): PDFPage;
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:39 GMT
  • Dependencies: none

Credits

These definitions were written by Kevin Brown.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/react-native-pdf-lib

Weekly Downloads

270

Version

0.2.3

License

MIT

Unpacked Size

5.28 kB

Total Files

5

Last publish

Collaborators

  • types