Skip to content

Commit c1bd5d9

Browse files
risenWrisenW
committed
Update jsdoc for Series io
1 parent 4a8cdbd commit c1bd5d9

File tree

2 files changed

+26
-84
lines changed

2 files changed

+26
-84
lines changed

‎src/danfojs-browser/src/core/series.ts‎

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -69,39 +69,26 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
6969
*
7070
* @example
7171
* ```
72-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
72+
* const df = new Series([1, 2, 3, 4])
7373
* const csv = df.toCSV()
7474
* console.log(csv)
75-
* //output
76-
* "A","B"
77-
* 1,2
78-
* 3,4
7975
* ```
8076
*
8177
* @example
8278
* ```
83-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
79+
* const df = new Series([1, 2, 3, 4])
8480
* const csv = df.toCSV({ header: false })
85-
* console.log(csv)
86-
* //output
87-
* 1,2
88-
* 3,4
8981
* ```
9082
*
9183
* @example
9284
* ```
93-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
85+
* const df = new Series([1, 2, 3, 4])
9486
* const csv = df.toCSV({ sep: ';' })
95-
* console.log(csv)
96-
* //output
97-
* "A";"B"
98-
* 1;2
99-
* 3;4
10087
* ```
10188
*
10289
* @example
10390
* ```
104-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
91+
* const df = new Series([1, 2, 3, 4])
10592
* df.toCSV({ fileName: 'data.csv', download: true }) //Downloads file in Browser
10693
* ```
10794
*
@@ -113,39 +100,33 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
113100
}
114101

115102
/**
116-
* Converts a DataFrame to JSON.
103+
* Converts a Series to JSON.
117104
* @param options Configuration object. Supported options:
118105
* - `fileName`: The name of the JSON file. Defaults to `data.json`. Option is only available in Browser.
119106
* - `download`: If true, the JSON will be downloaded. Defaults to false. Option is only available in Browser.
120107
* - `format`: The format of the JSON. Supported values are `'column'` and `'row'`. Defaults to `'column'`.
121108
*
122109
* @example
123110
* ```
124-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
111+
* const df = new Series([1, 2, 3, 4])
125112
* const json = df.toJSON()
126113
* ```
127114
*
128115
* @example
129116
* ```
130-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
117+
* const df = new Series([1, 2, 3, 4])
131118
* const json = df.toJSON({ format: 'row' })
132-
* console.log(json)
133-
* //output
134-
* [{"A":1,"B":2},{"A":3,"B":4}]
135119
* ```
136120
*
137121
* @example
138122
* ```
139-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
123+
* const df = new Series([1, 2, 3, 4])
140124
* const json = df.toJSON({ format: "column" })
141-
* console.log(json)
142-
* //output
143-
* {"A":[1,3],"B":[2,4]}
144125
* ```
145126
*
146127
* @example
147128
* ```
148-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
129+
* const df = new Series([1, 2, 3, 4])
149130
* df.toJSON({ fileName: 'data.json', download: true }) // downloads file browser
150131
* ```
151132
*/
@@ -156,27 +137,27 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
156137

157138

158139
/**
159-
* Converts a DataFrame to Excel file format.
140+
* Converts a Series to Excel file format.
160141
* @param options Configuration object. Supported options:
161142
* - `sheetName`: The sheet name to be written to. Defaults to `'Sheet1'`.
162143
* - `filePath`: The filePath to be written to. Defaults to `'./output.xlsx'`. Option is only available in NodeJs
163144
* - `fileName`: The fileName to be written to. Defaults to `'output.xlsx'`. Option is only available in Browser
164145
*
165146
* @example
166147
* ```
167-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
148+
* const df = new Series([1, 2, 3, 4])
168149
* df.toExcel({ filePath: './output.xlsx' }) // writes to local file system as output.xlsx in NodeJS
169150
* ```
170151
*
171152
* @example
172153
* ```
173-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
154+
* const df = new Series([1, 2, 3, 4])
174155
* df.toExcel({ fileName: 'output.xlsx', download: true }) // downloads file browser
175156
* ```
176157
*
177158
* @example
178159
* ```
179-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
160+
* const df = new Series([1, 2, 3, 4])
180161
* df.toExcel({ sheetName: 'Sheet2' }) // writes to Sheet2 in Excel
181162
* ```
182163
*

‎src/danfojs-node/src/core/series.ts‎

Lines changed: 13 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
4747
}
4848

4949
/**
50-
* Converts a DataFrame to CSV.
50+
* Converts a Series to CSV.
5151
* @param options Configuration object. Supports the following options:
5252
* - `filePath`: Local file path to write the CSV file. If not specified, the CSV will be returned as a string. Option is only available in NodeJS.
5353
* - `fileName`: Name of the CSV file. Defaults to `data.csv`. Option is only available in Browser.
@@ -57,48 +57,27 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
5757
*
5858
* @example
5959
* ```
60-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
60+
* const df = new Series([1, 2, 3, 4])
6161
* const csv = df.toCSV()
62-
* console.log(csv)
63-
* //output
64-
* "A","B"
65-
* 1,2
66-
* 3,4
6762
* ```
6863
*
6964
* @example
7065
* ```
71-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
66+
* const df = new Series([1, 2, 3, 4])
7267
* const csv = df.toCSV({ header: false })
73-
* console.log(csv)
74-
* //output
75-
* 1,2
76-
* 3,4
7768
* ```
7869
*
7970
* @example
8071
* ```
81-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
72+
* const df = new Series([1, 2, 3, 4])
8273
* const csv = df.toCSV({ sep: ';' })
83-
* console.log(csv)
84-
* //output
85-
* "A";"B"
86-
* 1;2
87-
* 3;4
8874
* ```
8975
*
9076
* @example
9177
* ```
92-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
78+
* const df = new Series([1, 2, 3, 4])
9379
* df.toCSV({ filePath: './data.csv' }) //write to local file in NodeJS
9480
* ```
95-
*
96-
* @example
97-
* ```
98-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
99-
* df.toCSV({ fileName: 'data.csv', download: true }) //Downloads file in Browser
100-
* ```
101-
*
10281
*/
10382
toCSV(options?: CsvOutputOptionsNode): string
10483
toCSV(options?: CsvOutputOptionsNode): string | void {
@@ -107,7 +86,7 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
10786
}
10887

10988
/**
110-
* Converts a DataFrame to JSON.
89+
* Converts a Series to JSON.
11190
* @param options Configuration object. Supported options:
11291
* - `filePath`: The file path to write the JSON to. If not specified, the JSON object is returned. Option is only available in NodeJS.
11392
* - `fileName`: The name of the JSON file. Defaults to `data.json`. Option is only available in Browser.
@@ -116,39 +95,27 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
11695
*
11796
* @example
11897
* ```
119-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
98+
* const df = new Series([1, 2, 3, 4])
12099
* const json = df.toJSON()
121100
* ```
122101
*
123102
* @example
124103
* ```
125-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
104+
* const df = new Series([1, 2, 3, 4])
126105
* const json = df.toJSON({ format: 'row' })
127-
* console.log(json)
128-
* //output
129-
* [{"A":1,"B":2},{"A":3,"B":4}]
130106
* ```
131107
*
132108
* @example
133109
* ```
134-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
110+
* const df = new Series([1, 2, 3, 4])
135111
* const json = df.toJSON({ format: "column" })
136-
* console.log(json)
137-
* //output
138-
* {"A":[1,3],"B":[2,4]}
139112
* ```
140113
*
141114
* @example
142115
* ```
143-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
116+
* const df = new Series([1, 2, 3, 4])
144117
* df.toJSON({ filePath: './data.json' }) // downloads to local file system as data.json in NodeJS
145118
* ```
146-
*
147-
* @example
148-
* ```
149-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
150-
* df.toJSON({ fileName: 'data.json', download: true }) // downloads file browser
151-
* ```
152119
*/
153120
toJSON(options?: JsonOutputOptionsNode): object
154121
toJSON(options?: JsonOutputOptionsNode): object | void {
@@ -157,27 +124,21 @@ export default class Series extends BaseSeries implements ExtendedSeriesInterfac
157124

158125

159126
/**
160-
* Converts a DataFrame to Excel file format.
127+
* Converts a Series to Excel file format.
161128
* @param options Configuration object. Supported options:
162129
* - `sheetName`: The sheet name to be written to. Defaults to `'Sheet1'`.
163130
* - `filePath`: The filePath to be written to. Defaults to `'./output.xlsx'`. Option is only available in NodeJs
164131
* - `fileName`: The fileName to be written to. Defaults to `'output.xlsx'`. Option is only available in Browser
165132
*
166133
* @example
167134
* ```
168-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
135+
* const df = new Series([1, 2, 3, 4])
169136
* df.toExcel({ filePath: './output.xlsx' }) // writes to local file system as output.xlsx in NodeJS
170137
* ```
171138
*
172139
* @example
173140
* ```
174-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
175-
* df.toExcel({ fileName: 'output.xlsx', download: true }) // downloads file browser
176-
* ```
177-
*
178-
* @example
179-
* ```
180-
* const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
141+
* const df = new Series([1, 2, 3, 4])
181142
* df.toExcel({ sheetName: 'Sheet2' }) // writes to Sheet2 in Excel
182143
* ```
183144
*

0 commit comments

Comments
 (0)