Mirrors/Stirling-PDF
Mirrors/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Frooodle/Stirling-PDF.git synced 2024-12-21 19:08:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
2cb2116940
Stirling-PDF/CONTRIBUTE.md
Saud Fatayerji 0a43660e55 Merge branch 'stirling-pdf-rewrite' into version-2
2023-11-08 02:11:49 +03:00

1.8 KiB
Raw Blame History

Contribute

This file should introduce you with the concepts and tools used in this project.

PDF Library Docs

Adding a PDF Operation

StirlingPDF aims to support as many types of operations as possible, including some that cannot be executed in the client. Because of this, we have decided to move some of the shared functionality into it's own node module so that it can be shared by both client and server.

Adding a shared (server + client) operation

  1. Add the code for the operation to a new file in the functions folder.

NOTE: many of the functions in these files use dependency injection (see impose for an example).

Explanation: Because some libraries need to be imported in different ways. We import the library as needed in the pdf-operations.js files, then pass the required library objects into the operation function as a parameter.

  1. Now that we have the function code, we need to tell the other modules that it exists. Edit the server operations and the client operations files to add your new operation! (Try to follow existing patterns where possible, keep the added operations in alphabetical order in the files).

  2. If you added a wrapper function to the client operations file, you will also need to add the TypeScript declarations to the declaration file. See the other module declarations for examples.

Adding a server only operation

WIP