@tryghost/url-utils 2.0.5 → 2.0.8

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.
Files changed (2) hide show
  1. package/lib/index.js +4 -4
  2. package/package.json +4 -4
package/lib/index.js CHANGED
@@ -19,12 +19,12 @@ module.exports = class UrlUtils {
19
19
  * @param {Function} options.getSiteUrl
20
20
  * @param {Function} options.getAdminUrl Ghost instance admin URL
21
21
  * @param {Object} options.apiVersions configuration object which has defined `all` property which is an array of keys for other available properties
22
- * @param {('v2' | 'v3' | 'v4' | 'canary')} [options.defaultApiVersion] default API version which is one of the values from options.apiVersions
23
- * @param {('content' | 'admin')} [options.defaultApiType] default API type to be used and is one of the values from options.apiVersions
22
+ * @param {('v2' | 'v3' | 'v4' | 'canary')} [options.defaultApiVersion='v4'] default API version which is one of the values from options.apiVersions
23
+ * @param {('content' | 'admin')} [options.defaultApiType='content'] default API type to be used and is one of the values from options.apiVersions
24
24
  * @param {Object} [options.slugs] object with 2 properties reserved and protected containing arrays of special case slugs
25
25
  * @param {Number} [options.redirectCacheMaxAge]
26
- * @param {String} [options.baseApiPath] static prefix for serving API. Should not te passed in, unless the API is being run under custom URL
27
- * @param {String} [options.staticImageUrlPrefix] static prefix for serving images. Should not be passed in, unless customizing ghost instance image storage
26
+ * @param {String} [options.baseApiPath='/ghost/api'] static prefix for serving API. Should not te passed in, unless the API is being run under custom URL
27
+ * @param {String} [options.staticImageUrlPrefix='content/images'] static prefix for serving images. Should not be passed in, unless customizing ghost instance image storage
28
28
  */
29
29
  constructor(options = {}) {
30
30
  const defaultOptions = {
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@tryghost/url-utils",
3
- "version": "2.0.5",
3
+ "version": "2.0.8",
4
4
  "repository": "https://github.com/TryGhost/SDK/tree/master/packages/url-utils",
5
5
  "author": "Ghost Foundation",
6
6
  "license": "MIT",
7
7
  "main": "lib/index.js",
8
8
  "scripts": {
9
9
  "dev": "echo \"Implement me!\"",
10
- "test": "NODE_ENV=testing c8 --reporter text --reporter cobertura mocha './test/**/*.test.js'",
10
+ "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
11
11
  "lint": "eslint . --ext .js --cache",
12
12
  "posttest": "yarn lint"
13
13
  },
@@ -18,7 +18,7 @@
18
18
  "access": "public"
19
19
  },
20
20
  "devDependencies": {
21
- "@tryghost/config-url-helpers": "0.1.4",
21
+ "@tryghost/config-url-helpers": "0.1.5",
22
22
  "c8": "7.11.0",
23
23
  "mocha": "7.2.0",
24
24
  "rewire": "5.0.0",
@@ -33,5 +33,5 @@
33
33
  "remark-footnotes": "^1.0.0",
34
34
  "unist-util-visit": "^2.0.0"
35
35
  },
36
- "gitHead": "fd46ea76699b5f56bb9cd5dfbcd2095ff3863387"
36
+ "gitHead": "36ffe70168eb2ad3eaefa0dc63a35697b284c9e7"
37
37
  }