removeUrlParams (#31)

* feat: limitStringToTarget’

* docs: 文档

* fix: tslint

* feat: removeUrlParams

* fix: index导入

Author: urnotzane

README.md

@@ -51,6 +51,13 @@ npm i @mlz/doraemon@latest
 ## TODO
 [TODOS](https://github.com/juicecube/doraemon/projects/3);
 
+## 开发
+### 常用命令
+```bash
+# 单个文件测试
+jest test/limitStringToTarget.test.ts
+```
+
 ## 须知
 
 - 如有问题或提需求请提[issue](https://github.com/juicecube/doraemon/issues)。

docs/functions/getUrlQuery.md

@@ -14,6 +14,8 @@ group:
 import React from 'react';
 import { getUrlQuery } from '@mlz/doraemon';
 
+// 默认取location.href
+getUrlQuery();
 export default (props) => {
   const query = getUrlQuery('https://juicecube.github.io/doraemon?name=doraemon');
   return (

docs/functions/removeUrlParams.md

@@ -0,0 +1,16 @@
+---
+group:
+  title: 方法
+  toc: menu
+---
+
+# removeUrlParams
+删除指定url上的指定参数。
+***
+
+```javascript
+// https://da.ithen.cn?name=zane
+removeUrlParams('https://da.ithen.cn?name=zane&age=18', 'age);
+// https://da.ithen.cn?name=zane
+removeUrlParams('https://da.ithen.cn?name=zane&age=18', ['age']);
+```

src/getUrlQuery.ts

@@ -3,7 +3,7 @@ import * as _ from 'lodash';
 import { IObject } from './global';
 
 /** 获取url参数 */
-export const getUrlQuery = (url:string) => {
+export const getUrlQuery = (url:string = location.href) => {
   const result:IObject = {};
   // 不是string
   if (!_.isString(url)) {

src/index.ts

@@ -8,6 +8,7 @@ import deleteInvalidValue from './deleteInvalidValue';
 import digitalToCash from './digitalToCash';
 import copyTextToClipboard from './copyTextToClipboard';
 import limitStringToTarget from './limitStringToTarget';
+import removeUrlParams from './removeUrlParams';
 
 export {
   getUrlQuery,
@@ -20,6 +21,7 @@ export {
   digitalToCash,
   copyTextToClipboard,
   limitStringToTarget,
+  removeUrlParams,
 };
 
 export const doraemaon = {
@@ -33,6 +35,7 @@ export const doraemaon = {
   digitalToCash,
   copyTextToClipboard,
   limitStringToTarget,
+  removeUrlParams,
 };
 
 export default doraemaon;

src/removeUrlParams.ts

@@ -0,0 +1,24 @@
+import addQueryToUrl from "./addQueryToUrl";
+import getUrlQuery from "./getUrlQuery";
+
+/** 移除url上的指定参数 */
+export function removeUrlParams(url:string, keys:string | string[]) {
+  if (!url || !keys) {
+    return url;
+  }
+  let _keys = keys;
+  if (typeof (keys) === 'string') {
+    _keys = [keys];
+  }
+  const urlParts = url.split('?');
+  const params = getUrlQuery(url);
+  if (urlParts.length > 1) {
+    // 删除指定参数
+    for (const key of _keys) {
+      delete params[key];
+    }
+  }
+  return addQueryToUrl(params, urlParts[0]);
+}
+
+export default removeUrlParams;

test/getUrlQuery.test.ts

@@ -1,6 +1,13 @@
 import { getUrlQuery } from '../src/getUrlQuery';
+import { domain } from '../src/constants';
+import { LocationSetter } from './utils/location-setter';
 
 describe('getUrlQuery', () => {
+  const locationSetter = new LocationSetter();
+  it('default location.href', () => {
+    locationSetter.set({ href: `${domain}?a=1` });
+    expect(getUrlQuery()).toEqual({ a: '1' });
+  });
   it('null', () => {
     expect(getUrlQuery(null)).toEqual({});
   });

test/removeUrlParams.test.ts

@@ -0,0 +1,18 @@
+import { domain } from './../src/constants';
+import removeUrlParams from '../src/removeUrlParams';
+
+describe('removeUrlParams', () => {
+  const url = `${domain}?a=123&b=456&c=789`;
+  it('validate params', () => {
+    expect(removeUrlParams(null, null)).toBeNull();
+    expect(removeUrlParams(null, 'a')).toBeNull();
+    expect(removeUrlParams(url, null)).toBe(url);
+  });
+  it('test keys & url', () => {
+    expect(removeUrlParams(domain, 'a')).toBe(domain);
+    expect(removeUrlParams(domain, ['a'])).toBe(domain);
+    expect(removeUrlParams(url, 'a')).toBe(`${domain}?b=456&c=789`);
+    expect(removeUrlParams(url, ['a', 'b'])).toBe(`${domain}?c=789`);
+    expect(removeUrlParams(url, [])).toBe(url);
+  });
+});

test/utils/location-setter.ts

@@ -0,0 +1,22 @@
+import { IObject } from "../../src/global";
+
+/** 设置location的类 */
+export class LocationSetter {
+  constructor() {
+    this._defineLocation();
+  }
+  private _defineLocation = (value:IObject = {}) => {
+    Object.defineProperty(global, 'location', {
+      value,
+      writable : true,
+    });
+  }
+  /** 设置location */
+  set = (location:any) => {
+    global.location = location;
+  }
+  /** 重置为初始值 */
+  reset = () => {
+    this.set(undefined);
+  }
+}