@anmiles/downloader 2.0.1 → 2.0.3

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 (8) hide show
  1. package/.eslintrc.js +1 -88
  2. package/CHANGELOG.md +11 -2
  3. package/README.md +3 -8
  4. package/dist/lib/downloader.d.ts +3 -2
  5. package/dist/lib/downloader.js.map +1 -1
  6. package/package.json +3 -2
  7. package/src/lib/downloader.ts +4 -2
  8. package/file +0 -0
package/.eslintrc.js CHANGED
@@ -1,93 +1,6 @@
1
1
  module.exports = {
2
2
  root : true,
3
3
  extends : [
4
- 'eslint:recommended',
5
- 'plugin:jest/recommended',
4
+ './node_modules/@anmiles/eslint-config/.eslintrc.js',
6
5
  ],
7
- parser : '@typescript-eslint/parser',
8
- parserOptions : {
9
- ecmaVersion : 2019,
10
- sourceType : 'module',
11
- },
12
- plugins : [
13
- '@typescript-eslint',
14
- 'align-assignments',
15
- 'import',
16
- 'jest',
17
- ],
18
- env : {
19
- node : true,
20
- jest : true,
21
- },
22
- ignorePatterns : [
23
- '**/node_modules/',
24
- 'coverage/',
25
- 'dist/',
26
- ],
27
- rules : {
28
- 'no-unused-vars' : [ 'off' ],
29
- '@typescript-eslint/no-redeclare' : [ 'error' ],
30
- '@typescript-eslint/no-unused-vars' : [ 'error' ],
31
- 'align-assignments/align-assignments' : [ 'error' ],
32
- 'array-bracket-spacing' : [ 'error', 'always' ],
33
- 'arrow-body-style' : [ 'error' ],
34
- 'arrow-parens' : [ 'error' ],
35
- 'arrow-spacing' : [ 'error' ],
36
- 'block-spacing' : [ 'error' ],
37
- 'brace-style' : [ 'error' ],
38
- 'camelcase' : [ 'error' ],
39
- 'comma-dangle' : [ 'error', 'always-multiline' ],
40
- 'comma-spacing' : [ 'error' ],
41
- 'comma-style' : [ 'error' ],
42
- 'complexity' : [ 'error' ],
43
- 'computed-property-spacing' : [ 'error', 'never' ],
44
- 'curly' : [ 'error' ],
45
- 'dot-location' : [ 'error', 'property' ],
46
- 'eol-last' : [ 'error' ],
47
- 'func-call-spacing' : [ 'error' ],
48
- 'func-style' : [ 'error', 'declaration', { allowArrowFunctions : true } ],
49
- 'generator-star-spacing' : [ 'error', 'neither' ],
50
- 'import/order' : [ 'error', { groups : [ 'builtin', 'external', 'unknown', 'internal', 'parent', 'sibling', 'index' ] } ],
51
- 'indent' : [ 'error', 'tab', { SwitchCase : 1 } ],
52
- 'jest/no-standalone-expect' : [ 'error' ],
53
- 'key-spacing' : [ 'error', { beforeColon : true, afterColon : true, align : 'colon' } ],
54
- 'keyword-spacing' : [ 'error' ],
55
- 'linebreak-style' : [ 'error', 'unix' ],
56
- 'max-params' : [ 'error', { max : 5 } ],
57
- 'new-parens' : [ 'error' ],
58
- 'no-eval' : [ 'error' ],
59
- 'no-extra-bind' : [ 'error' ],
60
- 'no-floating-decimal' : [ 'error' ],
61
- 'no-implied-eval' : [ 'error' ],
62
- 'no-loop-func' : [ 'error' ],
63
- 'no-mixed-spaces-and-tabs' : [ 'error', 'smart-tabs' ],
64
- 'no-multiple-empty-lines' : [ 'error', { max : 1, maxEOF : 1, maxBOF : 0 } ],
65
- 'no-redeclare' : [ 'off' ],
66
- 'no-return-await' : [ 'error' ],
67
- 'no-trailing-spaces' : [ 'error' ],
68
- 'no-useless-rename' : [ 'error' ],
69
- 'no-var' : [ 'error' ],
70
- 'no-whitespace-before-property' : [ 'error' ],
71
- 'object-curly-spacing' : [ 'error', 'always' ],
72
- 'object-property-newline' : [ 'error', { allowMultiplePropertiesPerLine : true } ],
73
- 'object-shorthand' : [ 'error' ],
74
- 'operator-linebreak' : [ 'error', 'before' ],
75
- 'prefer-const' : [ 'error' ],
76
- 'prefer-numeric-literals' : [ 'error' ],
77
- 'prefer-spread' : [ 'error' ],
78
- 'prefer-template' : [ 'error' ],
79
- 'quote-props' : [ 'error', 'consistent-as-needed' ],
80
- 'quotes' : [ 'error', 'single', { avoidEscape : true } ],
81
- 'semi-spacing' : [ 'error' ],
82
- 'semi' : [ 'error' ],
83
- 'space-before-blocks' : [ 'error' ],
84
- 'space-before-function-paren' : [ 'error', { anonymous : 'never', named : 'never', asyncArrow : 'always' } ],
85
- 'space-in-parens' : [ 'error' ],
86
- 'space-infix-ops' : [ 'error' ],
87
- 'space-unary-ops' : [ 'error' ],
88
- 'spaced-comment' : [ 'error' ],
89
- 'template-curly-spacing' : [ 'error' ],
90
- 'yield-star-spacing' : [ 'error' ],
91
- 'yoda' : [ 'error' ],
92
- },
93
6
  };
package/CHANGELOG.md CHANGED
@@ -5,11 +5,20 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
- ## [1.0.1](../../tags/v1.0.1) - 2023-05-04
8
+ ## [2.0.3](../../tags/v2.0.3) - 2023-05-07
9
+ ### Changed
10
+ - Updated README formatting
11
+ - Cleanup cSpell words
12
+
13
+ ## [2.0.2](../../tags/v2.0.2) - 2023-05-06
14
+ ### Changed
15
+ - Use shared eslint config
16
+
17
+ ## [2.0.1](../../tags/v2.0.1) - 2023-05-04
9
18
  ### Changed
10
19
  - Use `event-emitter` to mock subscriptions on request/response
11
20
 
12
- ## [1.0.0](../../tags/v1.0.0) - 2023-05-03
21
+ ## [2.0.0](../../tags/v2.0.0) - 2023-05-03
13
22
  ### Changed
14
23
  - Ready to release
15
24
 
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @anmiles/lib/downloader
1
+ # @anmiles/downloader
2
2
 
3
3
  Wrapper for downloading data as string, buffer or complex types
4
4
 
@@ -6,14 +6,9 @@ Wrapper for downloading data as string, buffer or complex types
6
6
 
7
7
  ## Installation
8
8
 
9
- 1. Install dependencies
10
- `npm install`
11
- 1. Build
12
- `npm run build`
13
- 1. Test everything
14
- `npm test`
9
+ `npm install @anmiles/downloader`
15
10
 
16
- ## Usage examples
11
+ ## Usage
17
12
 
18
13
  ```js
19
14
  import { download } from '@anmiles/downloader';
package/dist/lib/downloader.d.ts CHANGED
@@ -6,7 +6,8 @@ declare const _default: {
6
6
  downloadJSON: typeof downloadJSON;
7
7
  };
8
8
  export default _default;
9
+ type BufferEncoding = Parameters<Buffer['toString']>[0];
9
10
  declare function download(url: string): Promise<Buffer>;
10
11
  declare function download(url: string, file: string): Promise<void>;
11
- declare function downloadString(url: string, encoding?: Parameters<Buffer['toString']>[0]): Promise<string>;
12
- declare function downloadJSON(url: string, encoding?: Parameters<Buffer['toString']>[0]): Promise<any>;
12
+ declare function downloadString(url: string, encoding?: BufferEncoding): Promise<string>;
13
+ declare function downloadJSON(url: string, encoding?: BufferEncoding): Promise<any>;
package/dist/lib/downloader.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"downloader.js","sourceRoot":"","sources":["../../src/lib/downloader.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,4DAA+B;AAE/B,8DAAsC;AAGtC,kBAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;AAI1D,SAAS,QAAQ,CAAC,GAAW,EAAE,IAAa;IAC3C,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,IAAI,QAAqC,CAAC;QAE1C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,QAAQ,GAAG,eAAK,CAAC;SACjB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACrC,QAAQ,GAAG,cAAI,CAAC;SAChB;aAAM;YACN,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;SAC1E;QAED,MAAM,OAAO,GAAG;YACf,OAAO,EAAG;gBACT,YAAY,EAAG,iHAAiH;aAChI;SACD,CAAC;QAEF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,UAAS,GAAG;YACtC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,MAAM,CAAC,cAAc,GAAG,+BAA+B,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;gBACzE,GAAG,CAAC,MAAM,EAAE,CAAC;aACb;YAED,MAAM,MAAM,GAAiB,EAAE,CAAC;YAEhC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAS,KAAK;oBAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;gBAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACH;iBAAM;gBACN,GAAG,CAAC,IAAI,CAAC,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;gBAErC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,EAAE,CAAC;gBACX,CAAC,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACpB,MAAM,CAAC,cAAc,GAAG,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AAlDQ,4BAAQ;AAoDjB,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,WAA8C,MAAM;IAC9F,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACjC,MAAM,oBAAoB,QAAQ,EAAE,CAAC;KACrC;IAED,MAAM,MAAM,GAAG,MAAM,oBAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,oBAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AA3DkB,wCAAc;AA6DjC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,WAA8C,MAAM;IAC5F,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAhEkC,oCAAY"}
1
+ {"version":3,"file":"downloader.js","sourceRoot":"","sources":["../../src/lib/downloader.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,4DAA+B;AAE/B,8DAAsC;AAGtC,kBAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;AAM1D,SAAS,QAAQ,CAAC,GAAW,EAAE,IAAa;IAC3C,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,IAAI,QAAqC,CAAC;QAE1C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,QAAQ,GAAG,eAAK,CAAC;SACjB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACrC,QAAQ,GAAG,cAAI,CAAC;SAChB;aAAM;YACN,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;SAC1E;QAED,MAAM,OAAO,GAAG;YACf,OAAO,EAAG;gBACT,YAAY,EAAG,iHAAiH;aAChI;SACD,CAAC;QAEF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,UAAS,GAAG;YACtC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,MAAM,CAAC,cAAc,GAAG,+BAA+B,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;gBACzE,GAAG,CAAC,MAAM,EAAE,CAAC;aACb;YAED,MAAM,MAAM,GAAiB,EAAE,CAAC;YAEhC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAS,KAAK;oBAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;gBAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACH;iBAAM;gBACN,GAAG,CAAC,IAAI,CAAC,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;gBAErC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,EAAE,CAAC;gBACX,CAAC,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACpB,MAAM,CAAC,cAAc,GAAG,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AApDQ,4BAAQ;AAsDjB,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,WAA2B,MAAM;IAC3E,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACjC,MAAM,oBAAoB,QAAQ,EAAE,CAAC;KACrC;IAED,MAAM,MAAM,GAAG,MAAM,oBAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,oBAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AA7DkB,wCAAc;AA+DjC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,WAA2B,MAAM;IACzE,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAlEkC,oCAAY"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anmiles/downloader",
3
- "version": "2.0.1",
3
+ "version": "2.0.3",
4
4
  "description": "Wrapper for downloading data as string, buffer or complex types",
5
5
  "keywords": [
6
6
  "download",
@@ -30,11 +30,12 @@
30
30
  "iconv-lite": "^0.6.3"
31
31
  },
32
32
  "devDependencies": {
33
+ "@anmiles/eslint-config": "^1.0.6",
33
34
  "@types/event-emitter": "^0.3.3",
34
35
  "@types/jest": "^29.5.1",
35
36
  "@typescript-eslint/eslint-plugin": "^5.59.2",
36
37
  "@typescript-eslint/parser": "^5.59.2",
37
- "eslint": "^8.39.0",
38
+ "eslint": "^8.40.0",
38
39
  "eslint-plugin-align-assignments": "^1.1.2",
39
40
  "eslint-plugin-import": "^2.27.5",
40
41
  "eslint-plugin-jest": "^27.2.1",
package/src/lib/downloader.ts CHANGED
@@ -8,6 +8,8 @@ import downloader from './downloader';
8
8
  export { download, downloadString, downloadJSON };
9
9
  export default { download, downloadString, downloadJSON };
10
10
 
11
+ type BufferEncoding = Parameters<Buffer['toString']>[0];
12
+
11
13
  function download(url: string): Promise<Buffer>;
12
14
  function download(url: string, file: string): Promise<void>;
13
15
  function download(url: string, file?: string): Promise<Buffer | void> {
@@ -57,7 +59,7 @@ function download(url: string, file?: string): Promise<Buffer | void> {
57
59
  });
58
60
  }
59
61
 
60
- async function downloadString(url: string, encoding: Parameters<Buffer['toString']>[0] = 'utf8') {
62
+ async function downloadString(url: string, encoding: BufferEncoding = 'utf8') {
61
63
  if (!Buffer.isEncoding(encoding)) {
62
64
  throw `Unknown encoding ${encoding}`;
63
65
  }
@@ -66,7 +68,7 @@ async function downloadString(url: string, encoding: Parameters<Buffer['toString
66
68
  return iconv.decode(buffer, encoding);
67
69
  }
68
70
 
69
- async function downloadJSON(url: string, encoding: Parameters<Buffer['toString']>[0] = 'utf8') {
71
+ async function downloadJSON(url: string, encoding: BufferEncoding = 'utf8') {
70
72
  const json = await downloader.downloadString(url, encoding);
71
73
  return JSON.parse(json);
72
74
  }
package/file DELETED
File without changes