aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/index.ts160
-rw-r--r--src/interface/frameInterface.ts4
-rw-r--r--src/lib/display.ts80
-rw-r--r--src/lib/frame.ts42
-rw-r--r--src/lib/locate.ts29
5 files changed, 166 insertions, 149 deletions
diff --git a/src/index.ts b/src/index.ts
index 857af22..f4a56a2 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,153 +1,25 @@
-import { table } from 'table';
-import { FrameInterface } from './interface/frameInterface';
-import { getTable } from './lib/display';
+import { data, header } from './lib/frame';
+import { getSingleColumnDetails } from './lib/locate';
+import { show, head, tail } from './lib/display';
-class Izuku implements FrameInterface {
+class Izuku {
rowdata: unknown[][] = [];
- columns!: string[];
+ columns: string[] = [];
- constructor(rowdata?: Array<unknown[]>, header?: Array<string>) {
+ constructor(rowdata?: Array<unknown[]>, columns?: Array<string>) {
this.rowdata = rowdata || [];
- this.columns = header || [];
+ this.columns = columns || [];
}
- /**
- * data prints the data of the frame in console.table format. It also sets the new data to the frame if data is passed as a parameter
- * @param rowdata: the rowdata to be sent to the frame
- * @returns the current frame
- */
- data(rowdata?: Array<unknown[]>): this | unknown[][] | any {
- if (rowdata) {
- this.rowdata = rowdata;
- }
- return this;
- }
-
- /**
- * header sets the names of the columns of the frame
- * @param header: the header to be attached to the frame
- * @returns the current frame
- */
- header(header: Array<string>): this | Array<string> | any {
- if (!this.rowdata.length) {
- throw new Error('Set data before setting header');
- } else {
- const passedHeaderLength = header.length;
- const maxSizedArrayLength = this.rowdata.reduce((acc, curr) => {
- return acc.length > curr.length ? acc : curr;
- }).length;
- if (passedHeaderLength !== maxSizedArrayLength) {
- throw new Error('Header length does not match data length');
- } else {
- this.columns = header;
- }
- }
-
- return this;
- }
-
- /**
- * column returns a single column of the frame, option is either the column name or the column index
- * @param column: the column to be returned
- * @returns a single column of the frame as array of arrays
- */
- public column(column: number | string): Array<unknown> | any {
- let extractedColumn: any[] = [];
- let columnName = '';
- if (typeof column === 'string') {
- extractedColumn = this.rowdata.map((row) => {
- return row[this.columns.indexOf(column)];
- });
- columnName = column;
- }
- if (typeof column === 'number') {
- extractedColumn = this.rowdata.map((row) => {
- return row[column];
- });
- columnName = this.columns[column]
- ? this.columns[column]
- : `column${column + 1}`;
- }
- extractedColumn = extractedColumn.map((item) => [item]);
- return new Izuku(extractedColumn, [columnName]);
- }
-
- /**
- * show prints the frame in console.table format
- * @returns the current frame
- * @throws Error if the frame is empty
- */
- public show(): void {
- if (!this.rowdata.length) {
- throw new Error('Set data before printing');
- }
- const numberOfRows = this.rowdata.length;
- if (numberOfRows < 7) {
- console.log(table(getTable(this.rowdata, this.columns)));
- } else {
- const firstThreeRows = this.rowdata.slice(0, 3);
- const lastThreeRows = this.rowdata.slice(numberOfRows - 3);
- const middleRow = [];
- for (let i = 0; i < this.columns.length; i++) {
- middleRow.push('...');
- }
- const indexRow = [
- 0,
- 1,
- 2,
- '...',
- numberOfRows - 3,
- numberOfRows - 2,
- numberOfRows - 1
- ];
- const combinedRow = [...firstThreeRows, [...middleRow], ...lastThreeRows];
- console.log(table(getTable(combinedRow, this.columns, indexRow)));
- }
- }
-
- /**
- * head prints maximum first n rows of the frame
- * @param n: the number of rows to be returned
- * @returns the first n rows of the frame as array of arrays
- * @throws Error if the frame is empty
- */
- public head(n = 5): void {
- if (!this.rowdata.length) {
- throw new Error('Set data before printing');
- }
- // Check if n is greater than the number of rows
- if (n > this.rowdata.length) {
- n = this.rowdata.length;
- }
-
- // Generate the index row
- const indexRow = this.rowdata.map((row, index) => index);
- const data = this.rowdata.slice(0, n);
- console.log(table(getTable(data, this.columns, indexRow)));
- }
-
- /**
- * tail prints maximum last n rows of the frame
- * @param n: the number of rows to be returned
- * @returns the last n rows of the frame as array of arrays
- * @throws Error if the frame is empty
- */
- public tail(n = 5): void {
- if (!this.rowdata.length) {
- throw new Error('Set data before printing');
- }
- // Check if n is greater than the number of rows
- if (n > this.rowdata.length) {
- n = this.rowdata.length;
- }
-
- // Generate the index row
- const indexRow = this.rowdata.map((row, index) => index);
- const data = this.rowdata.slice(this.rowdata.length - n);
- // Slice the index row to match the data
- const slicedIndexRow = indexRow.slice(indexRow.length - n);
- console.log(table(getTable(data, this.columns, slicedIndexRow)));
- }
+ public data = data;
+ public header = header;
+ public show = show;
+ public head = head;
+ public tail = tail;
+ public column = (column: number | string) => {
+ const izSampler = getSingleColumnDetails(this, column);
+ return new Izuku(izSampler.rowd, izSampler.rowh);
+ };
}
export = Izuku;
diff --git a/src/interface/frameInterface.ts b/src/interface/frameInterface.ts
deleted file mode 100644
index bc61c90..0000000
--- a/src/interface/frameInterface.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-export interface FrameInterface {
- rowdata: Array<unknown[]>;
- columns: Array<string>;
-}
diff --git a/src/lib/display.ts b/src/lib/display.ts
index 591429a..432ac82 100644
--- a/src/lib/display.ts
+++ b/src/lib/display.ts
@@ -1,3 +1,6 @@
+import Izuku from '../index';
+import { table } from 'table';
+
function getTable(
rowdata: unknown[][],
columns: string[],
@@ -24,4 +27,79 @@ function getTable(
return [['Index', ...columns], ...frameRows];
}
-export { getTable };
+/**
+ * show prints the frame in console.table format
+ * @returns the current frame
+ * @throws Error if the frame is empty
+ */
+export function show(this: Izuku): void {
+ if (!this.rowdata.length) {
+ throw new Error('Set data before printing');
+ }
+ const numberOfRows = this.rowdata.length;
+ if (numberOfRows < 7) {
+ console.log(table(getTable(this.rowdata, this.columns)));
+ } else {
+ const firstThreeRows = this.rowdata.slice(0, 3);
+ const lastThreeRows = this.rowdata.slice(numberOfRows - 3);
+ const middleRow = [];
+ for (let i = 0; i < this.columns.length; i++) {
+ middleRow.push('...');
+ }
+ const indexRow = [
+ 0,
+ 1,
+ 2,
+ '...',
+ numberOfRows - 3,
+ numberOfRows - 2,
+ numberOfRows - 1
+ ];
+ const combinedRow = [...firstThreeRows, [...middleRow], ...lastThreeRows];
+ console.log(table(getTable(combinedRow, this.columns, indexRow)));
+ }
+}
+
+/**
+ * head prints maximum first n rows of the frame
+ * @param n: the number of rows to be returned
+ * @returns the first n rows of the frame as array of arrays
+ * @throws Error if the frame is empty
+ */
+export function head(this: Izuku, n = 5): void {
+ if (!this.rowdata.length) {
+ throw new Error('Set data before printing');
+ }
+ // Check if n is greater than the number of rows
+ if (n > this.rowdata.length) {
+ n = this.rowdata.length;
+ }
+
+ // Generate the index row
+ const indexRow = this.rowdata.map((row, index) => index);
+ const data = this.rowdata.slice(0, n);
+ console.log(table(getTable(data, this.columns, indexRow)));
+}
+
+/**
+ * tail prints maximum last n rows of the frame
+ * @param n: the number of rows to be returned
+ * @returns the last n rows of the frame as array of arrays
+ * @throws Error if the frame is empty
+ */
+export function tail(this: Izuku, n = 5): void {
+ if (!this.rowdata.length) {
+ throw new Error('Set data before printing');
+ }
+ // Check if n is greater than the number of rows
+ if (n > this.rowdata.length) {
+ n = this.rowdata.length;
+ }
+
+ // Generate the index row
+ const indexRow = this.rowdata.map((row, index) => index);
+ const data = this.rowdata.slice(this.rowdata.length - n);
+ // Slice the index row to match the data
+ const slicedIndexRow = indexRow.slice(indexRow.length - n);
+ console.log(table(getTable(data, this.columns, slicedIndexRow)));
+}
diff --git a/src/lib/frame.ts b/src/lib/frame.ts
new file mode 100644
index 0000000..1106ede
--- /dev/null
+++ b/src/lib/frame.ts
@@ -0,0 +1,42 @@
+import Izuku from '../index';
+/**
+ * data prints the data of the frame in console.table format. It also sets the new data to the frame if data is passed as a parameter
+ * @param rowdata: the rowdata to be sent to the frame
+ * @returns the current frame
+ */
+export function data(
+ this: Izuku,
+ rowdata?: Array<unknown[]>
+): unknown[][] | any {
+ if (rowdata) {
+ this.rowdata = rowdata;
+ }
+
+ return this;
+}
+
+/**
+ * header sets the names of the columns of the frame
+ * @param header: the header to be attached to the frame
+ * @returns the current frame
+ */
+export function header(
+ this: Izuku,
+ header: Array<string>
+): Array<string> | any {
+ if (!this.rowdata.length) {
+ throw new Error('Set data before setting header');
+ } else {
+ const passedHeaderLength = header.length;
+ const maxSizedArrayLength = this.rowdata.reduce((acc, curr) => {
+ return acc.length > curr.length ? acc : curr;
+ }).length;
+ if (passedHeaderLength !== maxSizedArrayLength) {
+ throw new Error('Header length does not match data length');
+ } else {
+ this.columns = header;
+ }
+ }
+
+ return this;
+}
diff --git a/src/lib/locate.ts b/src/lib/locate.ts
new file mode 100644
index 0000000..b176e07
--- /dev/null
+++ b/src/lib/locate.ts
@@ -0,0 +1,29 @@
+interface Izuku {
+ rowdata: unknown[][];
+ columns: string[];
+}
+/**
+ * column returns a single column of the frame, option is either the column name or the column index
+ * @param column: the column to be returned
+ * @returns a single column of the frame as array of arrays
+ */
+export function getSingleColumnDetails(iz: Izuku, column: number | string) {
+ let extractedColumn: any[] = [];
+ let columnName = '';
+ if (typeof column === 'string') {
+ extractedColumn = iz.rowdata.map((row) => {
+ return row[iz.columns.indexOf(column)];
+ });
+ columnName = column;
+ }
+ if (typeof column === 'number') {
+ extractedColumn = iz.rowdata.map((row) => {
+ return row[column];
+ });
+ columnName = iz.columns[column]
+ ? iz.columns[column]
+ : `column${column + 1}`;
+ }
+ extractedColumn = extractedColumn.map((item) => [item]);
+ return { rowd: extractedColumn, rowh: [columnName] };
+}
generated by cgit v1.2.3 (git 2.25.1) at 2026-06-06 03:11:13 +0000