@rvoh/dream 0.31.1 → 0.31.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/dist/cjs/src/Dream.js +15 -15
- package/dist/cjs/src/bin/helpers/sync.js +9 -2
- package/dist/cjs/src/bin/index.js +18 -19
- package/dist/cjs/src/cli/logger/DreamCliLogger.js +12 -46
- package/dist/cjs/src/cli/logger/loggable/DreamCliLoggable.js +1 -3
- package/dist/cjs/src/cli/logger/loggable/DreamCliLoggableText.js +2 -2
- package/dist/cjs/src/decorators/Decorators.js +28 -28
- package/dist/cjs/src/decorators/field/association/BelongsTo.js +2 -2
- package/dist/cjs/src/decorators/field/association/HasMany.js +2 -2
- package/dist/cjs/src/decorators/field/association/HasOne.js +2 -2
- package/dist/cjs/src/decorators/field/lifecycle/AfterCreateCommit.js +1 -1
- package/dist/cjs/src/decorators/field/lifecycle/AfterDestroyCommit.js +1 -1
- package/dist/cjs/src/decorators/field/lifecycle/AfterSaveCommit.js +1 -1
- package/dist/cjs/src/decorators/field/lifecycle/AfterUpdateCommit.js +1 -1
- package/dist/cjs/src/decorators/field/validation/Validates.js +1 -1
- package/dist/cjs/src/dream/DreamClassTransactionBuilder.js +2 -2
- package/dist/cjs/src/dream/Query.js +2 -2
- package/dist/cjs/src/helpers/cli/generateDreamContent.js +2 -2
- package/dist/cjs/src/helpers/db/runMigration.js +5 -5
- package/dist/cjs/src/helpers/sspawn.js +29 -3
- package/dist/cjs/src/serializer/decorators/associations/RendersMany.js +2 -2
- package/dist/cjs/src/serializer/decorators/associations/RendersOne.js +2 -2
- package/dist/esm/src/Dream.js +15 -15
- package/dist/esm/src/bin/helpers/sync.js +9 -2
- package/dist/esm/src/bin/index.js +18 -19
- package/dist/esm/src/cli/logger/DreamCliLogger.js +12 -46
- package/dist/esm/src/cli/logger/loggable/DreamCliLoggable.js +1 -3
- package/dist/esm/src/cli/logger/loggable/DreamCliLoggableText.js +2 -2
- package/dist/esm/src/decorators/Decorators.js +28 -28
- package/dist/esm/src/decorators/field/association/BelongsTo.js +2 -2
- package/dist/esm/src/decorators/field/association/HasMany.js +2 -2
- package/dist/esm/src/decorators/field/association/HasOne.js +2 -2
- package/dist/esm/src/decorators/field/lifecycle/AfterCreateCommit.js +1 -1
- package/dist/esm/src/decorators/field/lifecycle/AfterDestroyCommit.js +1 -1
- package/dist/esm/src/decorators/field/lifecycle/AfterSaveCommit.js +1 -1
- package/dist/esm/src/decorators/field/lifecycle/AfterUpdateCommit.js +1 -1
- package/dist/esm/src/decorators/field/validation/Validates.js +1 -1
- package/dist/esm/src/dream/DreamClassTransactionBuilder.js +2 -2
- package/dist/esm/src/dream/Query.js +2 -2
- package/dist/esm/src/helpers/cli/generateDreamContent.js +2 -2
- package/dist/esm/src/helpers/db/runMigration.js +5 -5
- package/dist/esm/src/helpers/sspawn.js +29 -3
- package/dist/esm/src/serializer/decorators/associations/RendersMany.js +2 -2
- package/dist/esm/src/serializer/decorators/associations/RendersOne.js +2 -2
- package/dist/types/src/Dream.d.ts +15 -15
- package/dist/types/src/cli/logger/DreamCliLogger.d.ts +4 -8
- package/dist/types/src/cli/logger/loggable/DreamCliLoggable.d.ts +1 -3
- package/dist/types/src/cli/logger/loggable/DreamCliLoggableText.d.ts +1 -2
- package/dist/types/src/decorators/Decorators.d.ts +22 -22
- package/dist/types/src/decorators/field/lifecycle/AfterCreateCommit.d.ts +1 -1
- package/dist/types/src/decorators/field/lifecycle/AfterDestroyCommit.d.ts +1 -1
- package/dist/types/src/decorators/field/lifecycle/AfterSaveCommit.d.ts +1 -1
- package/dist/types/src/decorators/field/lifecycle/AfterUpdateCommit.d.ts +1 -1
- package/dist/types/src/dream/DreamClassTransactionBuilder.d.ts +2 -2
- package/dist/types/src/dream/Query.d.ts +2 -2
- package/dist/types/src/helpers/sspawn.d.ts +6 -2
- package/dist/types/src/serializer/decorators/associations/RendersMany.d.ts +2 -2
- package/dist/types/src/serializer/decorators/associations/RendersOne.d.ts +2 -2
- package/dist/types/src/types/logger.d.ts +1 -5
- package/docs/classes/Benchmark.html +2 -2
- package/docs/classes/CalendarDate.html +2 -2
- package/docs/classes/CreateOrFindByFailedToCreateAndFind.html +3 -3
- package/docs/classes/Decorators.html +38 -38
- package/docs/classes/Dream.html +138 -138
- package/docs/classes/DreamApplication.html +4 -4
- package/docs/classes/DreamBin.html +2 -2
- package/docs/classes/DreamCLI.html +4 -4
- package/docs/classes/DreamDbConnection.html +2 -2
- package/docs/classes/DreamGlam.html +2 -2
- package/docs/classes/DreamImporter.html +2 -2
- package/docs/classes/DreamMigrationHelpers.html +7 -7
- package/docs/classes/DreamSerializer.html +2 -2
- package/docs/classes/DreamTransaction.html +2 -2
- package/docs/classes/Encrypt.html +2 -2
- package/docs/classes/Env.html +2 -2
- package/docs/classes/GlobalNameNotSet.html +3 -3
- package/docs/classes/NonLoadedAssociation.html +3 -3
- package/docs/classes/Query.html +51 -51
- package/docs/classes/Range.html +2 -2
- package/docs/classes/RecordNotFound.html +3 -3
- package/docs/classes/ValidationError.html +3 -3
- package/docs/functions/Attribute.html +1 -1
- package/docs/functions/RendersMany.html +2 -2
- package/docs/functions/RendersOne.html +2 -2
- package/docs/functions/ReplicaSafe.html +1 -1
- package/docs/functions/STI.html +1 -1
- package/docs/functions/SoftDelete.html +1 -1
- package/docs/functions/camelize.html +1 -1
- package/docs/functions/capitalize.html +1 -1
- package/docs/functions/closeAllDbConnections.html +1 -1
- package/docs/functions/compact.html +1 -1
- package/docs/functions/db.html +1 -1
- package/docs/functions/debug.html +1 -1
- package/docs/functions/dreamDbConnections.html +1 -1
- package/docs/functions/dreamPath.html +1 -1
- package/docs/functions/generateDream.html +1 -1
- package/docs/functions/globalClassNameFromFullyQualifiedModelName.html +1 -1
- package/docs/functions/hyphenize.html +1 -1
- package/docs/functions/inferSerializerFromDreamClassOrViewModelClass.html +1 -1
- package/docs/functions/inferSerializerFromDreamOrViewModel.html +1 -1
- package/docs/functions/isEmpty.html +1 -1
- package/docs/functions/loadRepl.html +1 -1
- package/docs/functions/lookupClassByGlobalName.html +1 -1
- package/docs/functions/pascalize.html +1 -1
- package/docs/functions/pgErrorType.html +1 -1
- package/docs/functions/range-1.html +1 -1
- package/docs/functions/relativeDreamPath.html +1 -1
- package/docs/functions/round.html +1 -1
- package/docs/functions/serializerNameFromFullyQualifiedModelName.html +1 -1
- package/docs/functions/sharedPathPrefix.html +1 -1
- package/docs/functions/snakeify.html +1 -1
- package/docs/functions/sort.html +1 -1
- package/docs/functions/sortBy.html +1 -1
- package/docs/functions/standardizeFullyQualifiedModelName.html +1 -1
- package/docs/functions/uncapitalize.html +1 -1
- package/docs/functions/uniq.html +1 -1
- package/docs/functions/validateColumn.html +1 -1
- package/docs/functions/validateTable.html +1 -1
- package/docs/index.html +5 -5
- package/docs/interfaces/AttributeStatement.html +2 -2
- package/docs/interfaces/DecoratorContext.html +2 -2
- package/docs/interfaces/DreamApplicationInitOptions.html +2 -2
- package/docs/interfaces/DreamApplicationOpts.html +2 -2
- package/docs/interfaces/DreamSerializerAssociationStatement.html +2 -2
- package/docs/interfaces/EncryptOptions.html +2 -2
- package/docs/interfaces/OpenapiSchemaProperties.html +1 -1
- package/docs/interfaces/OpenapiSchemaPropertiesShorthand.html +1 -1
- package/docs/interfaces/OpenapiTypeFieldObject.html +1 -1
- package/docs/types/Camelized.html +1 -1
- package/docs/types/CommonOpenapiSchemaObjectFields.html +1 -1
- package/docs/types/DateTime.html +1 -1
- package/docs/types/DreamAssociationMetadata.html +1 -1
- package/docs/types/DreamAttributes.html +1 -1
- package/docs/types/DreamClassColumn.html +1 -1
- package/docs/types/DreamColumn.html +1 -1
- package/docs/types/DreamColumnNames.html +1 -1
- package/docs/types/DreamLogLevel.html +1 -1
- package/docs/types/DreamLogger.html +1 -1
- package/docs/types/DreamOrViewModelSerializerKey.html +1 -1
- package/docs/types/DreamParamSafeAttributes.html +1 -1
- package/docs/types/DreamParamSafeColumnNames.html +1 -1
- package/docs/types/DreamSerializerKey.html +1 -1
- package/docs/types/DreamSerializers.html +1 -1
- package/docs/types/DreamTableSchema.html +1 -1
- package/docs/types/DreamVirtualColumns.html +1 -1
- package/docs/types/EncryptAlgorithm.html +1 -1
- package/docs/types/Hyphenized.html +1 -1
- package/docs/types/IdType.html +1 -1
- package/docs/types/OpenapiAllTypes.html +1 -1
- package/docs/types/OpenapiFormats.html +1 -1
- package/docs/types/OpenapiNumberFormats.html +1 -1
- package/docs/types/OpenapiPrimitiveTypes.html +1 -1
- package/docs/types/OpenapiSchemaArray.html +1 -1
- package/docs/types/OpenapiSchemaArrayShorthand.html +1 -1
- package/docs/types/OpenapiSchemaBase.html +1 -1
- package/docs/types/OpenapiSchemaBody.html +1 -1
- package/docs/types/OpenapiSchemaBodyShorthand.html +1 -1
- package/docs/types/OpenapiSchemaCommonFields.html +1 -1
- package/docs/types/OpenapiSchemaExpressionAllOf.html +1 -1
- package/docs/types/OpenapiSchemaExpressionAnyOf.html +1 -1
- package/docs/types/OpenapiSchemaExpressionOneOf.html +1 -1
- package/docs/types/OpenapiSchemaExpressionRef.html +1 -1
- package/docs/types/OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
- package/docs/types/OpenapiSchemaInteger.html +1 -1
- package/docs/types/OpenapiSchemaNull.html +1 -1
- package/docs/types/OpenapiSchemaNumber.html +1 -1
- package/docs/types/OpenapiSchemaObject.html +1 -1
- package/docs/types/OpenapiSchemaObjectAllOf.html +1 -1
- package/docs/types/OpenapiSchemaObjectAllOfShorthand.html +1 -1
- package/docs/types/OpenapiSchemaObjectAnyOf.html +1 -1
- package/docs/types/OpenapiSchemaObjectAnyOfShorthand.html +1 -1
- package/docs/types/OpenapiSchemaObjectBase.html +1 -1
- package/docs/types/OpenapiSchemaObjectBaseShorthand.html +1 -1
- package/docs/types/OpenapiSchemaObjectOneOf.html +1 -1
- package/docs/types/OpenapiSchemaObjectOneOfShorthand.html +1 -1
- package/docs/types/OpenapiSchemaObjectShorthand.html +1 -1
- package/docs/types/OpenapiSchemaPartialSegment.html +1 -1
- package/docs/types/OpenapiSchemaPrimitiveGeneric.html +1 -1
- package/docs/types/OpenapiSchemaShorthandExpressionAllOf.html +1 -1
- package/docs/types/OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
- package/docs/types/OpenapiSchemaShorthandExpressionOneOf.html +1 -1
- package/docs/types/OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
- package/docs/types/OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
- package/docs/types/OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
- package/docs/types/OpenapiSchemaString.html +1 -1
- package/docs/types/OpenapiShorthandAllTypes.html +1 -1
- package/docs/types/OpenapiShorthandPrimitiveTypes.html +1 -1
- package/docs/types/OpenapiTypeField.html +1 -1
- package/docs/types/Pascalized.html +1 -1
- package/docs/types/PrimaryKeyType.html +1 -1
- package/docs/types/RoundingPrecision.html +1 -1
- package/docs/types/SerializableClassOrSerializerCallback.html +1 -1
- package/docs/types/SerializableDreamClassOrViewModelClass.html +1 -1
- package/docs/types/SerializableDreamOrViewModel.html +1 -1
- package/docs/types/SerializableTypes.html +1 -1
- package/docs/types/Snakeified.html +1 -1
- package/docs/types/Timestamp.html +1 -1
- package/docs/types/UpdateableAssociationProperties.html +1 -1
- package/docs/types/UpdateableProperties.html +1 -1
- package/docs/types/ValidationType.html +1 -1
- package/docs/types/ViewModelSerializerKey.html +1 -1
- package/docs/types/WhereStatementForDream.html +1 -1
- package/docs/types/WhereStatementForDreamClass.html +1 -1
- package/docs/variables/DateTime-1.html +1 -1
- package/docs/variables/DreamConst.html +1 -1
- package/docs/variables/TRIGRAM_OPERATORS.html +1 -1
- package/docs/variables/openapiPrimitiveTypes-1.html +1 -1
- package/docs/variables/openapiShorthandPrimitiveTypes-1.html +1 -1
- package/docs/variables/ops.html +1 -1
- package/docs/variables/primaryKeyTypes.html +1 -1
- package/package.json +1 -2
- package/dist/cjs/src/cli/logger/helpers/createSpinner.js +0 -14
- package/dist/cjs/src/cli/logger/loggable/DreamCliLoggableSpinner.js +0 -31
- package/dist/cjs/src/cli/logger/loggable/spinners.js +0 -1185
- package/dist/esm/src/cli/logger/helpers/createSpinner.js +0 -11
- package/dist/esm/src/cli/logger/loggable/DreamCliLoggableSpinner.js +0 -28
- package/dist/esm/src/cli/logger/loggable/spinners.js +0 -1183
- package/dist/types/src/cli/logger/helpers/createSpinner.d.ts +0 -2
- package/dist/types/src/cli/logger/loggable/DreamCliLoggableSpinner.d.ts +0 -21
- package/dist/types/src/cli/logger/loggable/spinners.d.ts +0 -355
|
@@ -13,12 +13,12 @@ import { isSerializable } from './shared.js';
|
|
|
13
13
|
*
|
|
14
14
|
* ```ts
|
|
15
15
|
* class User extends ApplicationModel {
|
|
16
|
-
* @
|
|
16
|
+
* @deco.HasOne('Settings')
|
|
17
17
|
* public settings: Settings
|
|
18
18
|
* }
|
|
19
19
|
*
|
|
20
20
|
* class Settings extends ApplicationModel {
|
|
21
|
-
* @
|
|
21
|
+
* @deco.BelongsTo('User')
|
|
22
22
|
* public user: User
|
|
23
23
|
* }
|
|
24
24
|
*
|
|
@@ -108,9 +108,9 @@ export default class Dream {
|
|
|
108
108
|
* @internal
|
|
109
109
|
*
|
|
110
110
|
* Model storage for association metadata, set when using the association decorators like:
|
|
111
|
-
* @
|
|
112
|
-
* @
|
|
113
|
-
* @
|
|
111
|
+
* @deco.HasOne
|
|
112
|
+
* @deco.HasMany
|
|
113
|
+
* @deco.BelongsTo
|
|
114
114
|
*/
|
|
115
115
|
protected static associationMetadataByType: AssociationStatementsMap;
|
|
116
116
|
/**
|
|
@@ -929,7 +929,7 @@ export default class Dream {
|
|
|
929
929
|
*
|
|
930
930
|
* ```ts
|
|
931
931
|
* class Post extends ApplicationModel {
|
|
932
|
-
* @
|
|
932
|
+
* @deco.Sortable({ scope: ['user']})
|
|
933
933
|
* public position: DreamColumn<User, 'position'>
|
|
934
934
|
* }
|
|
935
935
|
*
|
|
@@ -952,7 +952,7 @@ export default class Dream {
|
|
|
952
952
|
*
|
|
953
953
|
* ```ts
|
|
954
954
|
* class User extends ApplicationModel {
|
|
955
|
-
* @
|
|
955
|
+
* @deco.Scope()
|
|
956
956
|
* public visible(query: Query<User>) {
|
|
957
957
|
* return query.where({ hidden: false })
|
|
958
958
|
* }
|
|
@@ -1047,10 +1047,10 @@ export default class Dream {
|
|
|
1047
1047
|
*
|
|
1048
1048
|
* ```ts
|
|
1049
1049
|
* class Post {
|
|
1050
|
-
* @
|
|
1050
|
+
* @deco.HasMany('LocalizedText')
|
|
1051
1051
|
* public localizedTexts: LocalizedText[]
|
|
1052
1052
|
*
|
|
1053
|
-
* @
|
|
1053
|
+
* @deco.HasOne('LocalizedText', {
|
|
1054
1054
|
* where: { locale: DreamConst.passthrough },
|
|
1055
1055
|
* })
|
|
1056
1056
|
* public currentLocalizedText: LocalizedText
|
|
@@ -1351,7 +1351,7 @@ export default class Dream {
|
|
|
1351
1351
|
*
|
|
1352
1352
|
* ```ts
|
|
1353
1353
|
* class User extends ApplicationModel {
|
|
1354
|
-
* @
|
|
1354
|
+
* @deco.Validates('presence')
|
|
1355
1355
|
* public email: DreamColumn<User, 'email'>
|
|
1356
1356
|
* }
|
|
1357
1357
|
* const user = User.new()
|
|
@@ -1393,7 +1393,7 @@ export default class Dream {
|
|
|
1393
1393
|
*
|
|
1394
1394
|
* ```ts
|
|
1395
1395
|
* class User extends ApplicationModel {
|
|
1396
|
-
* @
|
|
1396
|
+
* @deco.Validates('presence')
|
|
1397
1397
|
* public email: DreamColumn<User, 'email'>
|
|
1398
1398
|
* }
|
|
1399
1399
|
*
|
|
@@ -1591,7 +1591,7 @@ export default class Dream {
|
|
|
1591
1591
|
* ```ts
|
|
1592
1592
|
* class User extends ApplicationModel {
|
|
1593
1593
|
* ...
|
|
1594
|
-
* @
|
|
1594
|
+
* @deco.Validate()
|
|
1595
1595
|
* public async validateName() {
|
|
1596
1596
|
* if (typeof this.name === 'number')
|
|
1597
1597
|
* this.addError('name', 'name cannot be a number')
|
|
@@ -1948,10 +1948,10 @@ export default class Dream {
|
|
|
1948
1948
|
*
|
|
1949
1949
|
* ```ts
|
|
1950
1950
|
* class Post {
|
|
1951
|
-
* @
|
|
1951
|
+
* @deco.HasMany('LocalizedText')
|
|
1952
1952
|
* public localizedTexts: LocalizedText[]
|
|
1953
1953
|
*
|
|
1954
|
-
* @
|
|
1954
|
+
* @deco.HasOne('LocalizedText', {
|
|
1955
1955
|
* where: { locale: DreamConst.passthrough },
|
|
1956
1956
|
* })
|
|
1957
1957
|
* public currentLocalizedText: LocalizedText
|
|
@@ -2217,7 +2217,7 @@ export default class Dream {
|
|
|
2217
2217
|
*
|
|
2218
2218
|
* ```ts
|
|
2219
2219
|
* class User extends ApplicationModel {
|
|
2220
|
-
* @
|
|
2220
|
+
* @deco.BeforeDestroy()
|
|
2221
2221
|
* public softDelete() {
|
|
2222
2222
|
* await this.update({ deletedAt: DateTime.now() })
|
|
2223
2223
|
* this.preventDeletion()
|
|
@@ -2236,13 +2236,13 @@ export default class Dream {
|
|
|
2236
2236
|
*
|
|
2237
2237
|
* ```ts
|
|
2238
2238
|
* class User extends ApplicationModel {
|
|
2239
|
-
* @
|
|
2239
|
+
* @deco.BeforeDestroy()
|
|
2240
2240
|
* public async softDelete() {
|
|
2241
2241
|
* await this.update({ deletedAt: DateTime.now() })
|
|
2242
2242
|
* this.preventDeletion()
|
|
2243
2243
|
* }
|
|
2244
2244
|
*
|
|
2245
|
-
* @
|
|
2245
|
+
* @deco.BeforeDestroy()
|
|
2246
2246
|
* public async undoSoftDelete() {
|
|
2247
2247
|
* await this.update({ deletedAt: null })
|
|
2248
2248
|
* this.unpreventDeletion()
|
|
@@ -1,11 +1,7 @@
|
|
|
1
1
|
import { DreamCliLoggerLogOpts } from '../../types/logger.js';
|
|
2
|
-
import DreamCliLoggableSpinner from './loggable/DreamCliLoggableSpinner.js';
|
|
3
|
-
import DreamCliLoggableText from './loggable/DreamCliLoggableText.js';
|
|
4
2
|
export default class DreamCliLogger {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
purge(): void;
|
|
10
|
-
private clear;
|
|
3
|
+
log(text: string, { logPrefix, logPrefixColor, logPrefixBgColor }?: DreamCliLoggerLogOpts): void;
|
|
4
|
+
logStartProgress(text: string, { logPrefix, logPrefixColor, logPrefixBgColor }?: DreamCliLoggerLogOpts): void;
|
|
5
|
+
logContinueProgress(text: string, { logPrefix, logPrefixColor, logPrefixBgColor }?: DreamCliLoggerLogOpts): void;
|
|
6
|
+
logEndProgress(text?: string, { logPrefix, logPrefixColor, logPrefixBgColor }?: DreamCliLoggerLogOpts): void;
|
|
11
7
|
}
|
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
import { DreamCliBgColor, DreamCliForegroundColor } from '../../../types/logger.js';
|
|
2
2
|
export default class DreamCliLoggable {
|
|
3
|
-
permanent: boolean;
|
|
4
3
|
logPrefix: string;
|
|
5
4
|
logPrefixColor: DreamCliForegroundColor | undefined;
|
|
6
5
|
logPrefixBgColor: DreamCliBgColor | undefined;
|
|
7
|
-
constructor({
|
|
8
|
-
permanent: boolean;
|
|
6
|
+
constructor({ logPrefix, logPrefixColor, logPrefixBgColor, }: {
|
|
9
7
|
logPrefix?: string;
|
|
10
8
|
logPrefixColor?: DreamCliForegroundColor;
|
|
11
9
|
logPrefixBgColor?: DreamCliBgColor;
|
|
@@ -4,8 +4,7 @@ export default class DreamCliLoggableText extends DreamCliLoggable {
|
|
|
4
4
|
private text;
|
|
5
5
|
private color;
|
|
6
6
|
private bgColor;
|
|
7
|
-
constructor(text: string, {
|
|
8
|
-
permanent: boolean;
|
|
7
|
+
constructor(text: string, { logPrefix, color, bgColor, logPrefixColor, logPrefixBgColor, }: {
|
|
9
8
|
logPrefix?: string;
|
|
10
9
|
color?: DreamCliForegroundColor;
|
|
11
10
|
bgColor?: DreamCliBgColor;
|
|
@@ -22,14 +22,14 @@ export default class Decorators<T extends Dream> {
|
|
|
22
22
|
*
|
|
23
23
|
* ```ts
|
|
24
24
|
* class User {
|
|
25
|
-
* @
|
|
25
|
+
* @deco.Encrypted()
|
|
26
26
|
* // automatically sets `encryptedSsn` to the encrypted value that
|
|
27
27
|
* // `ssn` is set to in new/create/update, e.g., `await user.update({ ssn })`
|
|
28
28
|
* public ssn: string
|
|
29
29
|
*
|
|
30
30
|
* // automatically sets `myEncryptedPhone` to the encrypted value that
|
|
31
31
|
* // `phone` is set to new/create/update, e.g., `await user.update({ phone })`
|
|
32
|
-
* @
|
|
32
|
+
* @deco.Encrypted('myEncryptedPhone)
|
|
33
33
|
* public phone: string
|
|
34
34
|
* }
|
|
35
35
|
* ```
|
|
@@ -44,7 +44,7 @@ export default class Decorators<T extends Dream> {
|
|
|
44
44
|
*
|
|
45
45
|
* ```ts
|
|
46
46
|
* class Collar {
|
|
47
|
-
* @
|
|
47
|
+
* @deco.Scope({ default: true })
|
|
48
48
|
* public static hideHiddenCollars(query: Query<Collar>) {
|
|
49
49
|
* return query.where({ hidden: false })
|
|
50
50
|
* }
|
|
@@ -66,7 +66,7 @@ export default class Decorators<T extends Dream> {
|
|
|
66
66
|
*
|
|
67
67
|
* ```ts
|
|
68
68
|
* class Balloon {
|
|
69
|
-
* @
|
|
69
|
+
* @deco.Sortable({ scope: 'user' })
|
|
70
70
|
* public position: DreamColumn<Balloon, 'position'>
|
|
71
71
|
* }
|
|
72
72
|
* ```
|
|
@@ -82,7 +82,7 @@ export default class Decorators<T extends Dream> {
|
|
|
82
82
|
*
|
|
83
83
|
* ```ts
|
|
84
84
|
* class Sandbag {
|
|
85
|
-
* @
|
|
85
|
+
* @deco.Validate()
|
|
86
86
|
* public validateWeight(this: Sandbag) {
|
|
87
87
|
* if (!this.weight) return
|
|
88
88
|
*
|
|
@@ -105,7 +105,7 @@ export default class Decorators<T extends Dream> {
|
|
|
105
105
|
*
|
|
106
106
|
* ```ts
|
|
107
107
|
* class Balloon {
|
|
108
|
-
* @
|
|
108
|
+
* @deco.Validates('numericality', { min: 0, max: 100 })
|
|
109
109
|
* public volume: DreamColumn<Balloon, 'volume'>
|
|
110
110
|
* }
|
|
111
111
|
* ```
|
|
@@ -143,7 +143,7 @@ export default class Decorators<T extends Dream> {
|
|
|
143
143
|
*
|
|
144
144
|
* ```ts
|
|
145
145
|
* class BodyMeasurement {
|
|
146
|
-
* @
|
|
146
|
+
* @deco.Virtual()
|
|
147
147
|
* public get lbs() {
|
|
148
148
|
* const self: User = this
|
|
149
149
|
* return gramsToLbs(self.getAttribute('grams') ?? 0)
|
|
@@ -154,7 +154,7 @@ export default class Decorators<T extends Dream> {
|
|
|
154
154
|
* self.setAttribute('grams', lbsToGrams(lbs))
|
|
155
155
|
* }
|
|
156
156
|
*
|
|
157
|
-
* @
|
|
157
|
+
* @deco.Virtual()
|
|
158
158
|
* public get kilograms() {
|
|
159
159
|
* const self: User = this
|
|
160
160
|
* return gramsToKilograms(self.getAttribute('grams') ?? 0)
|
|
@@ -170,10 +170,10 @@ export default class Decorators<T extends Dream> {
|
|
|
170
170
|
*
|
|
171
171
|
* ```ts
|
|
172
172
|
* class User {
|
|
173
|
-
* @
|
|
173
|
+
* @deco.Virtual()
|
|
174
174
|
* public password: string
|
|
175
175
|
*
|
|
176
|
-
* @
|
|
176
|
+
* @deco.BeforeSave()
|
|
177
177
|
* public hasPassword() {
|
|
178
178
|
* this.setAttribute('hashedPassword', preferredHashingAlgorithm(this.password))
|
|
179
179
|
* }
|
|
@@ -188,7 +188,7 @@ export default class Decorators<T extends Dream> {
|
|
|
188
188
|
*
|
|
189
189
|
* ```ts
|
|
190
190
|
* class User {
|
|
191
|
-
* @
|
|
191
|
+
* @deco.BeforeCreate()
|
|
192
192
|
* public doSomething() {
|
|
193
193
|
* console.log('hi!')
|
|
194
194
|
* }
|
|
@@ -204,7 +204,7 @@ export default class Decorators<T extends Dream> {
|
|
|
204
204
|
*
|
|
205
205
|
* ```ts
|
|
206
206
|
* class User {
|
|
207
|
-
* @
|
|
207
|
+
* @deco.BeforeSave()
|
|
208
208
|
* public doSomething() {
|
|
209
209
|
* console.log('hi!')
|
|
210
210
|
* }
|
|
@@ -220,7 +220,7 @@ export default class Decorators<T extends Dream> {
|
|
|
220
220
|
*
|
|
221
221
|
* ```ts
|
|
222
222
|
* class User {
|
|
223
|
-
* @
|
|
223
|
+
* @deco.BeforeUpdate()
|
|
224
224
|
* public doSomething() {
|
|
225
225
|
* console.log('hi!')
|
|
226
226
|
* }
|
|
@@ -236,7 +236,7 @@ export default class Decorators<T extends Dream> {
|
|
|
236
236
|
*
|
|
237
237
|
* ```ts
|
|
238
238
|
* class User {
|
|
239
|
-
* @
|
|
239
|
+
* @deco.BeforeDestroy()
|
|
240
240
|
* public doSomething() {
|
|
241
241
|
* console.log('hi!')
|
|
242
242
|
* }
|
|
@@ -251,7 +251,7 @@ export default class Decorators<T extends Dream> {
|
|
|
251
251
|
*
|
|
252
252
|
* ```ts
|
|
253
253
|
* class User {
|
|
254
|
-
* @
|
|
254
|
+
* @deco.AfterCreate()
|
|
255
255
|
* public doSomething() {
|
|
256
256
|
* console.log('hi!')
|
|
257
257
|
* }
|
|
@@ -267,7 +267,7 @@ export default class Decorators<T extends Dream> {
|
|
|
267
267
|
*
|
|
268
268
|
* ```ts
|
|
269
269
|
* class User {
|
|
270
|
-
* @
|
|
270
|
+
* @deco.AfterCreateCommit()
|
|
271
271
|
* public doSomething() {
|
|
272
272
|
* console.log('hi!')
|
|
273
273
|
* }
|
|
@@ -282,7 +282,7 @@ export default class Decorators<T extends Dream> {
|
|
|
282
282
|
*
|
|
283
283
|
* ```ts
|
|
284
284
|
* class User {
|
|
285
|
-
* @
|
|
285
|
+
* @deco.AfterSave()
|
|
286
286
|
* public doSomething() {
|
|
287
287
|
* console.log('hi!')
|
|
288
288
|
* }
|
|
@@ -298,7 +298,7 @@ export default class Decorators<T extends Dream> {
|
|
|
298
298
|
*
|
|
299
299
|
* ```ts
|
|
300
300
|
* class User {
|
|
301
|
-
* @
|
|
301
|
+
* @deco.AfterSaveCommit()
|
|
302
302
|
* public doSomething() {
|
|
303
303
|
* console.log('hi!')
|
|
304
304
|
* }
|
|
@@ -314,7 +314,7 @@ export default class Decorators<T extends Dream> {
|
|
|
314
314
|
*
|
|
315
315
|
* ```ts
|
|
316
316
|
* class User {
|
|
317
|
-
* @
|
|
317
|
+
* @deco.AfterUpdate()
|
|
318
318
|
* public doSomething() {
|
|
319
319
|
* console.log('hi!')
|
|
320
320
|
* }
|
|
@@ -330,7 +330,7 @@ export default class Decorators<T extends Dream> {
|
|
|
330
330
|
*
|
|
331
331
|
* ```ts
|
|
332
332
|
* class User {
|
|
333
|
-
* @
|
|
333
|
+
* @deco.AfterUpdateCommit()
|
|
334
334
|
* public doSomething() {
|
|
335
335
|
* console.log('hi!')
|
|
336
336
|
* }
|
|
@@ -346,7 +346,7 @@ export default class Decorators<T extends Dream> {
|
|
|
346
346
|
*
|
|
347
347
|
* ```ts
|
|
348
348
|
* class User {
|
|
349
|
-
* @
|
|
349
|
+
* @deco.AfterDestroy()
|
|
350
350
|
* public doSomething() {
|
|
351
351
|
* console.log('hi!')
|
|
352
352
|
* }
|
|
@@ -362,7 +362,7 @@ export default class Decorators<T extends Dream> {
|
|
|
362
362
|
*
|
|
363
363
|
* ```ts
|
|
364
364
|
* class User {
|
|
365
|
-
* @
|
|
365
|
+
* @deco.AfterDestroyCommit()
|
|
366
366
|
* public doSomething() {
|
|
367
367
|
* console.log('hi!')
|
|
368
368
|
* }
|
|
@@ -483,10 +483,10 @@ export default class DreamClassTransactionBuilder<DreamInstance extends Dream> {
|
|
|
483
483
|
*
|
|
484
484
|
* ```ts
|
|
485
485
|
* class Post {
|
|
486
|
-
* @
|
|
486
|
+
* @deco.HasMany('LocalizedText')
|
|
487
487
|
* public localizedTexts: LocalizedText[]
|
|
488
488
|
*
|
|
489
|
-
* @
|
|
489
|
+
* @deco.HasOne('LocalizedText', {
|
|
490
490
|
* where: { locale: DreamConst.passthrough },
|
|
491
491
|
* })
|
|
492
492
|
* public currentLocalizedText: LocalizedText
|
|
@@ -473,10 +473,10 @@ export default class Query<DreamInstance extends Dream, QueryTypeOpts extends Re
|
|
|
473
473
|
*
|
|
474
474
|
* ```ts
|
|
475
475
|
* class Post {
|
|
476
|
-
* @
|
|
476
|
+
* @deco.HasMany('LocalizedText')
|
|
477
477
|
* public localizedTexts: LocalizedText[]
|
|
478
478
|
*
|
|
479
|
-
* @
|
|
479
|
+
* @deco.HasOne('LocalizedText', {
|
|
480
480
|
* on: { locale: DreamConst.passthrough },
|
|
481
481
|
* })
|
|
482
482
|
* public currentLocalizedText: LocalizedText
|
|
@@ -1,2 +1,6 @@
|
|
|
1
|
-
export default function sspawn(command: string, opts?:
|
|
2
|
-
|
|
1
|
+
export default function sspawn(command: string, opts?: Record<string, unknown> & {
|
|
2
|
+
onStdout?: (str: string) => void;
|
|
3
|
+
}): Promise<unknown>;
|
|
4
|
+
export declare function ssspawn(command: string, opts?: Record<string, unknown> & {
|
|
5
|
+
onStdout?: (str: string) => void;
|
|
6
|
+
}): import("child_process").ChildProcessWithoutNullStreams;
|
|
@@ -14,12 +14,12 @@ import { RendersOneOrManyOpts } from './shared.js';
|
|
|
14
14
|
*
|
|
15
15
|
* ```ts
|
|
16
16
|
* class User extends ApplicationModel {
|
|
17
|
-
* @
|
|
17
|
+
* @deco.HasOne('Settings')
|
|
18
18
|
* public settings: Settings
|
|
19
19
|
* }
|
|
20
20
|
*
|
|
21
21
|
* class Post extends ApplicationModel {
|
|
22
|
-
* @
|
|
22
|
+
* @deco.BelongsTo('User')
|
|
23
23
|
* public user: User
|
|
24
24
|
* }
|
|
25
25
|
*
|
|
@@ -14,12 +14,12 @@ import { RendersOneOrManyOpts } from './shared.js';
|
|
|
14
14
|
*
|
|
15
15
|
* ```ts
|
|
16
16
|
* class User extends ApplicationModel {
|
|
17
|
-
* @
|
|
17
|
+
* @deco.HasOne('Settings')
|
|
18
18
|
* public settings: Settings
|
|
19
19
|
* }
|
|
20
20
|
*
|
|
21
21
|
* class Settings extends ApplicationModel {
|
|
22
|
-
* @
|
|
22
|
+
* @deco.BelongsTo('User')
|
|
23
23
|
* public user: User
|
|
24
24
|
* }
|
|
25
25
|
*
|
|
@@ -1,11 +1,7 @@
|
|
|
1
|
-
export interface DreamCliLoggerLogOpts
|
|
2
|
-
permanent?: boolean
|
|
3
|
-
spinner?: IsSpinner
|
|
1
|
+
export interface DreamCliLoggerLogOpts {
|
|
4
2
|
logPrefix?: string
|
|
5
3
|
logPrefixColor?: DreamCliForegroundColor
|
|
6
4
|
logPrefixBgColor?: DreamCliBgColor
|
|
7
|
-
spinnerPrefixColor?: DreamCliForegroundColor
|
|
8
|
-
spinnerPrefixBgColor?: DreamCliBgColor
|
|
9
5
|
}
|
|
10
6
|
|
|
11
7
|
export type DreamCliColor = DreamCliForegroundColor | DreamCliBgColor
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!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/
|
|
1
|
+
<!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/019bbc437d6a4e4ce5fc75285400b80b45614494/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>
|
|
2
2
|
</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>
|
|
3
3
|
<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>
|
|
4
|
-
</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"> = 'log'</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/
|
|
4
|
+
</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"> = 'log'</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/019bbc437d6a4e4ce5fc75285400b80b45614494/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/019bbc437d6a4e4ce5fc75285400b80b45614494/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>
|