@rvoh/dream 0.45.1 → 0.45.2

package/dist/esm/src/helpers/cli/generateFactoryContent.js

@@ -10,37 +10,47 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
     const belongsToNames = [];
     const belongsToTypedNames = [];
     const associationCreationStatements = [];
-    const stringAttributes = [];
-    let firstStringAttr = true;
+    const attributeDefaults = [];
+    let counterVariableIncremented = false;
     for (const attribute of columnsWithTypes) {
         const [attributeName, attributeType, ...descriptors] = attribute.split(':');
         if (attributeName === undefined)
             continue;
-        const fullyQualifiedAssociatedModelName = standardizeFullyQualifiedModelName(attributeName);
-        const associationModelName = globalClassNameFromFullyQualifiedModelName(fullyQualifiedAssociatedModelName);
-        const associationFactoryImportStatement = `import create${associationModelName} from '${relativeDreamPath('factories', 'factories', fullyQualifiedModelName, fullyQualifiedAssociatedModelName)}'`;
-        const associationName = camelize(associationModelName);
         if (attributeName === undefined)
             continue;
-        if (/_type$/.test(attributeName))
+        const attributeVariable = camelize(attributeName.replace(/\//g, ''));
+        if (/(_type|_id)$/.test(attributeName))
             continue;
         if (!attributeType)
-            throw new Error(`Must pass a column type for ${fullyQualifiedAssociatedModelName} (i.e. ${fullyQualifiedAssociatedModelName}:string)`);
+            throw new Error(`Must pass a column type for ${attributeName} (i.e. ${attributeName}:string)`);
         switch (attributeType) {
-            case 'belongs_to':
-                belongsToNames.push(associationName);
-                belongsToTypedNames.push(`${associationName}: ${associationModelName}`);
+            case 'belongs_to': {
+                const fullyQualifiedAssociatedModelName = standardizeFullyQualifiedModelName(attributeName);
+                const associationModelName = globalClassNameFromFullyQualifiedModelName(fullyQualifiedAssociatedModelName);
+                const associationFactoryImportStatement = `import create${associationModelName} from '${relativeDreamPath('factories', 'factories', fullyQualifiedModelName, fullyQualifiedAssociatedModelName)}'`;
+                belongsToNames.push(attributeVariable);
+                belongsToTypedNames.push(`${attributeVariable}: ${associationModelName}`);
                 additionalImports.push(associationFactoryImportStatement);
-                associationCreationStatements.push(`${associationName}: await create${associationModelName}(),`);
+                associationCreationStatements.push(`${attributeVariable}: attrs.${attributeVariable} ? null : await create${associationModelName}(),`);
                 break;
+            }
             case 'string':
             case 'text':
             case 'citext':
-                stringAttributes.push(`${camelize(attributeName)}: \`${fullyQualifiedModelName} ${camelize(attributeName)} ${firstStringAttr ? '${++counter}' : '${counter}'}\`,`);
-                firstStringAttr = false;
+                attributeDefaults.push(`${attributeVariable}: \`${fullyQualifiedModelName} ${attributeVariable} ${counterVariableIncremented ? '${counter}' : '${++counter}'}\`,`);
+                counterVariableIncremented = true;
                 break;
             case 'enum':
-                stringAttributes.push(`${camelize(attributeName)}: '${(descriptors.at(-1) || '<tbd>').split(',')[0]}',`);
+                attributeDefaults.push(`${attributeVariable}: '${(descriptors.at(-1) || '<tbd>').split(',')[0]}',`);
+                break;
+            case 'integer':
+                attributeDefaults.push(`${attributeVariable}: 1,`);
+                break;
+            case 'bigint':
+                attributeDefaults.push(`${attributeVariable}: '11111111111111111',`);
+                break;
+            case 'decimal':
+                attributeDefaults.push(`${attributeVariable}: 1.1,`);
                 break;
             default:
             // noop
@@ -51,10 +61,10 @@ export default function generateFactoryContent({ fullyQualifiedModelName, column
     return `\
 import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'
 import ${modelClassName} from '${relativePath}'${additionalImports.length ? '\n' + uniq(additionalImports).join('\n') : ''}
-${stringAttributes.length ? '\nlet counter = 0\n' : ''}
+${counterVariableIncremented ? '\nlet counter = 0\n' : ''}
 export default async function create${modelClassName}(attrs: UpdateableProperties<${modelClassName}> = {}) {
   return await ${modelClassName}.create({
-    ${associationCreationStatements.length ? associationCreationStatements.join('\n    ') + '\n    ' : ''}${stringAttributes.length ? stringAttributes.join('\n    ') + '\n    ' : ''}...attrs,
+    ${associationCreationStatements.length ? associationCreationStatements.join('\n    ') + '\n    ' : ''}${attributeDefaults.length ? attributeDefaults.join('\n    ') + '\n    ' : ''}...attrs,
   })
 }
 `;

package/dist/esm/src/helpers/cli/generateMigrationContent.js

@@ -1,16 +1,18 @@
 import pluralize from 'pluralize-esm';
 import InvalidDecimalFieldPassedToGenerator from '../../errors/InvalidDecimalFieldPassedToGenerator.js';
+import compact from '../compact.js';
 import foreignKeyTypeFromPrimaryKey from '../db/foreignKeyTypeFromPrimaryKey.js';
 import snakeify from '../snakeify.js';
 const STI_TYPE_COLUMN_NAME = 'type';
 const COLUMNS_TO_INDEX = [STI_TYPE_COLUMN_NAME];
-const NOT_NULL_COLUMNS = [STI_TYPE_COLUMN_NAME];
 export default function generateMigrationContent({ table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', } = {}) {
     const altering = createOrAlter === 'alter';
     let requireCitextExtension = false;
     const { columnDefs, columnDrops, indexDefs, indexDrops } = columnsWithTypes.reduce((acc, attribute) => {
         const { columnDefs, columnDrops, indexDefs, indexDrops } = acc;
         const [nonStandardAttributeName, attributeType, ...descriptors] = attribute.split(':');
+        const optional = optionalFromDescriptors(descriptors);
+        const sqlAttributeType = getAttributeType(attributeType, descriptors);
         let attributeName = snakeify(nonStandardAttributeName);
         if (attributeName === undefined)
             return acc;
@@ -18,30 +20,29 @@ export default function generateMigrationContent({ table, columnsWithTypes = [],
             return acc;
         if (attributeType === 'citext')
             requireCitextExtension = true;
-        const coercedAttributeType = getAttributeType(attribute);
         switch (attributeType) {
             case 'belongs_to':
                 columnDefs.push(generateBelongsToStr(attributeName, {
                     primaryKeyType,
-                    optional: descriptors.includes('optional'),
+                    optional,
                 }));
                 attributeName = associationNameToForeignKey(attributeName);
                 break;
             case 'enum':
-                columnDefs.push(generateEnumStr(attribute));
+                columnDefs.push(generateEnumStr(attributeName, { descriptors, optional }));
                 break;
             case 'decimal':
-                columnDefs.push(generateDecimalStr(attribute));
+                columnDefs.push(generateDecimalStr(attributeName, { descriptors, optional }));
                 break;
             case 'boolean':
-                columnDefs.push(generateBooleanStr(attributeName));
+                columnDefs.push(generateBooleanStr(attributeName, { optional }));
                 break;
             case 'encrypted':
-                columnDefs.push(generateColumnStr(`encrypted_${attributeName}`, 'text', descriptors));
+                columnDefs.push(generateColumnStr(`encrypted_${attributeName}`, 'text', descriptors, { optional }));
                 break;
             default:
-                if (coercedAttributeType !== undefined) {
-                    columnDefs.push(generateColumnStr(attributeName, coercedAttributeType, descriptors));
+                if (sqlAttributeType !== undefined) {
+                    columnDefs.push(generateColumnStr(attributeName, sqlAttributeType, descriptors, { optional }));
                 }
                 break;
         }
@@ -106,31 +107,29 @@ export async function down(db: Kysely<any>): Promise<void> {
 }\
 `;
 }
-function getAttributeType(attribute) {
-    const [, attributeType, ...descriptors] = attribute.split(':');
-    if (attributeType === 'enum') {
-        return enumAttributeType(attribute)[0];
-    }
+function getAttributeType(attributeType, descriptors) {
     switch (attributeType) {
-        case 'datetime':
-            return 'timestamp';
         case 'string':
             return `varchar(${descriptors[0] || 255})`;
+        case 'enum':
+            return enumAttributeType(descriptors);
+        case 'datetime':
+            return 'timestamp';
         default:
             return attributeType;
     }
 }
-function enumAttributeType(attribute) {
-    const [, , ...descriptors] = attribute.split(':');
+function enumAttributeType(descriptors) {
     return `sql\`${descriptors[0]}_enum\``;
 }
 function generateEnumStatements(columnsWithTypes) {
     const enumStatements = columnsWithTypes.filter(attribute => /:enum:.*:/.test(attribute));
-    const finalStatements = enumStatements.map(statement => {
-        const enumName = statement.split(':')[2];
-        const columnsWithTypesString = statement.split(':')[3];
+    const finalStatements = compact(enumStatements.map(statement => {
+        const [, , enumName, ...descriptors] = statement.split(':');
+        optionalFromDescriptors(descriptors);
+        const columnsWithTypesString = descriptors[0];
         if (columnsWithTypesString === undefined)
-            return '';
+            return;
         const columnsWithTypes = columnsWithTypesString.split(/,\s{0,}/);
         return `  await db.schema
     .createType('${enumName}_enum')
@@ -138,40 +137,41 @@ function generateEnumStatements(columnsWithTypes) {
       ${columnsWithTypes.map(attr => `'${attr}'`).join(',\n      ')}
     ])
     .execute()`;
-    });
+    }));
     return finalStatements.length ? finalStatements.join('\n\n') + '\n\n' : '';
 }
 function generateEnumDropStatements(columnsWithTypes) {
     const enumStatements = columnsWithTypes.filter(attribute => /:enum:.*:/.test(attribute));
-    const finalStatements = enumStatements.map(statement => {
-        const enumName = statement.split(':')[2];
+    const finalStatements = compact(enumStatements.map(statement => {
+        const [, , enumName, ...descriptors] = statement.split(':');
+        optionalFromDescriptors(descriptors);
+        const columnsWithTypesString = descriptors[0];
+        if (columnsWithTypesString === undefined)
+            return;
         return `await db.schema.dropType('${enumName}_enum').execute()`;
-    });
+    }));
     return finalStatements.length ? '\n\n  ' + finalStatements.join('\n  ') : '';
 }
-function generateBooleanStr(attributeName) {
-    return `.addColumn('${attributeName}', 'boolean', col => col.notNull().defaultTo(false))`;
+function generateBooleanStr(attributeName, { optional }) {
+    return `.addColumn('${attributeName}', 'boolean'${optional ? '' : ', col => col.notNull().defaultTo(false)'})`;
 }
-function generateEnumStr(attribute) {
-    const computedAttributeType = enumAttributeType(attribute);
-    const attributeName = attribute.split(':')[0];
+function generateEnumStr(attributeName, { descriptors, optional }) {
+    const computedAttributeType = enumAttributeType(descriptors);
     if (attributeName === undefined)
         return '';
-    const notNull = NOT_NULL_COLUMNS.includes(attributeName);
-    return `.addColumn('${attributeName}', ${computedAttributeType}${notNull ? ', col => col.notNull()' : ''})`;
+    return `.addColumn('${attributeName}', ${computedAttributeType}${optional ? '' : ', col => col.notNull()'})`;
 }
-function generateDecimalStr(attribute) {
-    const [, , ...descriptors] = attribute.split(':');
+function generateDecimalStr(attributeName, { descriptors, optional }) {
     const [scale, precision] = descriptors[0]?.split(',') || [null, null];
     if (!scale || !precision)
-        throw new InvalidDecimalFieldPassedToGenerator(attribute);
-    return `.addColumn('${attribute.split(':')[0]}', 'decimal(${scale}, ${precision})')`;
+        throw new InvalidDecimalFieldPassedToGenerator(attributeName);
+    return `.addColumn('${attributeName}', 'decimal(${scale}, ${precision})'${optional ? '' : ', col => col.notNull()'})`;
 }
-function generateColumnStr(attributeName, attributeType, descriptors) {
+function generateColumnStr(attributeName, attributeType, descriptors, { optional }) {
     let returnStr = `.addColumn('${attributeName}', ${attributeTypeString(attributeType)}`;
     const providedDefaultArg = descriptors.find(d => /^default\(/.test(d));
     const providedDefault = providedDefaultArg?.replace(/^default\(/, '')?.replace(/\)$/, '');
-    const notNull = NOT_NULL_COLUMNS.includes(attributeName);
+    const notNull = !optional;
     const hasExtraValues = providedDefault || notNull;
     if (hasExtraValues)
         returnStr += ', col => col';
@@ -223,3 +223,9 @@ function generateIdStr({ primaryKeyType }) {
 function associationNameToForeignKey(associationName) {
     return snakeify(associationName.replace(/\//g, '_').replace(/_id$/, '') + '_id');
 }
+function optionalFromDescriptors(descriptors) {
+    const optional = descriptors.at(-1) === 'optional';
+    if (optional)
+        descriptors.pop();
+    return optional;
+}

package/dist/esm/src/helpers/cli/generateSerializer.js

@@ -3,7 +3,7 @@ import dreamFileAndDirPaths from '../path/dreamFileAndDirPaths.js';
 import dreamPath from '../path/dreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 import generateSerializerContent from './generateSerializerContent.js';
-export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, }) {
+export default async function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const { relFilePath, absDirPath, absFilePath } = dreamFileAndDirPaths(dreamPath('serializers'), `${fullyQualifiedModelName}Serializer.ts`);
     try {
@@ -14,6 +14,7 @@ export default async function generateSerializer({ fullyQualifiedModelName, colu
             columnsWithTypes,
             fullyQualifiedParentName,
             stiBaseSerializer,
+            includeAdminSerializers,
         }));
     }
     catch (error) {

package/dist/esm/src/helpers/cli/generateSerializerContent.js

@@ -4,7 +4,7 @@ import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFu
 import relativeDreamPath from '../path/relativeDreamPath.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
 import uniq from '../uniq.js';
-export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer = false, }) {
+export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes = [], fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }) {
     fullyQualifiedModelName = standardizeFullyQualifiedModelName(fullyQualifiedModelName);
     const additionalImports = [];
     const dreamImports = [];
@@ -24,7 +24,7 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
         : `(${modelInstanceName}: ${modelClassName})`;
     const modelSerializerArgs = `${modelInstanceName}`;
     const dreamSerializerArgs = `${stiBaseSerializer ? 'StiChildClass' : modelClassName}, ${modelInstanceName}`;
-    const serialzerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
+    const serializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName));
     const summarySerializerClassName = serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedModelName), 'summary');
     const defaultSerializerExtends = isSTI
         ? `${serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName))}(${modelClassName}, ${modelSerializerArgs})`
@@ -32,16 +32,18 @@ export default function generateSerializerContent({ fullyQualifiedModelName, col
     const summarySerializerExtends = isSTI
         ? `${serializerNameFromFullyQualifiedModelName(fullyQualifiedModelNameToSerializerBaseName(fullyQualifiedParentName), 'summary')}(${modelClassName}, ${modelSerializerArgs})`
         : `DreamSerializer(${dreamSerializerArgs})`;
+    // Admin variants
+    const adminSerializerClassName = serializerClassName.replace(/Serializer$/, 'AdminSerializer');
+    const adminSummarySerializerClassName = summarySerializerClassName.replace(/SummarySerializer$/, 'AdminSummarySerializer');
+    // end:Admin variants
     const additionalModelImports = [];
     const dreamImport = dreamImports.length
         ? `import { ${uniq(dreamImports).join(', ')} } from '@rvoh/dream'\n`
         : '';
     const additionalImportsStr = uniq(additionalImports).join('');
-    return `${dreamImport}${additionalImportsStr}${relatedModelImport}${additionalModelImports.join('')}
-export const ${summarySerializerClassName} = ${modelSerializerSignature} =>
-  ${summarySerializerExtends}${isSTI ? '' : `\n    .attribute('id')`}
-
-export const ${serialzerClassName} = ${modelSerializerSignature} =>
+    const summarySerializer = `export const ${summarySerializerClassName} = ${modelSerializerSignature} =>
+  ${summarySerializerExtends}${isSTI ? '' : `\n    .attribute('id')`}`;
+    const defaultSerializer = `export const ${serializerClassName} = ${modelSerializerSignature} =>
   ${defaultSerializerExtends}${columnsWithTypes
         .map(attr => {
         const [name, type] = attr.split(':');
@@ -51,7 +53,17 @@ export const ${serialzerClassName} = ${modelSerializerSignature} =>
             return '';
         return `\n    ${attribute(name, type, attr)}`;
     })
-        .join('\n\n  ')}
+        .join('')}`;
+    return `${dreamImport}${additionalImportsStr}${relatedModelImport}${additionalModelImports.join('')}
+${summarySerializer}
+
+${defaultSerializer}${!includeAdminSerializers
+        ? ''
+        : `
+
+${summarySerializer.replace(summarySerializerClassName, adminSummarySerializerClassName)}
+
+${defaultSerializer.replace(serializerClassName, adminSerializerClassName).replace(summarySerializerClassName, adminSummarySerializerClassName)}`}
 `;
 }
 function attribute(name, type, attr) {

package/dist/types/src/helpers/cli/generateDream.d.ts

@@ -4,6 +4,7 @@ export default function generateDream({ fullyQualifiedModelName, columnsWithType
     options: {
         serializer: boolean;
         stiBaseSerializer: boolean;
+        includeAdminSerializers: boolean;
     };
     fullyQualifiedParentName?: string | undefined;
 }): Promise<void>;

package/dist/types/src/helpers/cli/generateDreamContent.d.ts

@@ -1,6 +1,7 @@
-export default function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, }: {
+export default function generateDreamContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, serializer, includeAdminSerializers, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes: string[];
     fullyQualifiedParentName?: string | undefined;
     serializer: boolean;
+    includeAdminSerializers: boolean;
 }): string;

package/dist/types/src/helpers/cli/generateSerializer.d.ts

@@ -1,6 +1,7 @@
-export default function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, }: {
+export default function generateSerializer({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes: string[];
     fullyQualifiedParentName?: string | undefined;
     stiBaseSerializer: boolean;
+    includeAdminSerializers: boolean;
 }): Promise<void>;

package/dist/types/src/helpers/cli/generateSerializerContent.d.ts

@@ -1,6 +1,7 @@
-export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, }: {
+export default function generateSerializerContent({ fullyQualifiedModelName, columnsWithTypes, fullyQualifiedParentName, stiBaseSerializer, includeAdminSerializers, }: {
     fullyQualifiedModelName: string;
     columnsWithTypes?: string[] | undefined;
     fullyQualifiedParentName?: string | undefined;
-    stiBaseSerializer?: boolean;
+    stiBaseSerializer: boolean;
+    includeAdminSerializers: boolean;
 }): string;

package/docs/classes/Benchmark.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Benchmark | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Benchmark.html">Benchmark</a></li></ul><h1>Class Benchmark</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/1c1a0545b9b13f0ca6ea73b79c47f1d0261cafd9/src/helpers/benchmark.ts#L6">src/helpers/benchmark.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Benchmark.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Benchmark | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Benchmark.html">Benchmark</a></li></ul><h1>Class Benchmark</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L6">src/helpers/benchmark.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Benchmark.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Benchmark.html#mark" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a>
 <a href="Benchmark.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Benchmark" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Benchmark</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a><a href="#constructor.new_Benchmark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="mark" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark</span><a href="#mark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mark.mark-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mark.mark-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">BenchmarkLogLevel</span><span class="tsd-signature-symbol"> = &#39;log&#39;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/1c1a0545b9b13f0ca6ea73b79c47f1d0261cafd9/src/helpers/benchmark.ts#L12">src/helpers/benchmark.ts:12</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/1c1a0545b9b13f0ca6ea73b79c47f1d0261cafd9/src/helpers/benchmark.ts#L8">src/helpers/benchmark.ts:8</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#mark" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Benchmark" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Benchmark</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a><a href="#constructor.new_Benchmark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Benchmark.html" class="tsd-signature-type tsd-kind-class">Benchmark</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="mark" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mark</span><a href="#mark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mark.mark-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mark</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mark.mark-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">BenchmarkLogLevel</span><span class="tsd-signature-symbol"> = &#39;log&#39;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L12">src/helpers/benchmark.ts:12</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/605422b2ac68c94b3f0fd8eb8077784dafe370d7/src/helpers/benchmark.ts#L8">src/helpers/benchmark.ts:8</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#mark" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mark</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>