@snett2019/factura-pdf 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -1
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -4,4 +4,50 @@ Generador de PDFs para facturación personalizada usando `pdfkit`.
|
|
|
4
4
|
## Instalación
|
|
5
5
|
|
|
6
6
|
```bash
|
|
7
|
-
npm install @snett2019/factura-pdf
|
|
7
|
+
npm install @snett2019/factura-pdf
|
|
8
|
+
|
|
9
|
+
## Uso básico
|
|
10
|
+
|
|
11
|
+
```js
|
|
12
|
+
const { generarFacturas } = require('@snett2019/factura-pdf');
|
|
13
|
+
const pedido = require('./sample-order.json');
|
|
14
|
+
|
|
15
|
+
generarFacturas(pedido, './salida');
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Testeo local
|
|
19
|
+
|
|
20
|
+
Para probar el generador localmente con un ejemplo incluido, ejecuta:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
node test/test-generate.js
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Este comando generará los archivos PDF en la carpeta `./salida`.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 📥 Parámetros de la función
|
|
31
|
+
|
|
32
|
+
| Parámetro | Tipo | Descripción |
|
|
33
|
+
|-----------------|----------|------------------------------------------------------------|
|
|
34
|
+
| `pedido` | `Object` | Objeto con los datos del pedido (cliente, productos, etc.) |
|
|
35
|
+
| `carpetaSalida` | `String` | Ruta donde se guardarán los PDFs generados |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Salida esperada
|
|
40
|
+
|
|
41
|
+
Se generan **3 archivos PDF** en la carpeta especificada:
|
|
42
|
+
|
|
43
|
+
- `cliente_<ID>.pdf`
|
|
44
|
+
- `cocina_<ID>.pdf`
|
|
45
|
+
- `domiciliario_<ID>.pdf`
|
|
46
|
+
|
|
47
|
+
> Donde `<ID>` es el número del pedido incluido en el objeto `pedido`.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Autor
|
|
52
|
+
|
|
53
|
+
Santiago Trujillo Neuta – [GitHub](https://github.com/Santiago-byte2002)
|
package/package.json
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@snett2019/factura-pdf",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"main": "src/index.js",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"scripts": {
|
|
7
7
|
"generar": "node test/test-generate.js"
|
|
8
8
|
},
|
|
9
|
-
"keywords": [
|
|
9
|
+
"keywords": [
|
|
10
|
+
"factura",
|
|
11
|
+
"pdf",
|
|
12
|
+
"generador",
|
|
13
|
+
"facturación",
|
|
14
|
+
"pdfkit"
|
|
15
|
+
],
|
|
10
16
|
"author": "Santiago Trujillo Neuta",
|
|
11
17
|
"license": "MIT",
|
|
12
18
|
"description": "Generador de PDFs para facturación personalizada",
|