Skip to content

feat(46): setup jsDoc + metadata documentation #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ZeRiix wants to merge 28 commits into
base: main
Choose a base branch
from
Open

feat(46): setup jsDoc + metadata documentation #53

ZeRiix wants to merge 28 commits into from

Conversation

@ZeRiix
Copy link
Collaborator

@ZeRiix ZeRiix commented Jan 2, 2026

close #46

@ZeRiix ZeRiix self-assigned this Jan 2, 2026
@ZeRiix ZeRiix requested a review from mathcovax as a code owner January 2, 2026 22:37
@ZeRiix ZeRiix linked an issue Jan 2, 2026 that may be closed by this pull request
Feat: jsDoc + doc metadata #46
Open
@github-actions
Copy link

github-actions bot commented Jan 2, 2026 •
edited
Loading

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 100% (🎯 100%) 2983 / 2983
🔵 Statements 100% (🎯 100%) 3208 / 3208
🔵 Functions 100% (🎯 100%) 993 / 993
🔵 Branches 100% (🎯 100%) 1596 / 1596
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
scripts/array/chunk.ts 100% 100% 100% 100%
scripts/array/coalescing.ts 100% 100% 100% 100%
scripts/array/concat.ts 100% 100% 100% 100%
scripts/array/copyWithin.ts 100% 100% 100% 100%
scripts/array/every.ts 100% 100% 100% 100%
scripts/array/filter.ts 100% 100% 100% 100%
scripts/array/find.ts 100% 100% 100% 100%
scripts/array/findAndReplace.ts 100% 100% 100% 100%
scripts/array/findIndex.ts 100% 100% 100% 100%
scripts/array/findLast.ts 100% 100% 100% 100%
scripts/array/findLastIndex.ts 100% 100% 100% 100%
scripts/array/flat.ts 100% 100% 100% 100%
scripts/array/flatMap.ts 100% 100% 100% 100%
scripts/array/from.ts 100% 100% 100% 100%
scripts/array/group.ts 100% 100% 100% 100%
scripts/array/includes.ts 100% 100% 100% 100%
scripts/array/indexOf.ts 100% 100% 100% 100%
scripts/array/insert.ts 100% 100% 100% 100%
scripts/array/is.ts 100% 100% 100% 100%
scripts/array/isLastIndex.ts 100% 100% 100% 100%
scripts/array/join.ts 100% 100% 100% 100%
scripts/array/lastIndexOf.ts 100% 100% 100% 100%
scripts/array/length.ts 100% 100% 100% 100%
scripts/array/lengthEqual.ts 100% 100% 100% 100%
scripts/array/map.ts 100% 100% 100% 100%
scripts/array/maxElements.ts 100% 100% 100% 100%
scripts/array/maxOf.ts 100% 100% 100% 100%
scripts/array/minElements.ts 100% 100% 100% 100%
scripts/array/minOf.ts 100% 100% 100% 100%
scripts/array/notIncludes.ts 100% 100% 100% 100%
scripts/array/pop.ts 100% 100% 100% 100%
scripts/array/push.ts 100% 100% 100% 100%
scripts/array/reduce.ts 100% 100% 100% 100%
scripts/array/reduceRight.ts 100% 100% 100% 100%
scripts/array/reverse.ts 100% 100% 100% 100%
scripts/array/select.ts 100% 100% 100% 100%
scripts/array/set.ts 100% 100% 100% 100%
scripts/array/shift.ts 100% 100% 100% 100%
scripts/array/slice.ts 100% 100% 100% 100%
scripts/array/some.ts 100% 100% 100% 100%
scripts/array/sort.ts 100% 100% 100% 100%
scripts/array/sum.ts 100% 100% 100% 100%
scripts/array/toTuple.ts 100% 100% 100% 100%
scripts/array/unshift.ts 100% 100% 100% 100%
scripts/array/at/default.ts 100% 100% 100% 100%
scripts/array/at/first.ts 100% 100% 100% 100%
scripts/array/at/last.ts 100% 100% 100% 100%
scripts/array/fill/all.ts 100% 100% 100% 100%
scripts/array/fill/default.ts 100% 100% 100% 100%
scripts/array/findAndSplice/delete.ts 100% 100% 100% 100%
scripts/array/findAndSplice/insert.ts 100% 100% 100% 100%
scripts/array/findAndSplice/replace.ts 100% 100% 100% 100%
scripts/array/splice/delete.ts 100% 100% 100% 100%
scripts/array/splice/insert.ts 100% 100% 100% 100%
scripts/array/splice/replace.ts 100% 100% 100% 100%
scripts/clean/entity.ts 100% 100% 100% 100%
scripts/clean/flag.ts 100% 100% 100% 100%
scripts/clean/kind.ts 100% 100% 100% 100%
scripts/clean/newType.ts 100% 100% 100% 100%
scripts/clean/repository.ts 100% 100% 100% 100%
scripts/clean/useCase.ts 100% 100% 100% 100%
scripts/clean/constraint/base.ts 100% 100% 100% 100%
scripts/clean/constraint/defaultConstraint/number.ts 100% 100% 100% 100%
scripts/clean/constraint/defaultConstraint/string.ts 100% 100% 100% 100%
scripts/clean/primitive/base.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/equal.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/sort.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateAddTime.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateGreaterThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateLessThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateMax.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateMin.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/date/dateSubtractTime.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/add.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/divide.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/greaterThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/lessThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/max.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/min.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/multiply.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/number/subtract.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/string/concat.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/string/length.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/string/lengthEqual.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/string/lengthGreaterThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/string/lengthLessThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/time/timeGreaterThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/time/timeLessThan.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/time/timeMax.ts 100% 100% 100% 100%
scripts/clean/primitive/operations/time/timeMin.ts 100% 100% 100% 100%
scripts/common/addWrappedProperties.ts 100% 100% 100% 100%
scripts/common/and.ts 100% 100% 100% 100%
scripts/common/asyncInnerPipe.ts 100% 100% 100% 100%
scripts/common/asyncLoop.ts 100% 100% 100% 100%
scripts/common/asyncPipe.ts 100% 100% 100% 100%
scripts/common/asyncRetry.ts 100% 100% 100% 100%
scripts/common/builder.ts 100% 100% 100% 100%
scripts/common/clone.ts 100% 100% 100% 100%
scripts/common/enum.ts 100% 100% 100% 100%
scripts/common/equal.ts 100% 100% 100% 100%
scripts/common/escapeRegExp.ts 100% 100% 100% 100%
scripts/common/externalPromise.ts 100% 100% 100% 100%
scripts/common/falsy.ts 100% 100% 100% 100%
scripts/common/forward.ts 100% 100% 100% 100%
scripts/common/forwardLog.ts 100% 100% 100% 100%
scripts/common/globalStore.ts 100% 100% 100% 100%
scripts/common/hasKinds.ts 100% 100% 100% 100%
scripts/common/hasSomeKinds.ts 100% 100% 100% 100%
scripts/common/innerPipe.ts 100% 100% 100% 100%
scripts/common/instanceOf.ts 100% 100% 100% 100%
scripts/common/isType.ts 100% 100% 100% 100%
scripts/common/justReturn.ts 100% 100% 100% 100%
scripts/common/kind.ts 100% 100% 100% 100%
scripts/common/loop.ts 100% 100% 100% 100%
scripts/common/memo.ts 100% 100% 100% 100%
scripts/common/or.ts 100% 100% 100% 100%
scripts/common/override.ts 100% 100% 100% 100%
scripts/common/pipe.ts 100% 100% 100% 100%
scripts/common/promiseObject.ts 100% 100% 100% 100%
scripts/common/simpleClone.ts 100% 100% 100% 100%
scripts/common/sleep.ts 100% 100% 100% 100%
scripts/common/stringToBytes.ts 100% 100% 100% 100%
scripts/common/stringToMillisecond.ts 100% 100% 100% 100%
scripts/common/toJSON.ts 100% 100% 100% 100%
scripts/common/toString.ts 100% 100% 100% 100%
scripts/common/toTransform.ts 100% 100% 100% 100%
scripts/common/toWrappedValue.ts 100% 100% 100% 100%
scripts/common/truthy.ts 100% 100% 100% 100%
scripts/common/unwrap.ts 100% 100% 100% 100%
scripts/common/when.ts 100% 100% 100% 100%
scripts/common/whenElse.ts 100% 100% 100% 100%
scripts/common/whenNot.ts 100% 100% 100% 100%
scripts/common/wrapValue.ts 100% 100% 100% 100%
scripts/date/applyTimezone.ts 100% 100% 100% 100%
scripts/date/closestTo.ts 100% 100% 100% 100%
scripts/date/create.ts 100% 100% 100% 100%
scripts/date/createOrThrow.ts 100% 100% 100% 100%
scripts/date/createTheDate.ts 100% 100% 100% 100%
scripts/date/createTheTime.ts 100% 100% 100% 100%
scripts/date/createTime.ts 100% 100% 100% 100%
scripts/date/createTimeOrThrow.ts 100% 100% 100% 100%
scripts/date/each.ts 100% 100% 100% 100%
scripts/date/format.ts 100% 100% 100% 100%
scripts/date/formatTime.ts 100% 100% 100% 100%
scripts/date/getTimezoneOffset.ts 100% 100% 100% 100%
scripts/date/is.ts 100% 100% 100% 100%
scripts/date/isSafeTimeValue.ts 100% 100% 100% 100%
scripts/date/isSafeTimestamp.ts 100% 100% 100% 100%
scripts/date/isTime.ts 100% 100% 100% 100%
scripts/date/makeSafeTimeValue.ts 100% 100% 100% 100%
scripts/date/makeSafeTimestamp.ts 100% 100% 100% 100%
scripts/date/max.ts 100% 100% 100% 100%
scripts/date/maxTime.ts 100% 100% 100% 100%
scripts/date/min.ts 100% 100% 100% 100%
scripts/date/minTime.ts 100% 100% 100% 100%
scripts/date/now.ts 100% 100% 100% 100%
scripts/date/round.ts 100% 100% 100% 100%
scripts/date/sort.ts 100% 100% 100% 100%
scripts/date/sortTimes.ts 100% 100% 100% 100%
scripts/date/toISOString.ts 100% 100% 100% 100%
scripts/date/toNative.ts 100% 100% 100% 100%
scripts/date/toTimeValue.ts 100% 100% 100% 100%
scripts/date/toTimestamp.ts 100% 100% 100% 100%
scripts/date/today.ts 100% 100% 100% 100%
scripts/date/tomorrow.ts 100% 100% 100% 100%
scripts/date/yesterday.ts 100% 100% 100% 100%
scripts/date/getters/getDayOfMonth.ts 100% 100% 100% 100%
scripts/date/getters/getDayOfWeek.ts 100% 100% 100% 100%
scripts/date/getters/getDayOfYear.ts 100% 100% 100% 100%
scripts/date/getters/getFirstDayOfMonth.ts 100% 100% 100% 100%
scripts/date/getters/getFirstDayOfWeek.ts 100% 100% 100% 100%
scripts/date/getters/getHour.ts 100% 100% 100% 100%
scripts/date/getters/getLastDayOfMonth.ts 100% 100% 100% 100%
scripts/date/getters/getLastDayOfWeek.ts 100% 100% 100% 100%
scripts/date/getters/getMilliseconds.ts 100% 100% 100% 100%
scripts/date/getters/getMinute.ts 100% 100% 100% 100%
scripts/date/getters/getMonth.ts 100% 100% 100% 100%
scripts/date/getters/getSecond.ts 100% 100% 100% 100%
scripts/date/getters/getWeekOfYear.ts 100% 100% 100% 100%
scripts/date/getters/getYear.ts 100% 100% 100% 100%
scripts/date/operators/addDays.ts 100% 100% 100% 100%
scripts/date/operators/addHours.ts 100% 100% 100% 100%
scripts/date/operators/addMilliseconds.ts 100% 100% 100% 100%
scripts/date/operators/addMinutes.ts 100% 100% 100% 100%
scripts/date/operators/addMonths.ts 100% 100% 100% 100%
scripts/date/operators/addSeconds.ts 100% 100% 100% 100%
scripts/date/operators/addTime.ts 100% 100% 100% 100%
scripts/date/operators/addWeeks.ts 100% 100% 100% 100%
scripts/date/operators/addYears.ts 100% 100% 100% 100%
scripts/date/operators/between.ts 100% 100% 100% 100%
scripts/date/operators/betweenThan.ts 100% 100% 100% 100%
scripts/date/operators/betweenThanTime.ts 100% 100% 100% 100%
scripts/date/operators/betweenTime.ts 100% 100% 100% 100%
scripts/date/operators/greater.ts 100% 100% 100% 100%
scripts/date/operators/greaterThan.ts 100% 100% 100% 100%
scripts/date/operators/greaterThanTime.ts 100% 100% 100% 100%
scripts/date/operators/greaterTime.ts 100% 100% 100% 100%
scripts/date/operators/less.ts 100% 100% 100% 100%
scripts/date/operators/lessThan.ts 100% 100% 100% 100%
scripts/date/operators/lessThanTime.ts 100% 100% 100% 100%
scripts/date/operators/lessTime.ts 100% 100% 100% 100%
scripts/date/operators/subtractDays.ts 100% 100% 100% 100%
scripts/date/operators/subtractHours.ts 100% 100% 100% 100%
scripts/date/operators/subtractMilliseconds.ts 100% 100% 100% 100%
scripts/date/operators/subtractMinutes.ts 100% 100% 100% 100%
scripts/date/operators/subtractMonths.ts 100% 100% 100% 100%
scripts/date/operators/subtractSeconds.ts 100% 100% 100% 100%
scripts/date/operators/subtractTime.ts 100% 100% 100% 100%
scripts/date/operators/subtractWeeks.ts 100% 100% 100% 100%
scripts/date/operators/subtractYears.ts 100% 100% 100% 100%
scripts/either/hasInformation.ts 100% 100% 100% 100%
scripts/either/safeCallback.ts 100% 100% 100% 100%
scripts/either/whenHasInformation.ts 100% 100% 100% 100%
scripts/either/bool/create.ts 100% 100% 100% 100%
scripts/either/bool/falsy.ts 100% 100% 100% 100%
scripts/either/bool/truthy.ts 100% 100% 100% 100%
scripts/either/future/create.ts 100% 100% 100% 100%
scripts/either/future/error.ts 100% 100% 100% 100%
scripts/either/future/success.ts 100% 100% 100% 100%
scripts/either/left/create.ts 100% 100% 100% 100%
scripts/either/left/error.ts 100% 100% 100% 100%
scripts/either/left/fail.ts 100% 100% 100% 100%
scripts/either/left/is.ts 100% 100% 100% 100%
scripts/either/left/when.ts 100% 100% 100% 100%
scripts/either/nullable/create.ts 100% 100% 100% 100%
scripts/either/nullable/empty.ts 100% 100% 100% 100%
scripts/either/nullable/filled.ts 100% 100% 100% 100%
scripts/either/nullish/create.ts 100% 100% 100% 100%
scripts/either/nullish/empty.ts 100% 100% 100% 100%
scripts/either/nullish/filled.ts 100% 100% 100% 100%
scripts/either/optional/create.ts 100% 100% 100% 100%
scripts/either/optional/empty.ts 100% 100% 100% 100%
scripts/either/optional/filled.ts 100% 100% 100% 100%
scripts/either/right/asyncGroup.ts 100% 100% 100% 100%
scripts/either/right/asyncPipe.ts 100% 100% 100% 100%
scripts/either/right/create.ts 100% 100% 100% 100%
scripts/either/right/group.ts 100% 100% 100% 100%
scripts/either/right/is.ts 100% 100% 100% 100%
scripts/either/right/ok.ts 100% 100% 100% 100%
scripts/either/right/pipe.ts 100% 100% 100% 100%
scripts/either/right/success.ts 100% 100% 100% 100%
scripts/either/right/when.ts 100% 100% 100% 100%
scripts/generator/asyncChunk.ts 100% 100% 100% 100%
scripts/generator/asyncFilter.ts 100% 100% 100% 100%
scripts/generator/asyncLoop.ts 100% 100% 100% 100%
scripts/generator/asyncMap.ts 100% 100% 100% 100%
scripts/generator/asyncReduce.ts 100% 100% 100% 100%
scripts/generator/chunk.ts 100% 100% 100% 100%
scripts/generator/execute.ts 100% 100% 100% 100%
scripts/generator/filter.ts 100% 100% 100% 100%
scripts/generator/loop.ts 100% 100% 100% 100%
scripts/generator/map.ts 100% 100% 100% 100%
scripts/generator/reduce.ts 100% 100% 100% 100%
scripts/number/abs.ts 100% 100% 100% 100%
scripts/number/acos.ts 100% 100% 100% 100%
scripts/number/add.ts 100% 100% 100% 100%
scripts/number/asin.ts 100% 100% 100% 100%
scripts/number/atan.ts 100% 100% 100% 100%
scripts/number/atan2.ts 100% 100% 100% 100%
scripts/number/between.ts 100% 100% 100% 100%
scripts/number/betweenThan.ts 100% 100% 100% 100%
scripts/number/ceil.ts 100% 100% 100% 100%
scripts/number/clamp.ts 100% 100% 100% 100%
scripts/number/cos.ts 100% 100% 100% 100%
scripts/number/divide.ts 100% 100% 100% 100%
scripts/number/floor.ts 100% 100% 100% 100%
scripts/number/greater.ts 100% 100% 100% 100%
scripts/number/greaterThan.ts 100% 100% 100% 100%
scripts/number/less.ts 100% 100% 100% 100%
scripts/number/lessThan.ts 100% 100% 100% 100%
scripts/number/max.ts 100% 100% 100% 100%
scripts/number/min.ts 100% 100% 100% 100%
scripts/number/modulo.ts 100% 100% 100% 100%
scripts/number/multiply.ts 100% 100% 100% 100%
scripts/number/negate.ts 100% 100% 100% 100%
scripts/number/power.ts 100% 100% 100% 100%
scripts/number/round.ts 100% 100% 100% 100%
scripts/number/sin.ts 100% 100% 100% 100%
scripts/number/sort.ts 100% 100% 100% 100%
scripts/number/sqrt.ts 100% 100% 100% 100%
scripts/number/subtract.ts 100% 100% 100% 100%
scripts/number/tan.ts 100% 100% 100% 100%
scripts/number/toFixed.ts 100% 100% 100% 100%
scripts/number/trunc.ts 100% 100% 100% 100%
scripts/object/assign.ts 100% 100% 100% 100%
scripts/object/deepDiscriminate.ts 100% 100% 100% 100%
scripts/object/discriminate.ts 100% 100% 100% 100%
scripts/object/entries.ts 100% 100% 100% 100%
scripts/object/entry.ts 100% 100% 100% 100%
scripts/object/fromEntries.ts 100% 100% 100% 100%
scripts/object/getDeepProperty.ts 100% 100% 100% 100%
scripts/object/getProperty.ts 100% 100% 100% 100%
scripts/object/hasKeys.ts 100% 100% 100% 100%
scripts/object/keys.ts 100% 100% 100% 100%
scripts/object/omit.ts 100% 100% 100% 100%
scripts/object/override.ts 100% 100% 100% 100%
scripts/object/pick.ts 100% 100% 100% 100%
scripts/object/to.ts 100% 100% 100% 100%
scripts/object/transformProperties.ts 100% 100% 100% 100%
scripts/object/transformProperty.ts 100% 100% 100% 100%
scripts/object/values.ts 100% 100% 100% 100%
scripts/pattern/exhaustive.ts 100% 100% 100% 100%
scripts/pattern/isMatch.ts 100% 100% 100% 100%
scripts/pattern/otherwise.ts 100% 100% 100% 100%
scripts/pattern/union.ts 100% 100% 100% 100%
scripts/pattern/when.ts 100% 100% 100% 100%
scripts/pattern/match/index.ts 100% 100% 100% 100%
scripts/string/capitalize.ts 100% 100% 100% 100%
scripts/string/charAt.ts 100% 100% 100% 100%
scripts/string/concat.ts 100% 100% 100% 100%
scripts/string/endsWith.ts 100% 100% 100% 100%
scripts/string/includes.ts 100% 100% 100% 100%
scripts/string/indexOf.ts 100% 100% 100% 100%
scripts/string/isIn.ts 100% 100% 100% 100%
scripts/string/isKeyof.ts 100% 100% 100% 100%
scripts/string/lastIndexOf.ts 100% 100% 100% 100%
scripts/string/length.ts 100% 100% 100% 100%
scripts/string/match.ts 100% 100% 100% 100%
scripts/string/matchAll.ts 100% 100% 100% 100%
scripts/string/normalize.ts 100% 100% 100% 100%
scripts/string/padEnd.ts 100% 100% 100% 100%
scripts/string/padStart.ts 100% 100% 100% 100%
scripts/string/repeat.ts 100% 100% 100% 100%
scripts/string/replace.ts 100% 100% 100% 100%
scripts/string/replaceAll.ts 100% 100% 100% 100%
scripts/string/search.ts 100% 100% 100% 100%
scripts/string/slice.ts 100% 100% 100% 100%
scripts/string/sort.ts 100% 100% 100% 100%
scripts/string/sortCompare.ts 100% 100% 100% 100%
scripts/string/split.ts 100% 100% 100% 100%
scripts/string/startsWith.ts 100% 100% 100% 100%
scripts/string/substring.ts 100% 100% 100% 100%
scripts/string/test.ts 100% 100% 100% 100%
scripts/string/toLowerCase.ts 100% 100% 100% 100%
scripts/string/toUpperCase.ts 100% 100% 100% 100%
scripts/string/uncapitalize.ts 100% 100% 100% 100%
scripts/string/at/default.ts 100% 100% 100% 100%
scripts/string/trim/default.ts 100% 100% 100% 100%
scripts/string/trim/end.ts 100% 100% 100% 100%
scripts/string/trim/start.ts 100% 100% 100% 100%
Generated in workflow #308 for commit 23678dc by the Vitest Coverage Report Action

@ZeRiix ZeRiix force-pushed the feat/46 branch 6 times, most recently from c5d7277 to 2a2442c Compare January 6, 2026 18:46
@github-actions github-actions bot removed the md label Jan 6, 2026
@ZeRiix ZeRiix changed the title feat(46): setup jsDoc feat(46): setup jsDoc + metadata documentation Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mathcovax mathcovax Awaiting requested review from mathcovax mathcovax is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@ZeRiix ZeRiix

Labels

wip

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feat: jsDoc + doc metadata

2 participants

@ZeRiix