tables.generatecodebook.md

Home > @datashaper/tables > generateCodebook

generateCodebook() function

Signature:

export declare function generateCodebook(table: ColumnTable, typeHints?: TypeHints, options?: {
    autoType?: boolean;
    autoMax?: number;
    onInferring?: (column: string) => void;
    onProgress?: (numComplete: number) => void;
}): Promise<CodebookSchema>;

Parameters

Parameter	Type	Description
table	ColumnTable
typeHints	TypeHints	(Optional)
options	{ autoType?: boolean; autoMax?: number; onInferring?: (column: string) => void; onProgress?: (numComplete: number) => void; }	(Optional)

Returns:

Promise<CodebookSchema>