Merge pull request #3 from joaopaulomoraes/refactor/improve-features

Improve features

Author: joaopaulomoraes

jest.config.ts

@@ -5,5 +5,5 @@ export default {
   testEnvironment: 'node',
   modulePaths: ['<rootDir>/src/'],
   collectCoverageFrom: ['src/**/*.ts'],
-  testPathIgnorePatterns: ['/dist/', '/node_modules/']
+  testPathIgnorePatterns: ['/build/', '/node_modules/']
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-object-keys",
-  "version": "0.1.2-dev",
+  "version": "0.1.2",
   "description": "Manage complex object keys in depth",
   "author": {
     "name": "João Paulo Moraes",

src/remove/index.ts

@@ -1,9 +1,5 @@
-type Key = string
-
-type Keys = Array<Key>
-
 type JSObject = {
-  [key: string | symbol]: unknown
+  [key: string | number | symbol]: unknown
 }
 
 /**
@@ -12,20 +8,20 @@ type JSObject = {
  * @param keys - A single key or an array of keys
  * @returns A new object without the given keys
  */
-export function remove<T extends JSObject>(object: T, keys: Key | Keys): T {
-  if (typeof keys === 'string') {
-    return withoutKey(object, keys)
-  }
+export function remove<O extends JSObject, K extends keyof O>(object: O, keys: K | K[]): Omit<O, K> {
+  if (typeof keys === 'string') return withoutKey(object, keys)
+
+  if (typeof keys === 'object') return withoutKeys(object, keys)
 
-  return withoutKeys(object, keys)
+  return object
 }
 
-function withoutKey(object: JSObject, key: Key) {
+function withoutKey<O extends JSObject, K extends string>(object: O, key: K) {
   const regex = new RegExp(`"${key}":[^,}]+,?`, 'g')
   return withRegex(object, regex)
 }
 
-function withoutKeys(object: JSObject, keys: Keys) {
+function withoutKeys<O extends JSObject, K extends keyof O>(object: O, keys: K[]) {
   const regex = new RegExp(`"(${keys.join('|')})":[^,}]+,?`, 'g')
   return withRegex(object, regex)
 }

tsconfig.json

@@ -15,5 +15,5 @@
     "isolatedModules": true
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "build"]
+  "exclude": ["node_modules", "build", "test.ts"]
 }