docs: improve demo

moonlitusun · Apr 16, 2024 · 8c7fd85 · 8c7fd85
1 parent 5c18c90
commit 8c7fd85
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 17 deletions.
diff --git a/__tests__/pagination.test.js b/__tests__/pagination.test.js
@@ -3,6 +3,10 @@ const pagination = require('../dist/cjs/pagination').default;
 test('is pagination', () => {
   const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 
+  expect(pagination([])).toEqual([]);
+  expect(pagination(arr)).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+  expect(pagination(arr, 1)).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+  expect(pagination(arr, 1, 5)).toEqual([1, 2, 3, 4, 5]);
   expect(pagination(arr, 2, 8)).toEqual([9, 10]);
   expect(pagination(arr, 3, 3)).toEqual([7, 8, 9]);
 })
diff --git a/docs/methods/csvArray.md b/docs/methods/csvArray.md
@@ -27,9 +27,7 @@ order: 1
 ### Examples
 
 ```js
-const {
-  csvArrayToObjects,
-} = require('../dist/cjs/csv-array');
+import { csvArrayToObjects } from '@dz-web/o-orange';
 
 describe('函数csvArrayToObjects', () => {
   test('输入空数组应该返回空数组', () => {
@@ -91,9 +89,7 @@ describe('函数csvArrayToObjects', () => {
 ### Exampless
 
 ```js
-const {
-  csvArrayWithoutKeysToObjects,
-} = require('../dist/cjs/csv-array');
+import { csvArrayWithoutKeysToObjects } from '@dz-web/o-orange';
 
 describe('函数csvArrayWithoutKeysToObjects', () => {
   test('输入空数组应该返回空数组', () => {

diff --git a/docs/methods/dateRange.md b/docs/methods/dateRange.md
@@ -29,7 +29,7 @@ Generate an ordered time interval array
 ## Examples
 
 ```js
-import { dateRange } from '../es';
+import { dateRange } from '@dz-web/o-orange';
 
 test('dateRange', () => {
   expect(

diff --git a/docs/methods/ensure.md b/docs/methods/ensure.md
@@ -26,7 +26,7 @@ order: 1
 ## Examples
 
 ```js
-import { ensure, isTrue } from '../es';
+import { ensure, isTrue } from '@dz-web/o-orange';
 
 test('ensure', () => {
   expect(ensure(1)).toEqual(1);

diff --git a/docs/methods/isTrue.md b/docs/methods/isTrue.md
@@ -25,7 +25,7 @@ order: 2
 ## Examples
 
 ```js
-const isTrue = require('../dist/cjs/isTrue').default;
+import { isTrue } from '@dz-web/o-orange'
 
 test('is false not zero', () => {
   expect(isTrue(0)).toBeTruthy();

diff --git a/docs/methods/pagination.md b/docs/methods/pagination.md
@@ -25,11 +25,15 @@ order: 2
 ## Exampless
 
 ```js
-import { pagination } from '../es';
+import { pagination } from '@dz-web/o-orange';
 
 test('is pagination', () => {
   const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 
+  expect(pagination([])).toEqual([]);
+  expect(pagination(arr)).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+  expect(pagination(arr, 1)).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+  expect(pagination(arr, 1, 5)).toEqual([1, 2, 3, 4, 5]);
   expect(pagination(arr, 2, 8)).toEqual([9, 10]);
   expect(pagination(arr, 3, 3)).toEqual([7, 8, 9]);
 })

diff --git a/docs/methods/parseUrl.md b/docs/methods/parseUrl.md
@@ -26,7 +26,7 @@ order: 100
 ## Examples
 
 ```js
-import parseUrl, { parseUrlByHash, parseUrlBySearch } from 'o-orange/lib/parseUrl';
+import parseUrl, { parseUrlByHash, parseUrlBySearch } from '@dz-web/o-orange/lib/parseUrl';
 
 const url = 'http://localhost:8080/?key=3';
 

diff --git a/docs/methods/toPercent.md b/docs/methods/toPercent.md
@@ -27,7 +27,7 @@ order: 3
 ## Examples
 
 ```js
-import { toPercent } from '../es';
+import { toPercent } from '@dz-web/o-orange';
 
 test('toPercent', () => {
   expect(toPercent(0.6515, { multiply: 100, precision: 2 })).toBe('65.15%');

diff --git a/docs/methods/toPlaceholder.md b/docs/methods/toPlaceholder.md
@@ -25,7 +25,7 @@ order: 6
 ## Examples
 
 ```js
-import { toPlaceholder } from '../es';
+import { toPlaceholder } from '@dz-web/o-orange';
 
 test('toPlaceholder', () => {
   expect(toPlaceholder(0)).toBe(0);

diff --git a/package.json b/package.json
@@ -41,6 +41,7 @@
     "coveralls": "^3.1.0",
     "dumi": "^2.2.17",
     "father": "^4.1.7",
+    "gh-pages": "^6.1.1",
     "jest": "^29.5.0",
     "jest-coverage-badges": "^1.1.2",
     "tslint": "^6.1.3",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml