Skip to content

Commit 7c99701

Browse files
authored
Update README.md
1 parent 621893d commit 7c99701

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -62,25 +62,25 @@ The crawlPage API has [puppeteer](https://github.com/puppeteer/puppeteer) built
6262
- [Type](#Type-1)
6363
- [Example](#Example-2)
6464
- [Config](#Config)
65-
- [1.Simple target config - string](#1.Simple-target-config---string)
66-
- [2.Detailed target config - CrawlPageDetailTargetConfig](#2.Detailed-target-config---CrawlPageDetailTargetConfig)
67-
- [3.Mixed target array config - (string | CrawlPageDetailTargetConfig)[]](<#3.Mixed-target-array-config---(string-|-CrawlPageDetailTargetConfig)[]>)
68-
- [4.Advanced config - CrawlPageAdvancedConfig](#4.Advanced-config---CrawlPageAdvancedConfig)
65+
- [Simple target config - string](#Simple-target-config---string)
66+
- [Detailed target config - CrawlPageDetailTargetConfig](#Detailed-target-config---CrawlPageDetailTargetConfig)
67+
- [Mixed target array config - (string | CrawlPageDetailTargetConfig)[]](<#Mixed-target-array-config---(string-|-CrawlPageDetailTargetConfig)[]>)
68+
- [Advanced config - CrawlPageAdvancedConfig](#Advanced-config---CrawlPageAdvancedConfig)
6969
- [crawlData](#crawlData)
7070
- [Type](#Type-2)
7171
- [Example](#Example-3)
7272
- [Config](#Config-1)
73-
- [1.Simple target config - string](#1.Simple-target-config---string-1)
74-
- [2.Detailed target config - CrawlDataDetailTargetConfig](#2.Detailed-target-config---CrawlDataDetailTargetConfig)
75-
- [3.Mixed target array config - (string | CrawlDataDetailTargetConfig)[]](<#3.Mixed-target-array-config---(string-|-CrawlDataDetailTargetConfig)[]>)
76-
- [4.Advanced config - CrawlDataAdvancedConfig](#4.Advanced-config---CrawlDataAdvancedConfig)
73+
- [Simple target config - string](#Simple-target-config---string-1)
74+
- [Detailed target config - CrawlDataDetailTargetConfig](#Detailed-target-config---CrawlDataDetailTargetConfig)
75+
- [Mixed target array config - (string | CrawlDataDetailTargetConfig)[]](<#Mixed-target-array-config---(string-|-CrawlDataDetailTargetConfig)[]>)
76+
- [Advanced config - CrawlDataAdvancedConfig](#Advanced-config---CrawlDataAdvancedConfig)
7777
- [crawlFile](#crawlFile)
7878
- [Type](#Type-3)
7979
- [Example](#Example-4)
8080
- [Config](#Config-2)
81-
- [1.Detailed target config - CrawlFileDetailTargetConfig](#1.Detailed-target-config---CrawlFileDetailTargetConfig)
82-
- [2.Detailed target array config - CrawlFileDetailTargetConfig[]](#2.Detailed-target-array-config---CrawlFileDetailTargetConfig[])
83-
- [3.Advanced config - CrawlFileAdvancedConfig](#3.Advanced-config---CrawlFileAdvancedConfig)
81+
- [Detailed target config - CrawlFileDetailTargetConfig](#Detailed-target-config---CrawlFileDetailTargetConfig)
82+
- [Detailed target array config - CrawlFileDetailTargetConfig[]](#Detailed-target-array-config---CrawlFileDetailTargetConfig[])
83+
- [Advanced config - CrawlFileAdvancedConfig](#Advanced-config---CrawlFileAdvancedConfig)
8484
- [crawlPolling](#crawlPolling)
8585
- [Type](#Type-4)
8686
- [Example](#Example-5)
@@ -706,7 +706,7 @@ There are 4 types:
706706
- Mixed target array config - (string | CrawlPageDetailTargetConfig)[]
707707
- Advanced config - CrawlPageAdvancedConfig
708708
709-
##### 1.Simple target config - string
709+
##### Simple target config - string
710710
711711
This is a simple target configuration. if you just want to simply crawl this page, you can try this way of writing:
712712
@@ -720,7 +720,7 @@ myXCrawl.crawlPage('https://www.example.com').then((res) => {})
720720
721721
The res you get will be an object.
722722
723-
##### 2.Detailed target config - CrawlPageDetailTargetConfig
723+
##### Detailed target config - CrawlPageDetailTargetConfig
724724
725725
This is the detailed target configuration. if you want to crawl this page and need to retry on failure, you can try this way of writing:
726726
@@ -742,7 +742,7 @@ The res you get will be an object.
742742
743743
More configuration options can view [CrawlPageDetailTargetConfig](#CrawlPageDetailTargetConfig).
744744
745-
##### 3.Mixed target array config - (string | CrawlPageDetailTargetConfig)[]
745+
##### Mixed target array config - (string | CrawlPageDetailTargetConfig)[]
746746
747747
This is a mixed target array configuration. if you want to crawl multiple pages, and some pages need to fail and retry, you can try this way of writing:
748748
@@ -763,7 +763,7 @@ The res you get will be an array of objects.
763763
764764
More configuration options can view [CrawlPageDetailTargetConfig](#CrawlPageDetailTargetConfig).
765765
766-
##### 4.Advanced config - CrawlPageAdvancedConfig
766+
##### Advanced config - CrawlPageAdvancedConfig
767767
768768
This is an advanced configuration, targets is a mixed target array configuration. if you want to crawl multiple pages, and the request configuration (proxy, cookies, retry, etc.) does not want to be written repeatedly, if you need an interval, you can try this way of writing:
769769
@@ -863,7 +863,7 @@ There are 4 types:
863863
- Mixed target array config - (string | CrawlDataDetailTargetConfig)[]
864864
- Advanced config - CrawlDataAdvancedConfig
865865
866-
##### 1.Simple target config - string
866+
##### Simple target config - string
867867
868868
This is a simple target configuration. if you just want to simply crawl the data, and the interface is GET, you can try this way of writing:
869869
@@ -877,7 +877,7 @@ myXCrawl.crawlData('https://www.example.com/api').then((res) => {})
877877
878878
The res you get will be an object.
879879
880-
##### 2.Detailed target config - CrawlDataDetailTargetConfig
880+
##### Detailed target config - CrawlDataDetailTargetConfig
881881
882882
This is the detailed target configuration. if you want to crawl this data and need to retry on failure, you can try this way of writing:
883883
@@ -899,7 +899,7 @@ The res you get will be an object.
899899
900900
More configuration options can view [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
901901
902-
##### 3.Mixed target array config - (string | CrawlDataDetailTargetConfig)[]
902+
##### Mixed target array config - (string | CrawlDataDetailTargetConfig)[]
903903
904904
This is a mixed target array configuration. if you want to crawl multiple data, and some data needs to fail and retry, you can try this way of writing:
905905
@@ -920,7 +920,7 @@ The res you get will be an array of objects.
920920
921921
More configuration options can view [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
922922
923-
##### 4.Advanced config - CrawlDataAdvancedConfig
923+
##### Advanced config - CrawlDataAdvancedConfig
924924
925925
This is an advanced configuration, targets is a mixed target array configuration. if you want to crawl multiple data, and the request configuration (proxy, cookies, retry, etc.) does not want to be written repeatedly, if you need an interval, you can try this writing method:
926926
@@ -1013,11 +1013,10 @@ myXCrawl
10131013
There are 3 types:
10141014
10151015
- Detailed target config - CrawlFileDetailTargetConfig
1016-
10171016
- Detailed target array config - CrawlFileDetailTargetConfig[]
10181017
- Advanced config CrawlFileAdvancedConfig
10191018
1020-
##### 1.Detailed target config - CrawlFileDetailTargetConfig
1019+
##### Detailed target config - CrawlFileDetailTargetConfig
10211020
10221021
This is the detailed target configuration. if you want to crawl this file and need to retry on failure, you can try this way of writing:
10231022
@@ -1041,7 +1040,7 @@ The res you get will be an object.
10411040
10421041
More configuration options can view [CrawlFileDetailTargetConfig](#CrawlFileDetailTargetConfig).
10431042
1044-
##### 2.Detailed target array config - CrawlFileDetailTargetConfig[]
1043+
##### Detailed target array config - CrawlFileDetailTargetConfig[]
10451044
10461045
This is the detailed target array configuration. if you want to crawl multiple files, and some data needs to be retried after failure, you can try this way of writing:
10471046
@@ -1062,7 +1061,7 @@ The res you get will be an array of objects.
10621061
10631062
More configuration options can view [CrawlFileDetailTargetConfig](#CrawlFileDetailTargetConfig).
10641063
1065-
##### 3.Advanced config CrawlFileAdvancedConfig
1064+
##### Advanced config CrawlFileAdvancedConfig
10661065
10671066
This is an advanced configuration, targets is a mixed target array configuration. if you want to crawl multiple data, and the request configuration (storeDir, proxy, retry, etc.) does not want to be written repeatedly, and you need interval time, etc., you can try this way of writing:
10681067

0 commit comments

Comments
 (0)