@oclif/table 0.1.0 → 0.1.1

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export { makeTable, makeTables } from './table.js';
-export type { TableProps } from './types.js';
+export { printTable, printTables } from './table.js';
+export type { ScalarDict, TableProps } from './types.js';

package/lib/index.js

@@ -1 +1 @@
-export { makeTable, makeTables } from './table.js';
+export { printTable, printTables } from './table.js';

package/lib/table.d.ts

@@ -19,7 +19,7 @@ export declare function Skeleton(props: React.PropsWithChildren & {
  * Renders a table with the given data.
  * @param options see {@link TableProps}
  */
-export declare function makeTable<T extends ScalarDict>(options: TableProps<T>): void;
-export declare function makeTables<T extends ScalarDict[]>(tables: {
+export declare function printTable<T extends ScalarDict>(options: TableProps<T>): void;
+export declare function printTables<T extends ScalarDict[]>(tables: {
     [P in keyof T]: TableProps<T[P]>;
 }, options?: Omit<ContainerProps, 'children'>): void;

package/lib/table.js

@@ -217,14 +217,14 @@ export function Skeleton(props) {
  * Renders a table with the given data.
  * @param options see {@link TableProps}
  */
-export function makeTable(options) {
+export function printTable(options) {
     const instance = render(React.createElement(Table, { ...options }));
     instance.unmount();
 }
 function Container(props) {
     return (React.createElement(Box, { flexWrap: "wrap", flexDirection: props.direction ?? 'row', ...props }, props.children));
 }
-export function makeTables(tables, options) {
+export function printTables(tables, options) {
     const leftMargin = options?.marginLeft ?? options?.margin ?? 0;
     const rightMargin = options?.marginRight ?? options?.margin ?? 0;
     const columns = process.stdout.columns - (leftMargin + rightMargin);

package/lib/types.d.ts

@@ -123,16 +123,16 @@ export type TableProps<T extends ScalarDict> = {
      * ]
      *
      * // sort the name column in ascending order
-     * makeTable({data, sort: {name: 'asc'}})
+     * printTable({data, sort: {name: 'asc'}})
      *
      * // sort the name column in descending order
-     * makeTable({data, sort: {name: 'desc'}})
+     * printTable({data, sort: {name: 'desc'}})
      *
      * // sort by name in ascending order and age in descending order
-     * makeTable({data, sort: {name: 'asc', age: 'desc'}})
+     * printTable({data, sort: {name: 'asc', age: 'desc'}})
      *
      * // sort by name in ascending order and age in descending order using a custom sort function
-     * makeTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
+     * printTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
      * ```
      */
     sort?: Sort<T>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {