Skip to content

Commit 3cdb069

Browse files
committed
docs: update docs
1 parent 5b7b9d2 commit 3cdb069

10 files changed

+63
-60
lines changed

README.md

+33-30
Original file line numberDiff line numberDiff line change
@@ -44,36 +44,39 @@ const A1 = require('@flighter/a1-notation');
4444

4545
**Note:** A1 string could be represented in any register. `A1 === a1`, `A1:B2 === a1:b2 === A1:b2 === a1:B2`
4646

47-
- [static isValid(a1: string): boolean](docs/method-static-isValid.md)
48-
- [static getCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md)
49-
- [static getLastCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md)
50-
- [static getRow(a1: string): number](docs/method-static-get.md)
51-
- [static getLastRow(a1: string): number](docs/method-static-get.md)
52-
- [static getWidth(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md)
53-
- [static getHeight(a1: string): number](docs/method-static-get.md)
54-
- [static toCol(col: number): string](docs/method-static-to.md)
55-
- [static toRow(row: number): string](docs/method-static-to.md)
56-
- [constructor](docs/constructor.md)
57-
- [get(): string](docs/method-get.md)
58-
- [toString(): string](docs/method-get.md)
59-
- [toJSON(): result](docs/method-get.md)
60-
- [getCol(): number](docs/method-get.md)
61-
- [getLastCol(): number](docs/method-get.md)
62-
- [getRow(): number](docs/method-get.md)
63-
- [getLastRow(): number](docs/method-get.md)
64-
- [getWidth(): number](docs/method-get.md)
65-
- [getHeight(): number](docs/method-get.md)
66-
- [setCol(val: string | number): this](docs/method-set.md)
67-
- [setLastCol(val: string | number): this](docs/method-set.md)
68-
- [setRow(val: string | number): this](docs/method-set.md)
69-
- [setLastRow(val: string | number): this](docs/method-set.md)
70-
- [copy(): A1](docs/method-copy.md)
71-
- [addX(count: number): this](docs/method-add.md)
72-
- [addY(count: number): this](docs/method-add.md)
73-
- [add(countX: number, countY: number): this](docs/method-add.md)
74-
- [removeX(count: number): this](docs/method-remove.md)
75-
- [removeY(count: number): this](docs/method-remove.md)
76-
- [remove(countX: number, countY: number): this](docs/method-remove.md)
47+
- [static isValid(a1: string): boolean](docs/method-static-isValid.md#isvalid)
48+
- [static getCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getcol)
49+
- [static getLastCol(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getlastcol)
50+
- [static getRow(a1: string): number](docs/method-static-get.md#getrow)
51+
- [static getLastRow(a1: string): number](docs/method-static-get.md#getlastrow)
52+
- [static getWidth(a1: string, converter: 1 | 2 = 1): number](docs/method-static-get.md#getwidth)
53+
- [static getHeight(a1: string): number](docs/method-static-get.md#getheight)
54+
- [static toCol(col: number): string](docs/method-static-to.md#tocol)
55+
- [static toRow(row: number): string](docs/method-static-to.md#torow)
56+
- [constructor](docs/constructor.md#constructor)
57+
- [get(): string](docs/method-get.md#get)
58+
- [toString(): string](docs/method-get.md#tostring)
59+
- [toJSON(): result](docs/method-get.md#tojson)
60+
- [getCol(): number](docs/method-get.md#getcol)
61+
- [getLastCol(): number](docs/method-get.md#getlastcol)
62+
- [getRow(): number](docs/method-get.md#getrow)
63+
- [getLastRow(): number](docs/method-get.md#getlastrow)
64+
- [getWidth(): number](docs/method-get.md#getwidth)
65+
- [getHeight(): number](docs/method-get.md#getheight)
66+
- [setCol(val: string | number): this](docs/method-set.md#setcol)
67+
- [setLastCol(val: string | number): this](docs/method-set.md#setlastcol)
68+
- [setRow(val: string | number): this](docs/method-set.md#setrow)
69+
- [setLastRow(val: string | number): this](docs/method-set.md#setlastrow)
70+
- [copy(): A1](docs/method-copy.md#copy)
71+
- [addX(count: number): this](docs/method-add.md#addx)
72+
- [addY(count: number): this](docs/method-add.md#addy)
73+
- [add(countX: number, countY: number): this](docs/method-add.md#add)
74+
- [removeX(count: number): this](docs/method-remove.md#removex)
75+
- [removeY(count: number): this](docs/method-remove.md#removey)
76+
- [remove(countX: number, countY: number): this](docs/method-remove.md#remove)
7777
- [shiftX(offset: number): this](docs/method-shift.md#shiftx)
7878
- [shiftY(offset: number): this](docs/method-shift.md#shifty)
7979
- [shift(offsetX: number, offsetY: number): this](docs/method-shift.md#shift)
80+
81+
## License
82+
[MIT](LICENSE)

docs/constructor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**constructor**
1+
### constructor
22
```js
33
// constructor(object: options) - in version "with object"
44
// constructor(range: string)

docs/method-add.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**addX**
1+
### addX
22
```js
33
// addX(count: number): this
44

@@ -23,7 +23,7 @@ new A1('A1:B2').addX(-1);// A1:B2
2323
new A1('C1:E1').addX(-1);// B1:E1
2424
```
2525

26-
**addY**
26+
### addY
2727
```js
2828
// addY(count: number): this
2929

@@ -54,7 +54,7 @@ new A1('A1:B2').addY(-1);// A1:B2
5454
new A1('A3:B4').addY(-1);// A2:B4
5555
```
5656

57-
**add**
57+
### add
5858
```js
5959
// add(countX: number, countY: number): this
6060

docs/method-copy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**copy**
1+
### copy
22
```js
33
// copy(): A1
44

docs/method-get.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**get**
1+
### get
22
```js
33
// get(): string
44

@@ -11,7 +11,7 @@ new A1('A1').get(); // 'A1'
1111
new A1('A1:B2').get();// 'A1:B2'
1212
```
1313

14-
**toString**
14+
### toString
1515
```js
1616
// toString(): string
1717

@@ -24,7 +24,7 @@ new A1('A1').toString(); // 'A1'
2424
new A1('A1:B2').toString();// 'A1:B2'
2525
```
2626

27-
**toJSON**
27+
### toJSON
2828
```js
2929
// toJSON(): result
3030
/**
@@ -71,7 +71,7 @@ new A1('A1:B2').toJSON();
7171
*/
7272
```
7373

74-
**getCol**
74+
### getCol
7575
```js
7676
// getCol(): number
7777

@@ -84,7 +84,7 @@ new A1('A1').getCol(); // 1
8484
new A1('A1:B2').getCol();// 1
8585
```
8686

87-
**getLastCol**
87+
### getLastCol
8888
```js
8989
// getLastCol(): number
9090

@@ -97,7 +97,7 @@ new A1('A1').getLastCol(); // 1
9797
new A1('A1:B2').getLastCol();// 2
9898
```
9999

100-
**getRow**
100+
### getRow
101101
```js
102102
// getRow(): number
103103

@@ -110,7 +110,7 @@ new A1('A1').getRow(); // 1
110110
new A1('A1:B2').getRow();// 1
111111
```
112112

113-
**getLastRow**
113+
### getLastRow
114114
```js
115115
// getLastRow(): number
116116

@@ -123,7 +123,7 @@ new A1('A1').getLastRow(); // 1
123123
new A1('A1:B2').getLastRow();// 2
124124
```
125125

126-
**getWidth**
126+
### getWidth
127127
```js
128128
// getWidth(): number
129129

@@ -136,7 +136,7 @@ new A1('A1').getWidth(); // 1
136136
new A1('A1:B2').getWidth();// 2
137137
```
138138

139-
**getHeight**
139+
### getHeight
140140
```js
141141
// getHeight(): number
142142

docs/method-remove.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**removeX**
1+
### removeX
22
```js
33
// removeX(count: number): this
44

@@ -23,7 +23,7 @@ new A1('A1:B2').removeX(-1);// B1:B2
2323
new A1('B3:C4').removeX(-1);// C3:C4
2424
```
2525

26-
**removeY**
26+
### removeY
2727
```js
2828
// removeY(count: number): this
2929

@@ -54,7 +54,7 @@ new A1('A1:B2').removeY(-1);// A2:B2
5454
new A1('B3:C4').removeY(-1);// B4:C4
5555
```
5656

57-
**remove**
57+
### remove
5858
```js
5959
// remove(countX: number, countY: number): this
6060

docs/method-set.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**setCol**
1+
### setCol
22
```js
33
// setCol(val: string | number): this
44

@@ -12,7 +12,7 @@ new A1('B2:C4').setCol('1');// A2:C4
1212
new A1('B2:C4').setCol('A');// A2:C4
1313
```
1414

15-
**setLastCol**
15+
### setLastCol
1616
```js
1717
// setLastCol(val: string | number): this
1818

@@ -26,7 +26,7 @@ new A1('B2:C4').setLastCol('6');// B2:F4
2626
new A1('B2:C4').setLastCol('F');// B2:F4
2727
```
2828

29-
**setRow**
29+
### setRow
3030
```js
3131
// setRow(val: string | number): this
3232

@@ -39,7 +39,7 @@ new A1('B2:C4').setRow(3); // B3:C4
3939
new A1('B2:C4').setRow('3');// B3:C4
4040
```
4141

42-
**setLastRow**
42+
### setLastRow
4343
```js
4444
// setLastRow(val: string | number): this
4545

docs/method-static-get.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*static* **getCol**
1+
### <a name="getcol"></a> *static* getCol
22
```js
33
// static getCol(a1: string, converter: 1 | 2 = 1): number
44

@@ -12,7 +12,7 @@ A1.getCol('A1:B2');// 1
1212
A1.getCol('aaaaa');// Error
1313
```
1414

15-
*static* **getLastCol**
15+
### <a name="getlastcol"></a> *static* getLastCol
1616
```js
1717
// static getLastCol(a1: string, converter: 1 | 2 = 1): number
1818

@@ -26,7 +26,7 @@ A1.getLastCol('A1:B2');// 2
2626
A1.getLastCol('aaaaa');// Error
2727
```
2828

29-
*static* **getRow**
29+
### <a name="getrow"></a> *static* getRow
3030
```js
3131
// static getRow(a1: string): number
3232

@@ -40,7 +40,7 @@ A1.getRow('A1:B2');// 1
4040
A1.getRow('aaaaa');// Error
4141
```
4242

43-
*static* **getLastRow**
43+
### <a name="getlastrow"></a> *static* getLastRow
4444
```js
4545
// static getLastRow(a1: string): number
4646

@@ -54,7 +54,7 @@ A1.getLastRow('A1:B2');// 1
5454
A1.getLastRow('aaaaa');// Error
5555
```
5656

57-
*static* **getWidth**
57+
### <a name="getwidth"></a> *static* getWidth
5858
```js
5959
// static getWidth(a1: string, converter: 1 | 2 = 1): number
6060

@@ -68,7 +68,7 @@ A1.getWidth('A1:B2');// 2
6868
A1.getWidth('aaaaa');// Error
6969
```
7070

71-
*static* **getHeight**
71+
### <a name="getheight"></a> *static* getHeight
7272
```js
7373
// static getHeight(a1: string): number
7474

docs/method-static-isValid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*static* **isValid**
1+
### <a name="isvalid"></a> *static* isValid
22
```js
33
// static isValid(a1: string): boolean
44

docs/method-static-to.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*static* **toCol**
1+
### <a name="tocol"></a> *static* toCol
22
```js
33
// static toCol(col: number): string
44

@@ -11,7 +11,7 @@ A1.toCol(1); // 'A'
1111
A1.toCol('A1');// Error
1212
```
1313

14-
*static* **toRow**
14+
### <a name="torow"></a> *static* toRow
1515
```js
1616
// static toRow(row: number): string
1717

0 commit comments

Comments
 (0)