@@ -39,7 +39,7 @@ For example, when throwing errors or warning messages about something.
3939## Install
4040
4141This package is [ ESM only] [ esm ] .
42- In Node.js (version 12.20+, 14.14+, 16.0+, or 18 .0+), install with [ npm] [ ] :
42+ In Node.js (version 14.14+ and 16 .0+), install with [ npm] [ ] :
4343
4444``` sh
4545npm install unist-util-stringify-position
@@ -78,25 +78,27 @@ stringifyPosition({
7878
7979## API
8080
81- This package exports the identifier ` stringifyPosition ` .
81+ This package exports the identifier [ ` stringifyPosition ` ] [ stringifyposition ] .
8282There is no default export.
8383
8484### ` stringifyPosition(node|position|point) `
8585
86- Stringify a point, position, or node.
86+ Serialize the positional info of a point, position (start and end points), or
87+ node.
8788
8889###### Parameters
8990
9091* ` node ` ([ ` Node ` ] [ node ] )
91- — node whose ` ' position' ` property to stringify
92+ — node whose ` position ` fields to serialize
9293* ` position ` ([ ` Position ` ] [ position ] )
93- — position whose ` ' start' ` and ` ' end' ` points to stringify
94+ — position whose ` start ` and ` end ` points to serialize
9495* ` point ` ([ ` Point ` ] [ point ] )
95- — point whose ` ' line' ` and ` ' column' ` to stringify
96+ — point whose ` line ` and ` column ` fields to serialize
9697
9798###### Returns
9899
99100Pretty printed positional info of a node (` string ` ).
101+
100102In the format of a range ` ls:cs-le:ce ` (when given ` node ` or ` position ` ) or a
101103point ` l:c ` (when given ` point ` ), where ` l ` stands for line, ` c ` for column, ` s `
102104for ` start ` , and ` e ` for end.
@@ -112,7 +114,7 @@ It exports no additional types.
112114
113115Projects maintained by the unified collective are compatible with all maintained
114116versions of Node.js.
115- As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18 .0+.
117+ As of now, that is Node.js 14.14+ and 16 .0+.
116118Our projects sometimes work with older versions, but this is not guaranteed.
117119
118120## Security
@@ -197,3 +199,5 @@ abide by its terms.
197199[ position ] : https://github.com/syntax-tree/unist#position
198200
199201[ point ] : https://github.com/syntax-tree/unist#point
202+
203+ [ stringifyposition ] : #stringifypositionnodepositionpoint
0 commit comments