@@ -38,13 +38,28 @@ To download your pass signing certificate, do the following:
38
38
| signCert | String | Required | Path to Pass Signing Certificate. |
39
39
| password | String | Optional | The Password of the Pass Signing Certificate. |
40
40
### Method: add
41
- | Name | Type | Required | Description |
42
- | ----------| ------------------| ----------| ---------------------------|
43
- | filename | String | Required | Filename with extension. |
44
- | data | Buffer \| String | Required | File contents. |
45
- | language | String | Optional | Language Code (ISO 639-1) |
41
+ | Name | Type | Required | Description |
42
+ | ----------| ------------------| ----------| ------------------------------------------------ |
43
+ | filename | String | Required | Filename with extension. |
44
+ | data | Buffer \| String | Required | File path as string or file content as buffer. |
45
+ | language | String | Optional | Language Code (ISO 639-1). |
46
46
47
47
## Usage
48
+ Directory structure of a sample pass.
49
+ ```
50
+ .
51
+ └── Sample.pass/
52
+ ├── icon.png
53
+
54
+ ├── pass.json
55
+ ├── en.lproj/
56
+ │ ├── logo.png
57
+
58
+ └── th.lproj/
59
+ ├── logo.png
60
+
61
+ ```
62
+
48
63
``` js
49
64
const PassGenerator = require (' passgenerator-js' )
50
65
@@ -55,16 +70,16 @@ const passGenerator = new PassGenerator({
55
70
56
71
const pass = passGenerator .createPass ()
57
72
58
- pass .add (' icon.png' , ' ./Generic .pass/icon.png' )
59
-
73
+ pass .add (' icon.png' , ' ./Sample .pass/icon.png' )
74
+
60
75
61
- pass .add (' logo.png' , ' ./Generic.pass/logo.png' )
62
-
76
+ pass .add (' pass.json' , ' ./Sample.pass/pass.json' )
63
77
64
- pass .add (' logo.png' , ' ./Generic .pass/th .lproj/logo.png' , ' th ' )
65
- pass .
add (
' [email protected] ' ,
' ./Generic .pass/th .lproj/[email protected] ' ,
' th ' )
78
+ pass .add (' logo.png' , ' ./Sample .pass/en .lproj/logo.png' , ' en ' )
79
+ pass .
add (
' [email protected] ' ,
' ./Sample .pass/en .lproj/[email protected] ' ,
' en ' )
66
80
67
- pass .add (' pass.json' , ' ./Generic.pass/pass.json' )
81
+ pass .add (' logo.png' , ' ./Sample.pass/th.lproj/logo.png' , ' th' )
82
+ pass .
add (
' [email protected] ' ,
' ./Sample.pass/th.lproj/[email protected] ' ,
' th' )
68
83
69
84
const pkpass = pass .generate ()
70
85
0 commit comments