diff options
| author | Priyansh <[email protected]> | 2022-01-21 13:27:39 -0500 |
|---|---|---|
| committer | Priyansh <[email protected]> | 2022-01-21 13:27:39 -0500 |
| commit | 9b744e4ce05b56a1aef94110c027d920a5e10005 (patch) | |
| tree | 9a8590193fa49867d2d9472f2e07ac20d6cd5b72 /README.md | |
| parent | 6852945a0d2b2afb86d20788de011c7bfbaa3809 (diff) | |
| download | izuku.js-9b744e4ce05b56a1aef94110c027d920a5e10005.tar.xz izuku.js-9b744e4ce05b56a1aef94110c027d920a5e10005.zip | |
docs: move badges to center
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 21 insertions, 9 deletions
@@ -1,9 +1,11 @@ -    - <p align="center"> <img width="100%" src="./render/Izuku.png"> </p> +<p align="center"> + <img src="https://img.shields.io/github/workflow/status/luciferreeves/izuku.js/Node.js%20CI"> <img src="https://img.shields.io/tokei/lines/github/luciferreeves/izuku.js?label=lines%20of%20code"> <img src="https://img.shields.io/github/license/luciferreeves/izuku.js"> <img src="https://img.shields.io/github/issues-raw/luciferreeves/izuku.js"> +</p> + # Izuku Izuku is a simple, fast, and powerful tabular data representation and manipulation library written in [TypeScript](https://www.typescriptlang.org/). It is designed to be used to view, manipulate and debug 2D data in NodeJS applications. @@ -64,11 +66,13 @@ The above code creates a frame and prints it to the console. It looks like this: ``` ## Frame Properties + There are some properties attached to the frame class. You can tap into those properties by using the dot (.) notation. > **Note:** Frame methods are not available on the properties. You need to `console.log(propername)` to see the property values. ### `rowdata` + The `rowdata` property is an array of arrays that represents the data in the frame. > **Note:** The `rowdata` property is read-only. If you want to modify the data in the frame, you can use the `data()` method. @@ -79,6 +83,7 @@ console.log(rowdata); // prints "data" array ``` ### `columns` + The `columns` property is an array of strings that represents the column names in the frame. > **Note:** The `columns` property is read-only. If you want to modify the column names in the frame, you can use the `header()` method. @@ -89,6 +94,7 @@ console.log(columns); // prints "header" array ``` ### `size` + The `size` property gives the number of elements present in the frame. > **Note:** The `size` property is read-only and is automatically generated when the frame is created. Size can change if data is modified. @@ -99,6 +105,7 @@ console.log(size); // prints size. ex: 9 ``` ### `shape` + The `shape` property gives the number of rows and columns present in the frame. > **Note:** The `shape` property is read-only and is automatically generated when the frame is created. Shape can change if data is modified. @@ -109,9 +116,11 @@ console.log(shape); // prints shape. ex: 9 x 4 ``` ## Frame Methods + There are some methods attached to the frame class. You can tap into those methods by using the dot (.) notation. Most of the methods are chainable. ### `data()`  + The `data()` method is used to modify the data in the frame. It takes the same data argument as the constructor – which is an array of arrays. > **Note:** If you use data method without passing any argument, it will simply return the frame. @@ -186,6 +195,7 @@ The `row()` method is used to get the row data of a particular row. It takes the The `row()` method returns a new frame with extracted row data as the data of the frame. You can chain other frame methods on the returned frame. #### Get a single row + ```js // get a single row on Index 2 (Index starts from 0) const row = frame.row(2); @@ -195,6 +205,7 @@ row.show(); ``` #### Get multiple rows + ```js // get multiple rows on Index 2 and 3 (Index starts from 0) const rows = frame.row([2, 3]); @@ -281,13 +292,12 @@ Helper methods are methods that are used to help you with some common tasks. The `range()` is a helper method that is used to create a an array of numbers. Here are the arguments and their default values: - -| Argument | Description | Default Value | -|----------|-------------|-------------- | -| `start` | The start of the range | Required | -| `end` | The end of the range | Required | -| `step` | The step size of the range | 1 | -| `remove` | An array of numbers which should not be included in the range | `undefined` | +| Argument | Description | Default Value | +| -------- | ------------------------------------------------------------- | ------------- | +| `start` | The start of the range | Required | +| `end` | The end of the range | Required | +| `step` | The step size of the range | 1 | +| `remove` | An array of numbers which should not be included in the range | `undefined` | > Note: The `step` and `remove` arguments are optional. If you do not provide it, `step` will be set to 1 and `remove` will be set to `undefined`. @@ -343,11 +353,13 @@ git clone https://github.com/luciferreeves/izuku.js.git ``` Run the build script: + ```bash cd izuku.js && npm install && npm run build ``` Run tests: + ```bash cd izuku.js && npm test ``` |
