🐛 Deprecate core functions

TomokiMiyauci · Jun 28, 2021 · da10771 · da10771
1 parent 2620e0c
commit da10771
Show file tree

Hide file tree

Showing 18 changed files with 22 additions and 37 deletions.
diff --git a/src/endsWith.ts b/src/endsWith.ts
@@ -31,7 +31,7 @@ type EndsWith<T extends string | undefined = undefined> = T extends undefined
  *
  * @see Related to {@link startsWith}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const endsWith = <T extends string, U extends string | undefined = undefined>(
   val: T,

diff --git a/src/entries.ts b/src/entries.ts
@@ -21,7 +21,7 @@ import { entries as _entries } from './constants/index.ts'
  *
  * @see Related to {@link keys} {@link values}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const entries: {
   <T>(

diff --git a/src/keys.ts b/src/keys.ts
@@ -20,7 +20,7 @@ import { keys as _keys } from './constants/index.ts'
  *
  * @see Related to {@link values} {@link entries}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const keys = <T extends PropertyKey>(val: Record<T, unknown>): string[] =>
   _keys(val)

diff --git a/src/length.ts b/src/length.ts
@@ -12,7 +12,7 @@
  * length({length: 5, text: 'hello'}) // 5
  * ```
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const length = <T extends { length: number }>(val: T): T['length'] => val.length
 

diff --git a/src/lowerCase.ts b/src/lowerCase.ts
@@ -14,7 +14,7 @@
  *
  * @see Related to {@link upperCase}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const lowerCase = <T extends string>(val: T): Lowercase<T> =>
   val.toLowerCase() as Lowercase<T>

diff --git a/src/map.ts b/src/map.ts
@@ -20,7 +20,7 @@ import { isArray } from './isArray.ts'
  *
  * @category `Array` `Object`
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const map: {
   <T extends readonly unknown[], U>(

diff --git a/src/replace.ts b/src/replace.ts
@@ -16,7 +16,7 @@
  *
  * @see Related to {@link ReplaceAll}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 type Replace<
   T extends string,
@@ -46,7 +46,7 @@ type Replace<
  *
  * @see Related to {@link replaceAll}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/is-valid}.
  */
 const replace = <From extends string, To extends string, T extends string>(
   from: From,

diff --git a/src/replaceAll.ts b/src/replaceAll.ts
@@ -16,7 +16,7 @@
  *
  * @see Related to {@link Replace}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 type ReplaceAll<
   T extends string,
@@ -46,7 +46,7 @@ type ReplaceAll<
  *
  * @see Related to {@link replace}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/is-valid}.
  */
 const replaceAll = <From extends string, To extends string, T extends string>(
   from: From,

diff --git a/src/reverse.ts b/src/reverse.ts
@@ -22,7 +22,7 @@ import { isString } from './isString.ts'
  *
  * @category `Array`
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/is-valid}.
  */
 const reverse: {
   (val: string): string

diff --git a/src/slice.ts b/src/slice.ts
@@ -22,7 +22,7 @@
  *
  * @category `String` `Array`
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const slice = <T extends readonly unknown[] | string>(
   from: number,

diff --git a/src/startsWith.ts b/src/startsWith.ts
@@ -31,7 +31,7 @@ type StartsWith<T extends string | undefined = undefined> = T extends undefined
  *
  * @see Related to {@link endsWith}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const startsWith = <T extends string, U extends string | undefined = undefined>(
   val: T,

diff --git a/src/test.ts b/src/test.ts
@@ -18,7 +18,7 @@ const _test = (regExp: RegExp, val: string): boolean => regExp.test(val)
  *
  * @category `String`
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const test = curry(_test)
 

diff --git a/src/toString.ts b/src/toString.ts
diff --git a/src/trim.ts b/src/trim.ts
@@ -23,7 +23,7 @@ import { TrimRight } from './trimRight.ts'
  *
  * @see Related to {@link TrimLeft} {@link TrimRight}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/is-valid}.
  */
 type Trim<T extends string> = TrimLeft<TrimRight<T>>
 
@@ -42,7 +42,7 @@ type Trim<T extends string> = TrimLeft<TrimRight<T>>
  *
  * @see Related to {@link trimLeft} {@link trimRight}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const trim = <T extends string>(val: T): Trim<T> => val.trim() as Trim<T>
 

diff --git a/src/trimLeft.ts b/src/trimLeft.ts
@@ -21,7 +21,7 @@ import { Space } from './types/index.ts'
  *
  * @see Related to {@link TrimRight} {@link Trim}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 type TrimLeft<T extends string> = T extends `${Space}${infer R}`
   ? TrimLeft<R>
@@ -49,7 +49,7 @@ type TrimLeft<T extends string> = T extends `${Space}${infer R}`
  *
  * @see Related to {@link trimRight} {@link trim}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const trimLeft = <T extends string>(val: T): TrimLeft<T> =>
   val.trimLeft() as TrimLeft<T>

diff --git a/src/trimRight.ts b/src/trimRight.ts
@@ -22,7 +22,7 @@ import { Space } from './types/index.ts'
  *
  * @see Related to {@link TrimLeft} {@link Trim}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 type TrimRight<T extends string> = T extends `${infer R}${Space}`
   ? TrimRight<R>
@@ -50,7 +50,7 @@ type TrimRight<T extends string> = T extends `${infer R}${Space}`
  *
  * @see Related to {@link trimLeft} {@link trim}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const trimRight = <T extends string>(val: T): TrimRight<T> =>
   val.trimRight() as TrimRight<T>

diff --git a/src/upperCase.ts b/src/upperCase.ts
@@ -14,7 +14,7 @@
  *
  * @see Related to {@link lowerCase}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const upperCase = <T extends string>(val: T): Uppercase<T> =>
   val.toUpperCase() as Uppercase<T>

diff --git a/src/values.ts b/src/values.ts
@@ -29,7 +29,7 @@ import { values as _values } from './constants/index.ts'
  *
  * @see Related to {@link keys} {@link entries}
  *
- * @public
+ * @deprecated The module has moved to {@link https://github.com/TomokiMiyauci/core-fn}.
  */
 const values = <T extends unknown>(
   val: Record<PropertyKey, T> | ArrayLike<T>