getPrettyStoreApi

The getPrettyStoreApi method attempts to return prettified code-generated .d.ts and .ts(x) files that describe the schema of a Store and React bindings (since v3.1) in an ORM style.

getPrettyStoreApi(storeName: string): Promise<[string, string, string, string]>

This is simply a wrapper around the getStoreApi method that attempts to invoke the prettier module (which it hopes you have installed) to format the generated code. If prettier is not present, the output will resemble that of the underlying getStoreApi method.

The method is asynchronous, so you should use the await keyword or handle the results as a promise.

The method takes a single argument which represents the name you want the generated store object to have in code. You are expected to save the four files yourself, as the following:

• [storeName].d.ts as the main definition,
• [storeName].ts as the main library,
• [storeName]-ui-react.d.ts as the ui-react module definition,
• [storeName]-ui-react.tsx as the ui-react module library.

Also you should save these alongside each other so that the .ts(x) files can import types from the .d.ts files.

See the documentation for the getStoreApi method for details of the content of the generated files.

import {createStore} from 'tinybase';
import {createTools} from 'tinybase/tools';

const store = createStore().setTablesSchema({
  pets: {
    price: {type: 'number'},
  },
});
const [dTs, ts, _uiReactDTs, _uiReactTsx] =
  await createTools(store).getPrettyStoreApi('shop');

const dTsLines = dTs.split('\n');
console.log(dTsLines[15]);
// -> `export type Tables = {pets?: {[rowId: Id]: {price?: number}}};`

const tsLines = ts.split('\n');
console.log(tsLines[89]);
// -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'

import {createStore} from 'tinybase';
import {createTools} from 'tinybase/tools';

const store = createStore().setTable('pets', {
  fido: {price: 5},
  felix: {price: 4},
});
const [dTs, ts, _uiReactDTs, _uiReactTsx] =
  await createTools(store).getPrettyStoreApi('shop');

const dTsLines = dTs.split('\n');
console.log(dTsLines[15]);
// -> 'export type Tables = {pets?: {[rowId: Id]: {price: number}}};'

const tsLines = ts.split('\n');
console.log(tsLines[91]);
// -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'