fix(Cache): typescript `Map` generic type fixed #308

dimaslanjaka · 2023-05-14T03:00:44Z

feat: add CacheMapper

implement built-in javascript Map with full function usages.

Create new class CacheMapper implementing Map<KEY, VALUE> which is genericable
Expose all the functionality of the Map class
Add private inner Map<string, V> to prevent variable class imported using private name, which V is Generic type
class Cache<V> implementing CacheMapper<string, V>

fix: generic type `Cache` class

hotfixed Exported variable 'cache' has or is using private name 'cache'

because type any is not allowed by ESLint so I created a mapper class with full typeStrong which can be generalized

fixed generic type screenshot

chore(deps-dev): add `@types/chai` and `@types/mocha`

to support mocha, chai for used in typescript, we need @types/chai and @types/mocha

feat: add strict type test for `Cache`

define cache class with various type (still on-going creating an tests)

make `value` and `returns` as generic type

- disable @typescript-eslint/no-explicit-any to be able treat `value` as any - fixed failed build caused by `Not all constituents of type 'T | function' are callable`

cache now full support like built-in `Map` forked from: https://stackoverflow.com/a/68805082/6404439

detach `dump` from CacheMapper

chore(deps-dev): add `@types/chai` `@types/mocha` refactor(eslintrc): disable unsupported es-syntax for typescript

feat: import `chai.expect` fixed for objects not being sorted by NodeJS built-in `Map`

should be same `3`

fix: CacheMapper using private name

coveralls · 2023-05-14T03:01:32Z

Coverage: 95.047% (-0.4%) from 95.402% when pulling ddb89ec on dimaslanjaka:fix-cache into 3b0bc15 on hexojs:master.

dimaslanjaka · 2023-05-14T03:13:51Z

@SukkaW can i add typescript test for generic type of Cache ?

i want add more tests within various type which Cache fully supported generic type.

generic cache used for improving hexo locals which successful cast the get return generic

and I need solve my test issue #309, how to fix this?

to generify `Cache` sctructure

hotifx Exported variable <variable name> has or is using private name <private name>

lib/CacheMapper.ts

SukkaW · 2023-05-14T13:07:34Z

test/cache.spec.js

  const Cache = require('../dist/cache');
  const cache = new Cache();

  it('get & set', () => {
    cache.set('foo', 123);
-    cache.get('foo').should.eql(123);
+    should.equal(cache.get('foo'), 123);


@types/chat plus import {should} 'chat'; should(); should be enough to correct the type of [any object].prorotype.should, just like this: https://github.com/SukkaW/rollup-plugin-swc/blob/master/test/index.ts

@types/chat plus import {should} 'chat'; should(); should be enough to correct the type of [any object].prorotype.should, just like this: https://github.com/SukkaW/rollup-plugin-swc/blob/master/test/index.ts

at my device using prototype.should getting error (throw undefined and make all tests failed), instead giving result test failure

i dont know, why. But using normal chai API can give result failure correctly instead throw all tests runner, that was made me confused, because throw from node_modules paths instead from the tests files

emm, i think this error caused by running on monorepo/workspace project. cuz all dependents grouped at single node_modules. but, this method easily to sync between packages. maybe, caused by version conflict (auto fixed by yarn), i dont know. Remembering all hexo packages has different dev dependencies versions.

error says:

cannot read property 'should' of undefined

sometimes got error like:

cannot read property 'eql' ... so on

so to prevent useless error, prefer using original chai expect, should API for safety :)

from package `hexo-util`

refactor: split cache typescript test

…into fix-cache

chore(CacheMapper): drop `size` manipulator chore(Cache): get `CacheMapper` size by keys count

prevent exposed to index exports (VSCode, Intellij IDEA)

create new variable `newValue` to manipulate value parameter

fixed by count the `Map.keys` length

…into fix-cache

feat: add overload `get` method

dimaslanjaka added 19 commits May 13, 2023 23:57

chore(Cache.apply): implement generic type

3d4784f

make `value` and `returns` as generic type

fix: generic type

41137fd

- disable @typescript-eslint/no-explicit-any to be able treat `value` as any - fixed failed build caused by `Not all constituents of type 'T | function' are callable`

chore: implement cache mapper

95492ad

cache now full support like built-in `Map` forked from: https://stackoverflow.com/a/68805082/6404439

fix(TypeError): Cannot read property 'should' of undefined

dfe4ddd

chore: restore old export style

8e32e9c

refactor: change cache import

7e54cf4

chore: set cache size on set and del triggerred

0130bdb

chore: make cache mapper prop to private

3abcc5d

chore: restore back cache property

af55eba

refactor: update imports

e663b44

feat: set size while flusing cache

8cb3c0f

chore: moved dump into Cache

ae3780f

detach `dump` from CacheMapper

feat: implement typescript tests

06d32c6

chore(deps-dev): add `@types/chai` `@types/mocha` refactor(eslintrc): disable unsupported es-syntax for typescript

refactor: update dump test

c9b8997

feat: import `chai.expect` fixed for objects not being sorted by NodeJS built-in `Map`

feat(Cache): add typescript test

da25618

refactor: rename test file

fb6b487

refactor: rename step

7943cfd

feat: validate size after add same value with function

e239a39

should be same `3`

chore: split CacheMapper

55ab91f

fix: CacheMapper using private name

dimaslanjaka marked this pull request as draft May 14, 2023 03:00

dimaslanjaka added 8 commits May 14, 2023 14:56

feat: add CacheType

d233f1b

to generify `Cache` sctructure

chore: separate Cache then import to cache.ts

992a9fc

fix: Cache private name exports

287f2cb

hotifx Exported variable <variable name> has or is using private name <private name>

refactor: cancel d233f1b

61dbdd1

docs(apply): add JSDoc to each overload types

1ed3491

docs: update JSDoc

1ece3d5

docs: update JSDoc

cb3b0b3

chore: update JSDoc, fix invalid usage sample

0f416fe

SukkaW reviewed May 14, 2023

View reviewed changes

lib/CacheMapper.ts Outdated Show resolved Hide resolved

SukkaW reviewed May 14, 2023

View reviewed changes

dimaslanjaka added a commit to dimaslanjaka/hexo that referenced this pull request May 15, 2023

chore: fixed generic type class Cache (hexojs/hexo-util#308)

959c7d5

from package `hexo-util`

dimaslanjaka added 23 commits May 15, 2023 17:35

refactor: rename test cache number

5617efd

refactor: split cache typescript test

feat validate cache exist

b29c506

feat: add object test

5706883

docs: update JSDoc usage

1553dcf

docs: update JSDoc usage

7147f60

Merge branch 'fix-cache' of https://github.com/dimaslanjaka/hexo-util …

d5b37ef

…into fix-cache

refactor: add test-single script

c2a8dbe

refactor: register test object & rename file test number

40b8a19

chore(CacheMapper): make size readonly modifier

1622437

chore(CacheMapper): drop `size` manipulator chore(Cache): get `CacheMapper` size by keys count

chore: treat CacheMapper as internal

1fd5511

prevent exposed to index exports (VSCode, Intellij IDEA)

chore(CacheMapper): _innerMap using readonly modifier

bb697bf

chore: detach flush from CacheMapper

41210cf

chore: detach apply from CacheMapper

2ba8147

fix: Type 'V' is not assignable to 'V & (() => V)'

055391d

create new variable `newValue` to manipulate value parameter

fix: invalid map size

2cb48ad

fixed by count the `Map.keys` length

docs: update apply JSDoc

d984e19

refactor: update Cache object test

db24238

refactor: disable typescript non-null assertion

ddc98e3

feat: add built-in Map object test

6134ed2

feat: add built-in Set object test

9c40705

docs: update JSDoc

722f7d2

docs: update JSDoc

b9a3449

Merge branch 'fix-cache' of https://github.com/dimaslanjaka/hexo-util …

ddb89ec

…into fix-cache

dimaslanjaka marked this pull request as ready for review May 15, 2023 17:45

dimaslanjaka requested a review from SukkaW May 15, 2023 17:48

dimaslanjaka mentioned this pull request May 15, 2023

chore: some improvement as description #311

Closed

dimaslanjaka added a commit to dimaslanjaka/hexo that referenced this pull request May 17, 2023

fix: generic type class Cache (hexojs/hexo-util#308)

817c8ea

feat: add overload `get` method

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(Cache): typescript `Map` generic type fixed #308

fix(Cache): typescript `Map` generic type fixed #308

dimaslanjaka commented May 14, 2023 •

edited

coveralls commented May 14, 2023 •

edited

dimaslanjaka commented May 14, 2023 •

edited

SukkaW May 14, 2023 •

edited

dimaslanjaka May 15, 2023

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023

dimaslanjaka May 15, 2023 •

edited

fix(Cache): typescript Map generic type fixed #308

Are you sure you want to change the base?

fix(Cache): typescript Map generic type fixed #308

Conversation

dimaslanjaka commented May 14, 2023 • edited

feat: add CacheMapper

fix: generic type Cache class

chore(deps-dev): add @types/chai and @types/mocha

feat: add strict type test for Cache

coveralls commented May 14, 2023 • edited

dimaslanjaka commented May 14, 2023 • edited

SukkaW May 14, 2023 • edited

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023 • edited

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023 • edited

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023 • edited

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023

Choose a reason for hiding this comment

dimaslanjaka May 15, 2023 • edited

Choose a reason for hiding this comment

fix(Cache): typescript `Map` generic type fixed #308

fix(Cache): typescript `Map` generic type fixed #308

dimaslanjaka commented May 14, 2023 •

edited

fix: generic type `Cache` class

chore(deps-dev): add `@types/chai` and `@types/mocha`

feat: add strict type test for `Cache`

coveralls commented May 14, 2023 •

edited

dimaslanjaka commented May 14, 2023 •

edited

SukkaW May 14, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited

dimaslanjaka May 15, 2023 •

edited