@govuk-pay/pay-js-commons 4.0.17 → 5.0.2
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 +9 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,7 @@ Reusable js scripts for GOV.UK Pay Node.js projects
|
|
|
4
4
|
- [Browsered scripts](#browsered-scripts)
|
|
5
5
|
- [Utilities](#utilities)
|
|
6
6
|
- [Nunjucks filters](#nunjucks-filters)
|
|
7
|
+
- [HTTPS base client](#https-base-client)
|
|
7
8
|
- [Releasing a new version](#releasing-a-new-version)
|
|
8
9
|
|
|
9
10
|
## Browsered scripts
|
|
@@ -144,10 +145,10 @@ i.e. ``< > ; : ` ( ) " \' = | , ~ [ ]``
|
|
|
144
145
|
|
|
145
146
|
## Utilities
|
|
146
147
|
|
|
147
|
-
These are small functions that power the nunjucks filters but can also be used for server side stuff too.
|
|
148
|
-
|
|
149
148
|
### Nunjucks filters
|
|
150
149
|
|
|
150
|
+
These are small functions that power the nunjucks filters but can also be used for server side stuff too.
|
|
151
|
+
|
|
151
152
|
These get loaded in to the Nunjucks environment and then can apply changes to variables in templates.
|
|
152
153
|
|
|
153
154
|
For example if a country comes in as ISO code `EN` it can be converted to it’s name like so
|
|
@@ -165,6 +166,12 @@ Or a pence value can be converted to GBP
|
|
|
165
166
|
</dl>
|
|
166
167
|
```
|
|
167
168
|
|
|
169
|
+
### Https base client
|
|
170
|
+
|
|
171
|
+
Used in our Node.js apps to call internal APIs such as connector or ledger.
|
|
172
|
+
|
|
173
|
+
Uses the NPM Axios library.
|
|
174
|
+
|
|
168
175
|
## Releasing
|
|
169
176
|
|
|
170
177
|
After a pull request is merged, Concourse will automatically create a new release pull request that increments the package version.
|