Split (1)

train · 2k rows

commit_message stringlengths 9 4.28k	sha stringlengths 40 40	type stringclasses 10 values	commit_url stringlengths 78 90	masked_commit_message stringlengths 2 4.26k	author_email stringclasses 8 values	git_diff stringlengths 129 19.1M
ci: bump alert threshold for benchmarks	e250afcbd1e1462b34d242c6811c9f53f66097ca	ci	https://github.com/rohankumardubey/ibis/commit/e250afcbd1e1462b34d242c6811c9f53f66097ca	bump alert threshold for benchmarks	[email protected]	diff --git a/ibis-docs-lint.yml b/ibis-docs-lint.yml index 3ea1172..46672f6 100644 --- a/ibis-docs-lint.yml +++ b/ibis-docs-lint.yml @@ -103,6 +103,7 @@ jobs: benchmark-data-dir-path: bench auto-push: true comment-on-alert: true + alert-threshold: "300%" docs: runs-on: ubuntu-latest
chore: short benchmarks only on ubuntu runners	a82d9ebd24e963760b046ddd2dc7d1c99b7c722c	chore	https://github.com/rohankumardubey/ibis/commit/a82d9ebd24e963760b046ddd2dc7d1c99b7c722c	short benchmarks only on ubuntu runners	[email protected]	diff --git a/ibis-main.yml b/ibis-main.yml index 582875a..c565e1e 100644 --- a/ibis-main.yml +++ b/ibis-main.yml @@ -61,7 +61,7 @@ jobs: set -euo pipefail sudo apt-get update -y -q - sudo apt-get install -y -q build-essential graphviz + sudo apt-get install -y -q build-essential graphviz krb5-config libkrb5-dev libgeos-dev - name: install ${{ matrix.os }} system dependencies if: ${{ matrix.os == 'windows-latest' }} @@ -70,14 +70,22 @@ jobs: - run: python -m pip install --upgrade pip poetry - name: install ibis + if: ${{ matrix.os == 'ubuntu-latest' }} run: poetry install --extras all + - name: install ibis + if: ${{ matrix.os == 'windows-latest' }} + run: poetry install --extras visualization + - uses: extractions/setup-just@v1 - - name: run tests - # run all the core tests (i.e., non-backend) + - name: run core tests + run: just ci-check -m core + + - name: run benchmarks once + if: ${{ matrix.os == 'ubuntu-latest' }} # run benchmarks once to make sure they aren't broken - run: just ci-check -m "'core or benchmark'" + run: just ci-check -m benchmark - name: upload code coverage if: success()
feat: revision describe can now short-cut what effectively is only a name-to-id lookup This makes situations easier where `max-candidates` is provided by the user or by configuration.	ca6651234a8c0d4718554323b197a49266b60a61	feat	https://github.com/Byron/gitoxide/commit/ca6651234a8c0d4718554323b197a49266b60a61	revision describe can now short-cut what effectively is only a name-to-id lookup This makes situations easier where `max-candidates` is provided by the user or by configuration.	[email protected]	diff --git a/describe.rs b/describe.rs index ba42a46..a16f71e 100644 --- a/describe.rs +++ b/describe.rs @@ -186,7 +186,21 @@ pub(crate) mod function { commits_seen: 0, })); } + max_candidates = max_candidates.min(MAX_CANDIDATES); + if max_candidates == 0 { + return if fallback_to_oid { + Ok(Some(Outcome { + id: commit.to_owned(), + name: None, + name_by_oid, + depth: 0, + commits_seen: 0, + })) + } else { + Ok(None) + }; + } let mut buf = Vec::new(); let mut parent_buf = Vec::new(); diff --git a/mod.rs b/mod.rs index b8638c4..ce25d1f 100644 --- a/mod.rs +++ b/mod.rs @@ -38,6 +38,28 @@ fn fallback_if_configured_in_options_but_no_candidate() -> crate::Result { .expect("fallback activated"); assert!(res.name.is_none(), "no name can be found"); assert_eq!(res.depth, 0, "just a default, not relevant as there is no name"); + assert_eq!(res.commits_seen, 8, "a traversal is performed"); + assert_eq!(res.into_format(7).to_string(), "01ec18a"); + Ok(()) +} + +#[test] +fn fallback_if_configured_in_options_and_max_candidates_zero() -> crate::Result { + let repo = repo(); + let commit = repo.head_commit()?; + let res = git_revision::describe( + &commit.id, + \|id, buf\| repo.objects.find_commit_iter(id, buf).map(Some), + describe::Options { + fallback_to_oid: true, + max_candidates: 0, + ..Default::default() + }, + )? + .expect("fallback activated"); + assert!(res.name.is_none(), "no name can be found"); + assert_eq!(res.depth, 0, "just a default, not relevant as there is no name"); + assert_eq!(res.commits_seen, 0, "we don't do any traversal"); assert_eq!(res.into_format(7).to_string(), "01ec18a"); Ok(()) }
docs: improve jsdoc for relation decorators	9e1818158feed9994ea1d0cd20c0d22e641e00e2	docs	https://github.com/mikro-orm/mikro-orm/commit/9e1818158feed9994ea1d0cd20c0d22e641e00e2	improve jsdoc for relation decorators	[email protected]	diff --git a/ManyToMany.ts b/ManyToMany.ts index a34d65e..0f9c68c 100644 --- a/ManyToMany.ts +++ b/ManyToMany.ts @@ -21,21 +21,54 @@ export function ManyToMany<T extends object, O>( } export interface ManyToManyOptions<Owner, Target> extends ReferenceOptions<Owner, Target> { + /** Set this side as owning. Owning side is where the foreign key is defined. This option is not required if you use `inversedBy` or `mappedBy` to distinguish owning and inverse side. / owner?: boolean; + + /* Point to the inverse side property name. / inversedBy?: (string & keyof Target) \| ((e: Target) => any); + + /* Point to the owning side property name. / mappedBy?: (string & keyof Target) \| ((e: Target) => any); + + /* Condition for {@doclink collections#declarative-partial-loading \| Declarative partial loading}. / where?: FilterQuery<Target>; + + /* Set default ordering. / orderBy?: QueryOrderMap<Target> \| QueryOrderMap<Target>[]; + + /* Force stable insertion order of items in the collection (see {@doclink collections \| Collections}). / fixedOrder?: boolean; + + /* Override default order column name (`id`) for fixed ordering. / fixedOrderColumn?: string; + + /* Override default name for pivot table (see {@doclink naming-strategy \| Naming Strategy}). / pivotTable?: string; + + /* Set pivot entity for this relation (see {@doclink collections#custom-pivot-table-entity \| Custom pivot table entity}). / pivotEntity?: string \| (() => EntityName<any>); + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / joinColumn?: string; + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / joinColumns?: string[]; + + /* Override the default database column name on the inverse side (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / inverseJoinColumn?: string; + + /* Override the default database column name on the inverse side (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / inverseJoinColumns?: string[]; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / referenceColumnName?: string; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / referencedColumnNames?: string[]; + + /* What to do when the target entity gets deleted. / deleteRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; + + /* What to do when the reference to the target entity gets updated. / updateRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; } diff --git a/ManyToOne.ts b/ManyToOne.ts index f7fa060..8b5a319 100644 --- a/ManyToOne.ts +++ b/ManyToOne.ts @@ -20,15 +20,36 @@ export function ManyToOne<T extends object, O>( } export interface ManyToOneOptions<Owner, Target> extends ReferenceOptions<Owner, Target> { + /* Point to the inverse side property name. / inversedBy?: (string & keyof Target) \| ((e: Target) => any); + + /* Wrap the entity in {@apilink Reference} wrapper. / ref?: boolean; + + /* Use this relation as a primary key. / primary?: boolean; + + /* Map this relation to the primary key value instead of an entity. / mapToPk?: boolean; + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / joinColumn?: string; + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / joinColumns?: string[]; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / referenceColumnName?: string; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / referencedColumnNames?: string[]; + + /* What to do when the target entity gets deleted. / deleteRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; + + /* What to do when the reference to the target entity gets updated. / updateRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; + + /* Set the constraint type. Immediate constraints are checked for each statement, while deferred ones are only checked at the end of the transaction. Only for postgres unique constraints. / deferMode?: DeferMode \| `${DeferMode}`; } diff --git a/OneToMany.ts b/OneToMany.ts index 4f29b4b..e35c1bb 100644 --- a/OneToMany.ts +++ b/OneToMany.ts @@ -37,15 +37,34 @@ export function OneToMany<Target, Owner>( return createOneToDecorator(entity, mappedBy, options, ReferenceKind.ONE_TO_MANY); } -export type OneToManyOptions<Owner, Target> = ReferenceOptions<Owner, Target> & { - entity?: string \| (() => EntityName<Target>); +export interface OneToManyOptions<Owner, Target> extends ReferenceOptions<Owner, Target> { + /* Remove the entity when it gets disconnected from the relationship (see {@doclink cascading \| Cascading}). / orphanRemoval?: boolean; + + /* Set default ordering. / orderBy?: QueryOrderMap<Target> \| QueryOrderMap<Target>[]; + + /* Condition for {@doclink collections#declarative-partial-loading \| Declarative partial loading}. / where?: FilterQuery<Target>; + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / joinColumn?: string; + + /* Override the default database column name on the owning side (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / joinColumns?: string[]; + + /* Override the default database column name on the inverse side (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / inverseJoinColumn?: string; + + /* Override the default database column name on the inverse side (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / inverseJoinColumns?: string[]; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is only for simple properties represented by a single column. / referenceColumnName?: string; + + /* Override the default database column name on the target entity (see {@doclink naming-strategy \| Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. / + referencedColumnNames?: string[]; + + /* Point to the owning side property name. / mappedBy: (string & keyof Target) \| ((e: Target) => any); -}; +} diff --git a/OneToOne.ts b/OneToOne.ts index 4995525..c62dfaf 100644 --- a/OneToOne.ts +++ b/OneToOne.ts @@ -13,12 +13,27 @@ export function OneToOne<Target, Owner>( } export interface OneToOneOptions<Owner, Target> extends Partial<Omit<OneToManyOptions<Owner, Target>, 'orderBy'>> { + /* Set this side as owning. Owning side is where the foreign key is defined. This option is not required if you use `inversedBy` or `mappedBy` to distinguish owning and inverse side. / owner?: boolean; + + /* Point to the inverse side property name. / inversedBy?: (string & keyof Target) \| ((e: Target) => any); + + /* Wrap the entity in {@apilink Reference} wrapper. / ref?: boolean; + + /* Use this relation as a primary key. / primary?: boolean; + + /* Map this relation to the primary key value instead of an entity. / mapToPk?: boolean; + + /* What to do when the target entity gets deleted. / deleteRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; + + /* What to do when the reference to the target entity gets updated. / updateRule?: 'cascade' \| 'no action' \| 'set null' \| 'set default' \| AnyString; + + /* Set the constraint type. Immediate constraints are checked for each statement, while deferred ones are only checked at the end of the transaction. Only for postgres unique constraints. / deferMode?: DeferMode \| `${DeferMode}`; } diff --git a/Property.ts b/Property.ts index fb9757d..f29dde0 100644 --- a/Property.ts +++ b/Property.ts @@ -49,7 +49,7 @@ export function Property<T extends object>(options: PropertyOptions<T> = {}) { }; } -export type PropertyOptions<Owner> = { +export interface PropertyOptions<Owner> { /* * Alias for `fieldName`. / @@ -260,13 +260,20 @@ export type PropertyOptions<Owner> = { @see https://mikro-orm.io/docs/defining-entities#sql-generated-columns / ignoreSchemaChanges?: ('type' \| 'extra' \| 'default')[]; -}; +} export interface ReferenceOptions<Owner, Target> extends PropertyOptions<Owner> { + /* Set target entity type. / entity?: string \| (() => EntityName<Target>); + + /* Set what actions on owning entity should be cascaded to the relationship. Defaults to [Cascade.PERSIST, Cascade.MERGE] (see {@doclink cascading}). / cascade?: Cascade[]; + + /* Always load the relationship. Discouraged for use with to-many relations for performance reasons. / eager?: boolean; - strategy?: LoadStrategy; + + /* Override the default loading strategy for this property. This option has precedence over the global `loadStrategy`, but can be overridden by `FindOptions.strategy`. / + strategy?: LoadStrategy \| `${LoadStrategy}`; } /*
fix(ts): avoid exposing internal symbol in declared type	a43393ddc0b01d46a8a0c413a07bdec237d3cc25	fix	https://github.com/pmndrs/react-spring/commit/a43393ddc0b01d46a8a0c413a07bdec237d3cc25	avoid exposing internal symbol in declared type	[email protected]	diff --git a/withAnimated.tsx b/withAnimated.tsx index 7b8d9f0..fc60e96 100644 --- a/withAnimated.tsx +++ b/withAnimated.tsx @@ -6,9 +6,7 @@ import * as G from 'shared/globals' // For storing the animated version on the original component const cacheKey = Symbol.for('AnimatedComponent') -type AnimatableComponent = - \| string - \| (Extract<ElementType, object> & { [cacheKey]?: any }) +type AnimatableComponent = string \| Exclude<ElementType, string> // A stub type that gets replaced by @react-spring/web and others. type WithAnimated = { @@ -16,7 +14,7 @@ type WithAnimated = { [key: string]: any } -export const withAnimated: WithAnimated = Component => +export const withAnimated: WithAnimated = (Component: any) => is.str(Component) ? createAnimatedComponent(Component) : Component[cacheKey] \|\|
chore(release): published new version	fa3e7c1523d53be7a9715ae638bdc1fed3b732d4	chore	https://github.com/tsparticles/tsparticles/commit/fa3e7c1523d53be7a9715ae638bdc1fed3b732d4	published new version	[email protected]	diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d8862a..1fb9b82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [3.0.2](https://github.com/tsparticles/tsparticles/compare/v3.0.1...v3.0.2) (2023-12-06) + +Note: Version bump only for package @tsparticles/tests + ## [3.0.1](https://github.com/tsparticles/tsparticles/compare/v3.0.0...v3.0.1) (2023-12-06) Note: Version bump only for package @tsparticles/tests diff --git a/package.dist.json b/package.dist.json index 89d54f1..95c6112 100644 --- a/package.dist.json +++ b/package.dist.json @@ -1,6 +1,6 @@ { "name": "@tsparticles/simplex-noise", - "version": "3.0.1", + "version": "3.0.2", "description": "tsParticles simplex noise library", "homepage": "https://particles.js.org", "repository": { diff --git a/package.json b/package.json index de0fbaa..7775a6a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@tsparticles/tests", "private": true, - "version": "3.0.1", + "version": "3.0.2", "scripts": { "prettify:ci": "prettier --check ./src", "prettify": "prettier --write ./src", @@ -12,6 +12,6 @@ "test": "nyc mocha" }, "dependencies": { - "@tsparticles/engine": "^3.0.1" + "@tsparticles/engine": "^3.0.2" } } diff --git a/lerna.json b/lerna.json index 0928294..f29d5ce 100644 --- a/lerna.json +++ b/lerna.json @@ -18,7 +18,7 @@ "utils/", "websites/" ], - "version": "3.0.1", + "version": "3.0.2", "npmClient": "pnpm", "conventionalCommits": true, "command": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c6b9cdc..0f4e203 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,62 +1,61 @@ -lockfileVersion: '6.0' +lockfileVersion: "6.0" settings: autoInstallPeers: true excludeLinksFromLockfile: false importers: - .: devDependencies: - '@babel/core': + "@babel/core": specifier: ^7.23.5 version: 7.23.5 - '@commitlint/cli': + "@commitlint/cli": specifier: ^18.4.3 version: 18.4.3([email protected]) - '@commitlint/config-conventional': + "@commitlint/config-conventional": specifier: ^18.4.3 version: 18.4.3 - '@istanbuljs/nyc-config-typescript': + "@istanbuljs/nyc-config-typescript": specifier: ^1.0.2 version: 1.0.2([email protected]) - '@nx/workspace': + "@nx/workspace": specifier: ^17.1.3 version: 17.1.3 - '@tsparticles/cli': + "@tsparticles/cli": specifier: ^2.0.0 version: 2.0.0([email protected]) - '@tsparticles/eslint-config': + "@tsparticles/eslint-config": specifier: ^2.0.0 version: 2.0.0 - '@tsparticles/prettier-config': + "@tsparticles/prettier-config": specifier: ^2.0.0 version: 2.0.0 - '@tsparticles/tsconfig': + "@tsparticles/tsconfig": specifier: ^2.0.0 version: 2.0.0 - '@tsparticles/webpack-plugin': + "@tsparticles/webpack-plugin": specifier: ^2.0.0 version: 2.0.0 - '@types/chai': + "@types/chai": specifier: ^4.3.11 version: 4.3.11 - '@types/jsdom': + "@types/jsdom": specifier: ^21.1.6 version: 21.1.6 - '@types/mocha': + "@types/mocha": specifier: ^10.0.6 version: 10.0.6 - '@types/node': + "@types/node": specifier: ^20.10.3 version: 20.10.3 - '@types/webpack-env': + "@types/webpack-env": specifier: ^1.18.4 version: 1.18.4 - '@typescript-eslint/eslint-plugin': + "@typescript-eslint/eslint-plugin": specifier: ^6.13.1 version: 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': + "@typescript-eslint/parser": specifier: ^6.13.1 version: 6.13.1([email protected])([email protected]) babel-loader: @@ -176,414 +175,414 @@ importers: bundles/all: dependencies: - '@tsparticles/effect-bubble': - specifier: ^3.0.1 + "@tsparticles/effect-bubble": + specifier: ^3.0.2 version: link:../../effects/bubble/dist - '@tsparticles/effect-trail': - specifier: ^3.0.1 + "@tsparticles/effect-trail": + specifier: ^3.0.2 version: link:../../effects/trail/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/interaction-external-pop': - specifier: ^3.0.1 + "@tsparticles/interaction-external-pop": + specifier: ^3.0.2 version: link:../../interactions/external/pop/dist - '@tsparticles/interaction-light': - specifier: ^3.0.1 + "@tsparticles/interaction-light": + specifier: ^3.0.2 version: link:../../interactions/light/dist - '@tsparticles/interaction-particles-repulse': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-repulse": + specifier: ^3.0.2 version: link:../../interactions/particles/repulse/dist - '@tsparticles/path-curl-noise': - specifier: ^3.0.1 + "@tsparticles/path-curl-noise": + specifier: ^3.0.2 version: link:../../paths/curlNoise/dist - '@tsparticles/path-curves': - specifier: ^3.0.1 + "@tsparticles/path-curves": + specifier: ^3.0.2 version: link:../../paths/curves/dist - '@tsparticles/path-perlin-noise': - specifier: ^3.0.1 + "@tsparticles/path-perlin-noise": + specifier: ^3.0.2 version: link:../../paths/perlinNoise/dist - '@tsparticles/path-polygon': - specifier: ^3.0.1 + "@tsparticles/path-polygon": + specifier: ^3.0.2 version: link:../../paths/polygon/dist - '@tsparticles/path-simplex-noise': - specifier: ^3.0.1 + "@tsparticles/path-simplex-noise": + specifier: ^3.0.2 version: link:../../paths/simplexNoise/dist - '@tsparticles/path-svg': - specifier: ^3.0.1 + "@tsparticles/path-svg": + specifier: ^3.0.2 version: link:../../paths/svg/dist - '@tsparticles/pjs': - specifier: ^3.0.1 + "@tsparticles/pjs": + specifier: ^3.0.2 version: link:../pjs/dist - '@tsparticles/plugin-canvas-mask': - specifier: ^3.0.1 + "@tsparticles/plugin-canvas-mask": + specifier: ^3.0.2 version: link:../../plugins/canvasMask/dist - '@tsparticles/plugin-easing-back': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-back": + specifier: ^3.0.2 version: link:../../plugins/easings/back/dist - '@tsparticles/plugin-easing-circ': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-circ": + specifier: ^3.0.2 version: link:../../plugins/easings/circ/dist - '@tsparticles/plugin-easing-cubic': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-cubic": + specifier: ^3.0.2 version: link:../../plugins/easings/cubic/dist - '@tsparticles/plugin-easing-expo': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-expo": + specifier: ^3.0.2 version: link:../../plugins/easings/expo/dist - '@tsparticles/plugin-easing-linear': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-linear": + specifier: ^3.0.2 version: link:../../plugins/easings/linear/dist - '@tsparticles/plugin-easing-quart': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quart": + specifier: ^3.0.2 version: link:../../plugins/easings/quart/dist - '@tsparticles/plugin-easing-quint': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quint": + specifier: ^3.0.2 version: link:../../plugins/easings/quint/dist - '@tsparticles/plugin-easing-sine': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-sine": + specifier: ^3.0.2 version: link:../../plugins/easings/sine/dist - '@tsparticles/plugin-emitters-shape-canvas': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-canvas": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/canvas/dist - '@tsparticles/plugin-emitters-shape-path': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-path": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/path/dist - '@tsparticles/plugin-emitters-shape-polygon': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-polygon": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/polygon/dist - '@tsparticles/plugin-export-image': - specifier: ^3.0.1 + "@tsparticles/plugin-export-image": + specifier: ^3.0.2 version: link:../../plugins/exports/image/dist - '@tsparticles/plugin-export-json': - specifier: ^3.0.1 + "@tsparticles/plugin-export-json": + specifier: ^3.0.2 version: link:../../plugins/exports/json/dist - '@tsparticles/plugin-export-video': - specifier: ^3.0.1 + "@tsparticles/plugin-export-video": + specifier: ^3.0.2 version: link:../../plugins/exports/video/dist - '@tsparticles/plugin-hsv-color': - specifier: ^3.0.1 + "@tsparticles/plugin-hsv-color": + specifier: ^3.0.2 version: link:../../plugins/hsvColor/dist - '@tsparticles/plugin-infection': - specifier: ^3.0.1 + "@tsparticles/plugin-infection": + specifier: ^3.0.2 version: link:../../plugins/infection/dist - '@tsparticles/plugin-motion': - specifier: ^3.0.1 + "@tsparticles/plugin-motion": + specifier: ^3.0.2 version: link:../../plugins/motion/dist - '@tsparticles/plugin-polygon-mask': - specifier: ^3.0.1 + "@tsparticles/plugin-polygon-mask": + specifier: ^3.0.2 version: link:../../plugins/polygonMask/dist - '@tsparticles/plugin-sounds': - specifier: ^3.0.1 + "@tsparticles/plugin-sounds": + specifier: ^3.0.2 version: link:../../plugins/sounds/dist - '@tsparticles/shape-arrow': - specifier: ^3.0.1 + "@tsparticles/shape-arrow": + specifier: ^3.0.2 version: link:../../shapes/arrow/dist - '@tsparticles/shape-cards': - specifier: ^3.0.1 + "@tsparticles/shape-cards": + specifier: ^3.0.2 version: link:../../shapes/cards/dist - '@tsparticles/shape-cog': - specifier: ^3.0.1 + "@tsparticles/shape-cog": + specifier: ^3.0.2 version: link:../../shapes/cog/dist - '@tsparticles/shape-heart': - specifier: ^3.0.1 + "@tsparticles/shape-heart": + specifier: ^3.0.2 version: link:../../shapes/heart/dist - '@tsparticles/shape-path': - specifier: ^3.0.1 + "@tsparticles/shape-path": + specifier: ^3.0.2 version: link:../../shapes/path/dist - '@tsparticles/shape-rounded-polygon': - specifier: ^3.0.1 + "@tsparticles/shape-rounded-polygon": + specifier: ^3.0.2 version: link:../../shapes/rounded-polygon/dist - '@tsparticles/shape-rounded-rect': - specifier: ^3.0.1 + "@tsparticles/shape-rounded-rect": + specifier: ^3.0.2 version: link:../../shapes/rounded-rect/dist - '@tsparticles/shape-spiral': - specifier: ^3.0.1 + "@tsparticles/shape-spiral": + specifier: ^3.0.2 version: link:../../shapes/spiral/dist - '@tsparticles/updater-gradient': - specifier: ^3.0.1 + "@tsparticles/updater-gradient": + specifier: ^3.0.2 version: link:../../updaters/gradient/dist - '@tsparticles/updater-orbit': - specifier: ^3.0.1 + "@tsparticles/updater-orbit": + specifier: ^3.0.2 version: link:../../updaters/orbit/dist tsparticles: - specifier: ^3.0.1 + specifier: ^3.0.2 version: link:../full/dist publishDirectory: dist bundles/basic: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/move-base': - specifier: ^3.0.1 + "@tsparticles/move-base": + specifier: ^3.0.2 version: link:../../move/base/dist - '@tsparticles/shape-circle': - specifier: ^3.0.1 + "@tsparticles/shape-circle": + specifier: ^3.0.2 version: link:../../shapes/circle/dist - '@tsparticles/updater-color': - specifier: ^3.0.1 + "@tsparticles/updater-color": + specifier: ^3.0.2 version: link:../../updaters/color/dist - '@tsparticles/updater-opacity': - specifier: ^3.0.1 + "@tsparticles/updater-opacity": + specifier: ^3.0.2 version: link:../../updaters/opacity/dist - '@tsparticles/updater-out-modes': - specifier: ^3.0.1 + "@tsparticles/updater-out-modes": + specifier: ^3.0.2 version: link:../../updaters/outModes/dist - '@tsparticles/updater-size': - specifier: ^3.0.1 + "@tsparticles/updater-size": + specifier: ^3.0.2 version: link:../../updaters/size/dist publishDirectory: dist bundles/confetti: dependencies: - '@tsparticles/basic': - specifier: ^3.0.1 + "@tsparticles/basic": + specifier: ^3.0.2 version: link:../basic/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../plugins/emitters/dist - '@tsparticles/plugin-motion': - specifier: ^3.0.1 + "@tsparticles/plugin-motion": + specifier: ^3.0.2 version: link:../../plugins/motion/dist - '@tsparticles/shape-cards': - specifier: ^3.0.1 + "@tsparticles/shape-cards": + specifier: ^3.0.2 version: link:../../shapes/cards/dist - '@tsparticles/shape-emoji': - specifier: ^3.0.1 + "@tsparticles/shape-emoji": + specifier: ^3.0.2 version: link:../../shapes/emoji/dist - '@tsparticles/shape-heart': - specifier: ^3.0.1 + "@tsparticles/shape-heart": + specifier: ^3.0.2 version: link:../../shapes/heart/dist - '@tsparticles/shape-image': - specifier: ^3.0.1 + "@tsparticles/shape-image": + specifier: ^3.0.2 version: link:../../shapes/image/dist - '@tsparticles/shape-polygon': - specifier: ^3.0.1 + "@tsparticles/shape-polygon": + specifier: ^3.0.2 version: link:../../shapes/polygon/dist - '@tsparticles/shape-square': - specifier: ^3.0.1 + "@tsparticles/shape-square": + specifier: ^3.0.2 version: link:../../shapes/square/dist - '@tsparticles/shape-star': - specifier: ^3.0.1 + "@tsparticles/shape-star": + specifier: ^3.0.2 version: link:../../shapes/star/dist - '@tsparticles/updater-life': - specifier: ^3.0.1 + "@tsparticles/updater-life": + specifier: ^3.0.2 version: link:../../updaters/life/dist - '@tsparticles/updater-roll': - specifier: ^3.0.1 + "@tsparticles/updater-roll": + specifier: ^3.0.2 version: link:../../updaters/roll/dist - '@tsparticles/updater-rotate': - specifier: ^3.0.1 + "@tsparticles/updater-rotate": + specifier: ^3.0.2 version: link:../../updaters/rotate/dist - '@tsparticles/updater-tilt': - specifier: ^3.0.1 + "@tsparticles/updater-tilt": + specifier: ^3.0.2 version: link:../../updaters/tilt/dist - '@tsparticles/updater-wobble': - specifier: ^3.0.1 + "@tsparticles/updater-wobble": + specifier: ^3.0.2 version: link:../../updaters/wobble/dist publishDirectory: dist bundles/fireworks: dependencies: - '@tsparticles/basic': - specifier: ^3.0.1 + "@tsparticles/basic": + specifier: ^3.0.2 version: link:../basic/dist - '@tsparticles/effect-trail': - specifier: ^3.0.1 + "@tsparticles/effect-trail": + specifier: ^3.0.2 version: link:../../effects/trail/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../plugins/emitters/dist - '@tsparticles/plugin-emitters-shape-square': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-square": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/square/dist - '@tsparticles/plugin-sounds': - specifier: ^3.0.1 + "@tsparticles/plugin-sounds": + specifier: ^3.0.2 version: link:../../plugins/sounds/dist - '@tsparticles/shape-line': - specifier: ^3.0.1 + "@tsparticles/shape-line": + specifier: ^3.0.2 version: link:../../shapes/line/dist - '@tsparticles/updater-destroy': - specifier: ^3.0.1 + "@tsparticles/updater-destroy": + specifier: ^3.0.2 version: link:../../updaters/destroy/dist - '@tsparticles/updater-life': - specifier: ^3.0.1 + "@tsparticles/updater-life": + specifier: ^3.0.2 version: link:../../updaters/life/dist - '@tsparticles/updater-rotate': - specifier: ^3.0.1 + "@tsparticles/updater-rotate": + specifier: ^3.0.2 version: link:../../updaters/rotate/dist - '@tsparticles/updater-stroke-color': - specifier: ^3.0.1 + "@tsparticles/updater-stroke-color": + specifier: ^3.0.2 version: link:../../updaters/strokeColor/dist publishDirectory: dist bundles/full: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/interaction-external-trail': - specifier: ^3.0.1 + "@tsparticles/interaction-external-trail": + specifier: ^3.0.2 version: link:../../interactions/external/trail/dist - '@tsparticles/plugin-absorbers': - specifier: ^3.0.1 + "@tsparticles/plugin-absorbers": + specifier: ^3.0.2 version: link:../../plugins/absorbers/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../plugins/emitters/dist - '@tsparticles/plugin-emitters-shape-circle': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-circle": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/circle/dist - '@tsparticles/plugin-emitters-shape-square': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-square": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/square/dist - '@tsparticles/shape-text': - specifier: ^3.0.1 + "@tsparticles/shape-text": + specifier: ^3.0.2 version: link:../../shapes/text/dist - '@tsparticles/slim': - specifier: ^3.0.1 + "@tsparticles/slim": + specifier: ^3.0.2 version: link:../slim/dist - '@tsparticles/updater-destroy': - specifier: ^3.0.1 + "@tsparticles/updater-destroy": + specifier: ^3.0.2 version: link:../../updaters/destroy/dist - '@tsparticles/updater-roll': - specifier: ^3.0.1 + "@tsparticles/updater-roll": + specifier: ^3.0.2 version: link:../../updaters/roll/dist - '@tsparticles/updater-tilt': - specifier: ^3.0.1 + "@tsparticles/updater-tilt": + specifier: ^3.0.2 version: link:../../updaters/tilt/dist - '@tsparticles/updater-twinkle': - specifier: ^3.0.1 + "@tsparticles/updater-twinkle": + specifier: ^3.0.2 version: link:../../updaters/twinkle/dist - '@tsparticles/updater-wobble': - specifier: ^3.0.1 + "@tsparticles/updater-wobble": + specifier: ^3.0.2 version: link:../../updaters/wobble/dist publishDirectory: dist bundles/pjs: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist bundles/slim: dependencies: - '@tsparticles/basic': - specifier: ^3.0.1 + "@tsparticles/basic": + specifier: ^3.0.2 version: link:../basic/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/interaction-external-attract': - specifier: ^3.0.1 + "@tsparticles/interaction-external-attract": + specifier: ^3.0.2 version: link:../../interactions/external/attract/dist - '@tsparticles/interaction-external-bounce': - specifier: ^3.0.1 + "@tsparticles/interaction-external-bounce": + specifier: ^3.0.2 version: link:../../interactions/external/bounce/dist - '@tsparticles/interaction-external-bubble': - specifier: ^3.0.1 + "@tsparticles/interaction-external-bubble": + specifier: ^3.0.2 version: link:../../interactions/external/bubble/dist - '@tsparticles/interaction-external-connect': - specifier: ^3.0.1 + "@tsparticles/interaction-external-connect": + specifier: ^3.0.2 version: link:../../interactions/external/connect/dist - '@tsparticles/interaction-external-grab': - specifier: ^3.0.1 + "@tsparticles/interaction-external-grab": + specifier: ^3.0.2 version: link:../../interactions/external/grab/dist - '@tsparticles/interaction-external-pause': - specifier: ^3.0.1 + "@tsparticles/interaction-external-pause": + specifier: ^3.0.2 version: link:../../interactions/external/pause/dist - '@tsparticles/interaction-external-push': - specifier: ^3.0.1 + "@tsparticles/interaction-external-push": + specifier: ^3.0.2 version: link:../../interactions/external/push/dist - '@tsparticles/interaction-external-remove': - specifier: ^3.0.1 + "@tsparticles/interaction-external-remove": + specifier: ^3.0.2 version: link:../../interactions/external/remove/dist - '@tsparticles/interaction-external-repulse': - specifier: ^3.0.1 + "@tsparticles/interaction-external-repulse": + specifier: ^3.0.2 version: link:../../interactions/external/repulse/dist - '@tsparticles/interaction-external-slow': - specifier: ^3.0.1 + "@tsparticles/interaction-external-slow": + specifier: ^3.0.2 version: link:../../interactions/external/slow/dist - '@tsparticles/interaction-particles-attract': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-attract": + specifier: ^3.0.2 version: link:../../interactions/particles/attract/dist - '@tsparticles/interaction-particles-collisions': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-collisions": + specifier: ^3.0.2 version: link:../../interactions/particles/collisions/dist - '@tsparticles/interaction-particles-links': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-links": + specifier: ^3.0.2 version: link:../../interactions/particles/links/dist - '@tsparticles/move-base': - specifier: ^3.0.1 + "@tsparticles/move-base": + specifier: ^3.0.2 version: link:../../move/base/dist - '@tsparticles/move-parallax': - specifier: ^3.0.1 + "@tsparticles/move-parallax": + specifier: ^3.0.2 version: link:../../move/parallax/dist - '@tsparticles/plugin-easing-quad': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quad": + specifier: ^3.0.2 version: link:../../plugins/easings/quad/dist - '@tsparticles/shape-circle': - specifier: ^3.0.1 + "@tsparticles/shape-circle": + specifier: ^3.0.2 version: link:../../shapes/circle/dist - '@tsparticles/shape-emoji': - specifier: ^3.0.1 + "@tsparticles/shape-emoji": + specifier: ^3.0.2 version: link:../../shapes/emoji/dist - '@tsparticles/shape-image': - specifier: ^3.0.1 + "@tsparticles/shape-image": + specifier: ^3.0.2 version: link:../../shapes/image/dist - '@tsparticles/shape-line': - specifier: ^3.0.1 + "@tsparticles/shape-line": + specifier: ^3.0.2 version: link:../../shapes/line/dist - '@tsparticles/shape-polygon': - specifier: ^3.0.1 + "@tsparticles/shape-polygon": + specifier: ^3.0.2 version: link:../../shapes/polygon/dist - '@tsparticles/shape-square': - specifier: ^3.0.1 + "@tsparticles/shape-square": + specifier: ^3.0.2 version: link:../../shapes/square/dist - '@tsparticles/shape-star': - specifier: ^3.0.1 + "@tsparticles/shape-star": + specifier: ^3.0.2 version: link:../../shapes/star/dist - '@tsparticles/updater-color': - specifier: ^3.0.1 + "@tsparticles/updater-color": + specifier: ^3.0.2 version: link:../../updaters/color/dist - '@tsparticles/updater-life': - specifier: ^3.0.1 + "@tsparticles/updater-life": + specifier: ^3.0.2 version: link:../../updaters/life/dist - '@tsparticles/updater-opacity': - specifier: ^3.0.1 + "@tsparticles/updater-opacity": + specifier: ^3.0.2 version: link:../../updaters/opacity/dist - '@tsparticles/updater-out-modes': - specifier: ^3.0.1 + "@tsparticles/updater-out-modes": + specifier: ^3.0.2 version: link:../../updaters/outModes/dist - '@tsparticles/updater-rotate': - specifier: ^3.0.1 + "@tsparticles/updater-rotate": + specifier: ^3.0.2 version: link:../../updaters/rotate/dist - '@tsparticles/updater-size': - specifier: ^3.0.1 + "@tsparticles/updater-size": + specifier: ^3.0.2 version: link:../../updaters/size/dist - '@tsparticles/updater-stroke-color': - specifier: ^3.0.1 + "@tsparticles/updater-stroke-color": + specifier: ^3.0.2 version: link:../../updaters/strokeColor/dist publishDirectory: dist demo/electron: dependencies: - '@tsparticles/configs': - specifier: ^3.0.1 + "@tsparticles/configs": + specifier: ^3.0.2 version: link:../../utils/configs/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist tsparticles: - specifier: ^3.0.1 + specifier: ^3.0.2 version: link:../../bundles/full/dist devDependencies: electron: @@ -592,305 +591,305 @@ importers: demo/vanilla: dependencies: - '@tsparticles/all': - specifier: ^3.0.1 + "@tsparticles/all": + specifier: ^3.0.2 version: link:../../bundles/all/dist - '@tsparticles/basic': - specifier: ^3.0.1 + "@tsparticles/basic": + specifier: ^3.0.2 version: link:../../bundles/basic/dist - '@tsparticles/confetti': - specifier: ^3.0.1 + "@tsparticles/confetti": + specifier: ^3.0.2 version: link:../../bundles/confetti/dist - '@tsparticles/configs': - specifier: ^3.0.1 + "@tsparticles/configs": + specifier: ^3.0.2 version: link:../../utils/configs/dist - '@tsparticles/effect-bubble': - specifier: ^3.0.1 + "@tsparticles/effect-bubble": + specifier: ^3.0.2 version: link:../../effects/bubble/dist - '@tsparticles/effect-trail': - specifier: ^3.0.1 + "@tsparticles/effect-trail": + specifier: ^3.0.2 version: link:../../effects/trail/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/fireworks': - specifier: ^3.0.1 + "@tsparticles/fireworks": + specifier: ^3.0.2 version: link:../../bundles/fireworks/dist - '@tsparticles/interaction-external-attract': - specifier: ^3.0.1 + "@tsparticles/interaction-external-attract": + specifier: ^3.0.2 version: link:../../interactions/external/attract/dist - '@tsparticles/interaction-external-bounce': - specifier: ^3.0.1 + "@tsparticles/interaction-external-bounce": + specifier: ^3.0.2 version: link:../../interactions/external/bounce/dist - '@tsparticles/interaction-external-bubble': - specifier: ^3.0.1 + "@tsparticles/interaction-external-bubble": + specifier: ^3.0.2 version: link:../../interactions/external/bubble/dist - '@tsparticles/interaction-external-connect': - specifier: ^3.0.1 + "@tsparticles/interaction-external-connect": + specifier: ^3.0.2 version: link:../../interactions/external/connect/dist - '@tsparticles/interaction-external-grab': - specifier: ^3.0.1 + "@tsparticles/interaction-external-grab": + specifier: ^3.0.2 version: link:../../interactions/external/grab/dist - '@tsparticles/interaction-external-pause': - specifier: ^3.0.1 + "@tsparticles/interaction-external-pause": + specifier: ^3.0.2 version: link:../../interactions/external/pause/dist - '@tsparticles/interaction-external-pop': - specifier: ^3.0.1 + "@tsparticles/interaction-external-pop": + specifier: ^3.0.2 version: link:../../interactions/external/pop/dist - '@tsparticles/interaction-external-push': - specifier: ^3.0.1 + "@tsparticles/interaction-external-push": + specifier: ^3.0.2 version: link:../../interactions/external/push/dist - '@tsparticles/interaction-external-remove': - specifier: ^3.0.1 + "@tsparticles/interaction-external-remove": + specifier: ^3.0.2 version: link:../../interactions/external/remove/dist - '@tsparticles/interaction-external-repulse': - specifier: ^3.0.1 + "@tsparticles/interaction-external-repulse": + specifier: ^3.0.2 version: link:../../interactions/external/repulse/dist - '@tsparticles/interaction-external-slow': - specifier: ^3.0.1 + "@tsparticles/interaction-external-slow": + specifier: ^3.0.2 version: link:../../interactions/external/slow/dist - '@tsparticles/interaction-external-trail': - specifier: ^3.0.1 + "@tsparticles/interaction-external-trail": + specifier: ^3.0.2 version: link:../../interactions/external/trail/dist - '@tsparticles/interaction-light': - specifier: ^3.0.1 + "@tsparticles/interaction-light": + specifier: ^3.0.2 version: link:../../interactions/light/dist - '@tsparticles/interaction-particles-attract': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-attract": + specifier: ^3.0.2 version: link:../../interactions/particles/attract/dist - '@tsparticles/interaction-particles-collisions': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-collisions": + specifier: ^3.0.2 version: link:../../interactions/particles/collisions/dist - '@tsparticles/interaction-particles-links': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-links": + specifier: ^3.0.2 version: link:../../interactions/particles/links/dist - '@tsparticles/interaction-particles-repulse': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-repulse": + specifier: ^3.0.2 version: link:../../interactions/particles/repulse/dist - '@tsparticles/move-base': - specifier: ^3.0.1 + "@tsparticles/move-base": + specifier: ^3.0.2 version: link:../../move/base/dist - '@tsparticles/move-parallax': - specifier: ^3.0.1 + "@tsparticles/move-parallax": + specifier: ^3.0.2 version: link:../../move/parallax/dist - '@tsparticles/path-curl-noise': - specifier: ^3.0.1 + "@tsparticles/path-curl-noise": + specifier: ^3.0.2 version: link:../../paths/curlNoise/dist - '@tsparticles/path-curves': - specifier: ^3.0.1 + "@tsparticles/path-curves": + specifier: ^3.0.2 version: link:../../paths/curves/dist - '@tsparticles/path-perlin-noise': - specifier: ^3.0.1 + "@tsparticles/path-perlin-noise": + specifier: ^3.0.2 version: link:../../paths/perlinNoise/dist - '@tsparticles/path-polygon': - specifier: ^3.0.1 + "@tsparticles/path-polygon": + specifier: ^3.0.2 version: link:../../paths/polygon/dist - '@tsparticles/path-simplex-noise': - specifier: ^3.0.1 + "@tsparticles/path-simplex-noise": + specifier: ^3.0.2 version: link:../../paths/simplexNoise/dist - '@tsparticles/path-svg': - specifier: ^3.0.1 + "@tsparticles/path-svg": + specifier: ^3.0.2 version: link:../../paths/svg/dist - '@tsparticles/perlin-noise': - specifier: ^3.0.1 + "@tsparticles/perlin-noise": + specifier: ^3.0.2 version: link:../../utils/perlinNoise/dist - '@tsparticles/pjs': - specifier: ^3.0.1 + "@tsparticles/pjs": + specifier: ^3.0.2 version: link:../../bundles/pjs/dist - '@tsparticles/plugin-absorbers': - specifier: ^3.0.1 + "@tsparticles/plugin-absorbers": + specifier: ^3.0.2 version: link:../../plugins/absorbers/dist - '@tsparticles/plugin-canvas-mask': - specifier: ^3.0.1 + "@tsparticles/plugin-canvas-mask": + specifier: ^3.0.2 version: link:../../plugins/canvasMask/dist - '@tsparticles/plugin-easing-back': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-back": + specifier: ^3.0.2 version: link:../../plugins/easings/back/dist - '@tsparticles/plugin-easing-circ': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-circ": + specifier: ^3.0.2 version: link:../../plugins/easings/circ/dist - '@tsparticles/plugin-easing-cubic': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-cubic": + specifier: ^3.0.2 version: link:../../plugins/easings/cubic/dist - '@tsparticles/plugin-easing-expo': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-expo": + specifier: ^3.0.2 version: link:../../plugins/easings/expo/dist - '@tsparticles/plugin-easing-linear': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-linear": + specifier: ^3.0.2 version: link:../../plugins/easings/linear/dist - '@tsparticles/plugin-easing-quad': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quad": + specifier: ^3.0.2 version: link:../../plugins/easings/quad/dist - '@tsparticles/plugin-easing-quart': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quart": + specifier: ^3.0.2 version: link:../../plugins/easings/quart/dist - '@tsparticles/plugin-easing-quint': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-quint": + specifier: ^3.0.2 version: link:../../plugins/easings/quint/dist - '@tsparticles/plugin-easing-sine': - specifier: ^3.0.1 + "@tsparticles/plugin-easing-sine": + specifier: ^3.0.2 version: link:../../plugins/easings/sine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../plugins/emitters/dist - '@tsparticles/plugin-emitters-shape-canvas': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-canvas": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/canvas/dist - '@tsparticles/plugin-emitters-shape-circle': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-circle": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/circle/dist - '@tsparticles/plugin-emitters-shape-path': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-path": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/path/dist - '@tsparticles/plugin-emitters-shape-polygon': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-polygon": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/polygon/dist - '@tsparticles/plugin-emitters-shape-square': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters-shape-square": + specifier: ^3.0.2 version: link:../../plugins/emittersShapes/square/dist - '@tsparticles/plugin-export-image': - specifier: ^3.0.1 + "@tsparticles/plugin-export-image": + specifier: ^3.0.2 version: link:../../plugins/exports/image/dist - '@tsparticles/plugin-export-json': - specifier: ^3.0.1 + "@tsparticles/plugin-export-json": + specifier: ^3.0.2 version: link:../../plugins/exports/json/dist - '@tsparticles/plugin-export-video': - specifier: ^3.0.1 + "@tsparticles/plugin-export-video": + specifier: ^3.0.2 version: link:../../plugins/exports/video/dist - '@tsparticles/plugin-hsv-color': - specifier: ^3.0.1 + "@tsparticles/plugin-hsv-color": + specifier: ^3.0.2 version: link:../../plugins/hsvColor/dist - '@tsparticles/plugin-infection': - specifier: ^3.0.1 + "@tsparticles/plugin-infection": + specifier: ^3.0.2 version: link:../../plugins/infection/dist - '@tsparticles/plugin-motion': - specifier: ^3.0.1 + "@tsparticles/plugin-motion": + specifier: ^3.0.2 version: link:../../plugins/motion/dist - '@tsparticles/plugin-polygon-mask': - specifier: ^3.0.1 + "@tsparticles/plugin-polygon-mask": + specifier: ^3.0.2 version: link:../../plugins/polygonMask/dist - '@tsparticles/plugin-sounds': - specifier: ^3.0.1 + "@tsparticles/plugin-sounds": + specifier: ^3.0.2 version: link:../../plugins/sounds/dist - '@tsparticles/shape-arrow': - specifier: ^3.0.1 + "@tsparticles/shape-arrow": + specifier: ^3.0.2 version: link:../../shapes/arrow/dist - '@tsparticles/shape-cards': - specifier: ^3.0.1 + "@tsparticles/shape-cards": + specifier: ^3.0.2 version: link:../../shapes/cards/dist - '@tsparticles/shape-circle': - specifier: ^3.0.1 + "@tsparticles/shape-circle": + specifier: ^3.0.2 version: link:../../shapes/circle/dist - '@tsparticles/shape-cog': - specifier: ^3.0.1 + "@tsparticles/shape-cog": + specifier: ^3.0.2 version: link:../../shapes/cog/dist - '@tsparticles/shape-emoji': - specifier: ^3.0.1 + "@tsparticles/shape-emoji": + specifier: ^3.0.2 version: link:../../shapes/emoji/dist - '@tsparticles/shape-heart': - specifier: ^3.0.1 + "@tsparticles/shape-heart": + specifier: ^3.0.2 version: link:../../shapes/heart/dist - '@tsparticles/shape-image': - specifier: ^3.0.1 + "@tsparticles/shape-image": + specifier: ^3.0.2 version: link:../../shapes/image/dist - '@tsparticles/shape-line': - specifier: ^3.0.1 + "@tsparticles/shape-line": + specifier: ^3.0.2 version: link:../../shapes/line/dist - '@tsparticles/shape-path': - specifier: ^3.0.1 + "@tsparticles/shape-path": + specifier: ^3.0.2 version: link:../../shapes/path/dist - '@tsparticles/shape-polygon': - specifier: ^3.0.1 + "@tsparticles/shape-polygon": + specifier: ^3.0.2 version: link:../../shapes/polygon/dist - '@tsparticles/shape-rounded-polygon': - specifier: ^3.0.1 + "@tsparticles/shape-rounded-polygon": + specifier: ^3.0.2 version: link:../../shapes/rounded-polygon/dist - '@tsparticles/shape-rounded-rect': - specifier: ^3.0.1 + "@tsparticles/shape-rounded-rect": + specifier: ^3.0.2 version: link:../../shapes/rounded-rect/dist - '@tsparticles/shape-spiral': - specifier: ^3.0.1 + "@tsparticles/shape-spiral": + specifier: ^3.0.2 version: link:../../shapes/spiral/dist - '@tsparticles/shape-square': - specifier: ^3.0.1 + "@tsparticles/shape-square": + specifier: ^3.0.2 version: link:../../shapes/square/dist - '@tsparticles/shape-star': - specifier: ^3.0.1 + "@tsparticles/shape-star": + specifier: ^3.0.2 version: link:../../shapes/star/dist - '@tsparticles/shape-text': - specifier: ^3.0.1 + "@tsparticles/shape-text": + specifier: ^3.0.2 version: link:../../shapes/text/dist - '@tsparticles/simplex-noise': - specifier: ^3.0.1 + "@tsparticles/simplex-noise": + specifier: ^3.0.2 version: link:../../utils/simplexNoise/dist - '@tsparticles/slim': - specifier: ^3.0.1 + "@tsparticles/slim": + specifier: ^3.0.2 version: link:../../bundles/slim/dist - '@tsparticles/updater-color': - specifier: ^3.0.1 + "@tsparticles/updater-color": + specifier: ^3.0.2 version: link:../../updaters/color/dist - '@tsparticles/updater-destroy': - specifier: ^3.0.1 + "@tsparticles/updater-destroy": + specifier: ^3.0.2 version: link:../../updaters/destroy/dist - '@tsparticles/updater-gradient': - specifier: ^3.0.1 + "@tsparticles/updater-gradient": + specifier: ^3.0.2 version: link:../../updaters/gradient/dist - '@tsparticles/updater-life': - specifier: ^3.0.1 + "@tsparticles/updater-life": + specifier: ^3.0.2 version: link:../../updaters/life/dist - '@tsparticles/updater-opacity': - specifier: ^3.0.1 + "@tsparticles/updater-opacity": + specifier: ^3.0.2 version: link:../../updaters/opacity/dist - '@tsparticles/updater-orbit': - specifier: ^3.0.1 + "@tsparticles/updater-orbit": + specifier: ^3.0.2 version: link:../../updaters/orbit/dist - '@tsparticles/updater-out-modes': - specifier: ^3.0.1 + "@tsparticles/updater-out-modes": + specifier: ^3.0.2 version: link:../../updaters/outModes/dist - '@tsparticles/updater-roll': - specifier: ^3.0.1 + "@tsparticles/updater-roll": + specifier: ^3.0.2 version: link:../../updaters/roll/dist - '@tsparticles/updater-rotate': - specifier: ^3.0.1 + "@tsparticles/updater-rotate": + specifier: ^3.0.2 version: link:../../updaters/rotate/dist - '@tsparticles/updater-size': - specifier: ^3.0.1 + "@tsparticles/updater-size": + specifier: ^3.0.2 version: link:../../updaters/size/dist - '@tsparticles/updater-stroke-color': - specifier: ^3.0.1 + "@tsparticles/updater-stroke-color": + specifier: ^3.0.2 version: link:../../updaters/strokeColor/dist - '@tsparticles/updater-tilt': - specifier: ^3.0.1 + "@tsparticles/updater-tilt": + specifier: ^3.0.2 version: link:../../updaters/tilt/dist - '@tsparticles/updater-twinkle': - specifier: ^3.0.1 + "@tsparticles/updater-twinkle": + specifier: ^3.0.2 version: link:../../updaters/twinkle/dist - '@tsparticles/updater-wobble': - specifier: ^3.0.1 + "@tsparticles/updater-wobble": + specifier: ^3.0.2 version: link:../../updaters/wobble/dist tsparticles: - specifier: ^3.0.1 + specifier: ^3.0.2 version: link:../../bundles/full/dist devDependencies: - '@datalust/winston-seq': + "@datalust/winston-seq": specifier: ^2.0.0 version: 2.0.0([email protected]) - '@fortawesome/fontawesome-free': + "@fortawesome/fontawesome-free": specifier: ^6.4.2 version: 6.4.2 - '@types/connect-livereload': + "@types/connect-livereload": specifier: ^0.6.3 version: 0.6.3 - '@types/express': + "@types/express": specifier: ^4.17.21 version: 4.17.21 - '@types/livereload': + "@types/livereload": specifier: ^0.9.5 version: 0.9.5 - '@types/node': + "@types/node": specifier: ^20.8.10 version: 20.8.10 - '@types/stylus': + "@types/stylus": specifier: ^0.48.41 version: 0.48.41 ace-builds: @@ -947,41 +946,41 @@ importers: demo/vanilla_new: dependencies: - '@tsparticles/configs': - specifier: ^3.0.1 + "@tsparticles/configs": + specifier: ^3.0.2 version: link:../../utils/configs/dist - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/interaction-light': - specifier: ^3.0.1 + "@tsparticles/interaction-light": + specifier: ^3.0.2 version: link:../../interactions/light/dist - '@tsparticles/interaction-particles-repulse': - specifier: ^3.0.1 + "@tsparticles/interaction-particles-repulse": + specifier: ^3.0.2 version: link:../../interactions/particles/repulse/dist - '@tsparticles/path-curves': - specifier: ^3.0.1 + "@tsparticles/path-curves": + specifier: ^3.0.2 version: link:../../paths/curves/dist - '@tsparticles/path-perlin-noise': - specifier: ^3.0.1 + "@tsparticles/path-perlin-noise": + specifier: ^3.0.2 version: link:../../paths/perlinNoise/dist - '@tsparticles/path-polygon': - specifier: ^3.0.1 + "@tsparticles/path-polygon": + specifier: ^3.0.2 version: link:../../paths/polygon/dist - '@tsparticles/path-simplex-noise': - specifier: ^3.0.1 + "@tsparticles/path-simplex-noise": + specifier: ^3.0.2 version: link:../../paths/simplexNoise/dist - '@tsparticles/plugin-infection': - specifier: ^3.0.1 + "@tsparticles/plugin-infection": + specifier: ^3.0.2 version: link:../../plugins/infection/dist - '@tsparticles/updater-gradient': - specifier: ^3.0.1 + "@tsparticles/updater-gradient": + specifier: ^3.0.2 version: link:../../updaters/gradient/dist - '@tsparticles/updater-orbit': - specifier: ^3.0.1 + "@tsparticles/updater-orbit": + specifier: ^3.0.2 version: link:../../updaters/orbit/dist tsparticles: - specifier: ^3.0.1 + specifier: ^3.0.2 version: link:../../bundles/full/dist devDependencies: fs-extra: @@ -996,15 +995,15 @@ importers: effects/bubble: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist effects/trail: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist @@ -1013,592 +1012,592 @@ importers: interactions/external/attract: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/bounce: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/bubble: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/connect: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/grab: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/pause: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/pop: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/push: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/remove: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/repulse: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/slow: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/external/trail: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/light: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist interactions/particles/attract: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/particles/collisions: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/particles/links: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist interactions/particles/repulse: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist move/base: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist move/parallax: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist paths/curlNoise: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/simplex-noise': - specifier: ^3.0.1 + "@tsparticles/simplex-noise": + specifier: ^3.0.2 version: link:../../utils/simplexNoise/dist publishDirectory: dist paths/curves: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist paths/perlinNoise: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/perlin-noise': - specifier: ^3.0.1 + "@tsparticles/perlin-noise": + specifier: ^3.0.2 version: link:../../utils/perlinNoise/dist publishDirectory: dist paths/polygon: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist paths/simplexNoise: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist - '@tsparticles/simplex-noise': - specifier: ^3.0.1 + "@tsparticles/simplex-noise": + specifier: ^3.0.2 version: link:../../utils/simplexNoise/dist publishDirectory: dist paths/svg: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/absorbers: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/canvasMask: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/easings/back: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/circ: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/cubic: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/expo: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/linear: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/quad: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/quart: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/quint: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/easings/sine: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/emitters: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/emittersShapes/canvas: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../emitters/dist publishDirectory: dist plugins/emittersShapes/circle: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../emitters/dist publishDirectory: dist plugins/emittersShapes/path: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../emitters/dist publishDirectory: dist plugins/emittersShapes/polygon: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../emitters/dist publishDirectory: dist plugins/emittersShapes/square: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist - '@tsparticles/plugin-emitters': - specifier: ^3.0.1 + "@tsparticles/plugin-emitters": + specifier: ^3.0.2 version: link:../../emitters/dist publishDirectory: dist plugins/exports/image: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/exports/json: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/exports/video: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../../engine/dist publishDirectory: dist plugins/hsvColor: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/infection: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/motion: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/polygonMask: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist plugins/sounds: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/arrow: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/cards: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/circle: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/cog: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/emoji: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/heart: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/image: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/line: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/path: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/polygon: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/rounded-polygon: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/rounded-rect: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/spiral: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/square: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/star: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist shapes/text: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/color: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/destroy: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/gradient: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/life: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/opacity: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/orbit: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/outModes: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/roll: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/rotate: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/size: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/strokeColor: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/tilt: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/twinkle: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist updaters/wobble: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist utils/configs: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist publishDirectory: dist @@ -1610,31 +1609,34 @@ importers: utils/tests: dependencies: - '@tsparticles/engine': - specifier: ^3.0.1 + "@tsparticles/engine": + specifier: ^3.0.2 version: link:../../engine/dist packages: - /@aashutoshrathi/[email protected]: - resolution: {integrity: sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA== } + engines: { node: ">=0.10.0" } dev: true /@adobe/[email protected]: - resolution: {integrity: sha512-/62yikz7NLScCGAAST5SHdnjaDJQBDq0M2muyRTpf2VQhw6StBg2ALiu73zSJQ4fMVLA+0uBhBHAle7Wg+2kSg==} + resolution: + { integrity: sha512-/62yikz7NLScCGAAST5SHdnjaDJQBDq0M2muyRTpf2VQhw6StBg2ALiu73zSJQ4fMVLA+0uBhBHAle7Wg+2kSg== } dev: true /@ampproject/[email protected]: - resolution: {integrity: sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg== } + engines: { node: ">=6.0.0" } dependencies: - '@jridgewell/gen-mapping': 0.3.3 - '@jridgewell/trace-mapping': 0.3.18 + "@jridgewell/gen-mapping": 0.3.3 + "@jridgewell/trace-mapping": 0.3.18 dev: true /@augment-vir/[email protected]: - resolution: {integrity: sha512-0Y9EoZTVmwOOGO/D9aqFXdMj7qihyP3EbROTuA+N4GRNZicOKmEA5yGuL0V7qR3egZDlvkF8m1ka27VUbVyDzg==} + resolution: + { integrity: sha512-0Y9EoZTVmwOOGO/D9aqFXdMj7qihyP3EbROTuA+N4GRNZicOKmEA5yGuL0V7qR3egZDlvkF8m1ka27VUbVyDzg== } dependencies: browser-or-node: 2.1.1 run-time-assertions: 0.2.1 @@ -1642,40 +1644,44 @@ packages: dev: true /@babel/[email protected]: - resolution: {integrity: sha512-XktuhWlJ5g+3TJXc5upd9Ks1HutSArik6jf2eAjYFyIOf4ej3RN+184cZbzDvbPnuTJIUhPKKJE3cIsYTiAT3w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-XktuhWlJ5g+3TJXc5upd9Ks1HutSArik6jf2eAjYFyIOf4ej3RN+184cZbzDvbPnuTJIUhPKKJE3cIsYTiAT3w== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/highlight': 7.22.13 + "@babel/highlight": 7.22.13 chalk: 2.4.2 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-CgH3s1a96LipHCmSUmYFPwY7MNx8C3avkq7i4Wl3cfa662ldtUe4VM1TPXX70pfmrlWTb6jLqTYrZyT2ZTJBgA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-CgH3s1a96LipHCmSUmYFPwY7MNx8C3avkq7i4Wl3cfa662ldtUe4VM1TPXX70pfmrlWTb6jLqTYrZyT2ZTJBgA== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/highlight': 7.23.4 + "@babel/highlight": 7.23.4 chalk: 2.4.2 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-BmR4bWbDIoFJmJ9z2cZ8Gmm2MXgEDgjdWgpKmKWUt54UGFJdlj31ECtbaDvCG/qVdG3AQ1SfpZEs01lUFbzLOQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-BmR4bWbDIoFJmJ9z2cZ8Gmm2MXgEDgjdWgpKmKWUt54UGFJdlj31ECtbaDvCG/qVdG3AQ1SfpZEs01lUFbzLOQ== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-Cwc2XjUrG4ilcfOw4wBAK+enbdgwAcAJCfGUItPBKR7Mjw4aEfAFYrLxeRp4jWgtNIKn3n2AlBOfwwafl+42/g==} - engines: {node: '>=6.9.0'} - dependencies: - '@ampproject/remapping': 2.2.1 - '@babel/code-frame': 7.23.5 - '@babel/generator': 7.23.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-module-transforms': 7.23.3(@babel/[email protected]) - '@babel/helpers': 7.23.5 - '@babel/parser': 7.23.5 - '@babel/template': 7.22.15 - '@babel/traverse': 7.23.5 - '@babel/types': 7.23.5 + resolution: + { integrity: sha512-Cwc2XjUrG4ilcfOw4wBAK+enbdgwAcAJCfGUItPBKR7Mjw4aEfAFYrLxeRp4jWgtNIKn3n2AlBOfwwafl+42/g== } + engines: { node: ">=6.9.0" } + dependencies: + "@ampproject/remapping": 2.2.1 + "@babel/code-frame": 7.23.5 + "@babel/generator": 7.23.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-module-transforms": 7.23.3(@babel/[email protected]) + "@babel/helpers": 7.23.5 + "@babel/parser": 7.23.5 + "@babel/template": 7.22.15 + "@babel/traverse": 7.23.5 + "@babel/types": 7.23.5 convert-source-map: 2.0.0 debug: 4.3.4([email protected]) gensync: 1.0.0-beta.2 @@ -1686,78 +1692,85 @@ packages: dev: true /@babel/[email protected]: - resolution: {integrity: sha512-BPssCHrBD+0YrxviOa3QzpqwhNIXKEtOa2jQrm4FlmkC2apYgRnQcmPWiGZDlGxiNtltnUFolMe8497Esry+jA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-BPssCHrBD+0YrxviOa3QzpqwhNIXKEtOa2jQrm4FlmkC2apYgRnQcmPWiGZDlGxiNtltnUFolMe8497Esry+jA== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.5 - '@jridgewell/gen-mapping': 0.3.3 - '@jridgewell/trace-mapping': 0.3.18 + "@babel/types": 7.23.5 + "@jridgewell/gen-mapping": 0.3.3 + "@jridgewell/trace-mapping": 0.3.18 jsesc: 2.5.2 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-LvBTxu8bQSQkcyKOU+a1btnNFQ1dMAd0R6PyW3arXes06F6QLWLIrd681bxRPIXlrMGR3XYnW9JyML7dP3qgxg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-LvBTxu8bQSQkcyKOU+a1btnNFQ1dMAd0R6PyW3arXes06F6QLWLIrd681bxRPIXlrMGR3XYnW9JyML7dP3qgxg== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.3 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-QkBXwGgaoC2GtGZRoma6kv7Szfv06khvhFav67ZExau2RaXzy8MpHSMO2PNoP2XtmQphJQRHFfg77Bq731Yizw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-QkBXwGgaoC2GtGZRoma6kv7Szfv06khvhFav67ZExau2RaXzy8MpHSMO2PNoP2XtmQphJQRHFfg77Bq731Yizw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.3 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-y6EEzULok0Qvz8yyLkCvVX+02ic+By2UdOhylwUOvOn9dvYc9mKICJuuU1n1XBI02YWsNsnrY1kc6DVbjcXbtw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-y6EEzULok0Qvz8yyLkCvVX+02ic+By2UdOhylwUOvOn9dvYc9mKICJuuU1n1XBI02YWsNsnrY1kc6DVbjcXbtw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/compat-data': 7.23.3 - '@babel/helper-validator-option': 7.22.15 + "@babel/compat-data": 7.23.3 + "@babel/helper-validator-option": 7.22.15 browserslist: 4.22.2 lru-cache: 5.1.1 semver: 6.3.1 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-jKkwA59IXcvSaiK2UN45kKwSC9o+KuoXsBDvHvU/7BecYIp8GQ2UwrVvFgJASUT+hBnwJx6MhvMCuMzwZZ7jlg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.23.5 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-function-name': 7.23.0 - '@babel/helper-member-expression-to-functions': 7.23.0 - '@babel/helper-optimise-call-expression': 7.22.5 - '@babel/helper-replace-supers': 7.22.20(@babel/[email protected]) - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 + resolution: + { integrity: sha512-jKkwA59IXcvSaiK2UN45kKwSC9o+KuoXsBDvHvU/7BecYIp8GQ2UwrVvFgJASUT+hBnwJx6MhvMCuMzwZZ7jlg== } + engines: { node: ">=6.9.0" } + peerDependencies: + "@babel/core": ^7.0.0 + dependencies: + "@babel/core": 7.23.5 + "@babel/helper-annotate-as-pure": 7.22.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-function-name": 7.23.0 + "@babel/helper-member-expression-to-functions": 7.23.0 + "@babel/helper-optimise-call-expression": 7.22.5 + "@babel/helper-replace-supers": 7.22.20(@babel/[email protected]) + "@babel/helper-skip-transparent-expression-wrappers": 7.22.5 + "@babel/helper-split-export-declaration": 7.22.6 semver: 6.3.1 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-29FkPLFjn4TPEa3RE7GpW+qbE8tlsu3jntNYNfcGsc49LphF1PQIiD+vMZ1z1xVOKt+93khA9tc2JBs3kBjA7w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-29FkPLFjn4TPEa3RE7GpW+qbE8tlsu3jntNYNfcGsc49LphF1PQIiD+vMZ1z1xVOKt+93khA9tc2JBs3kBjA7w== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-annotate-as-pure': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-annotate-as-pure": 7.22.5 regexpu-core: 5.3.2 semver: 6.3.1 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-WBrLmuPP47n7PNwsZ57pqam6G/RGo1vw/87b0Blc53tZNGZ4x7YvZ6HgQe2vo1W/FR20OgjeZuGXzudPiXHFug==} + resolution: + { integrity: sha512-WBrLmuPP47n7PNwsZ57pqam6G/RGo1vw/87b0Blc53tZNGZ4x7YvZ6HgQe2vo1W/FR20OgjeZuGXzudPiXHFug== } peerDependencies: - '@babel/core': ^7.4.0 \|\| ^8.0.0-0 <8.0.0 + "@babel/core": ^7.4.0 \|\| ^8.0.0-0 <8.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-plugin-utils": 7.22.5 debug: 4.3.4([email protected]) lodash.debounce: 4.0.8 resolve: 1.22.8 @@ -1766,1009 +1779,1103 @@ packages: dev: true /@babel/[email protected]: - resolution: {integrity: sha512-zfedSIzFhat/gFhWfHtgWvlec0nqB9YEIVrpuwjruLlXfUSnA8cJB0miHKwqDnQ7d32aKo2xt88/xZptwxbfhA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-zfedSIzFhat/gFhWfHtgWvlec0nqB9YEIVrpuwjruLlXfUSnA8cJB0miHKwqDnQ7d32aKo2xt88/xZptwxbfhA== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-OErEqsrxjZTJciZ4Oo+eoZqeW9UIiOcuYKRJA4ZAgV9myA+pOXhhmpfNCKjEH/auVfEYVFJ6y1Tc4r0eIApqiw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-OErEqsrxjZTJciZ4Oo+eoZqeW9UIiOcuYKRJA4ZAgV9myA+pOXhhmpfNCKjEH/auVfEYVFJ6y1Tc4r0eIApqiw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/template': 7.22.15 - '@babel/types': 7.23.5 + "@babel/template": 7.22.15 + "@babel/types": 7.23.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-wGjk9QZVzvknA6yKIUURb8zY3grXCcOZt+/7Wcy8O2uctxhplmUPkOdlgoNhmdVee2c92JXbf1xpMtVNbfoxRw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-wGjk9QZVzvknA6yKIUURb8zY3grXCcOZt+/7Wcy8O2uctxhplmUPkOdlgoNhmdVee2c92JXbf1xpMtVNbfoxRw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-6gfrPwh7OuT6gZyJZvd6WbTfrqAo7vm4xCzAXOusKqq/vWdKXphTpj5klHKNmRUU6/QRGlBsyU9mAIPaWHlqJA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-6gfrPwh7OuT6gZyJZvd6WbTfrqAo7vm4xCzAXOusKqq/vWdKXphTpj5klHKNmRUU6/QRGlBsyU9mAIPaWHlqJA== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.3 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-0pYVBnDKZO2fnSPCrgM/6WMc7eS20Fbok+0r88fp+YtWVLZrp4CkafFGIp+W0VKw4a22sgebPT99y+FDNMdP4w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-0pYVBnDKZO2fnSPCrgM/6WMc7eS20Fbok+0r88fp+YtWVLZrp4CkafFGIp+W0VKw4a22sgebPT99y+FDNMdP4w== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-7bBs4ED9OmswdfDzpz4MpWgSrV7FXlc3zIagvLFjS5H+Mk7Snr21vQ6QwrsoCGMfNC4e4LQPdoULEt4ykz0SRQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-7bBs4ED9OmswdfDzpz4MpWgSrV7FXlc3zIagvLFjS5H+Mk7Snr21vQ6QwrsoCGMfNC4e4LQPdoULEt4ykz0SRQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-module-imports': 7.22.15 - '@babel/helper-simple-access': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 - '@babel/helper-validator-identifier': 7.22.20 + "@babel/core": 7.23.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-module-imports": 7.22.15 + "@babel/helper-simple-access": 7.22.5 + "@babel/helper-split-export-declaration": 7.22.6 + "@babel/helper-validator-identifier": 7.22.20 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-HBwaojN0xFRx4yIvpwGqxiV2tUfl7401jlok564NgB9EHS1y6QT17FmKWm4ztqjeVdXLuC4fSvHc5ePpQjoTbw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-HBwaojN0xFRx4yIvpwGqxiV2tUfl7401jlok564NgB9EHS1y6QT17FmKWm4ztqjeVdXLuC4fSvHc5ePpQjoTbw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.3 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-uLls06UVKgFG9QD4OeFYLEGteMIAa5kpTPcFL28yuCIIzsf6ZyKZMllKVOCZFhiZ5ptnwX4mtKdWCBE/uT4amg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-uLls06UVKgFG9QD4OeFYLEGteMIAa5kpTPcFL28yuCIIzsf6ZyKZMllKVOCZFhiZ5ptnwX4mtKdWCBE/uT4amg== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-pBGyV4uBqOns+0UvhsTO8qgl8hO89PmiDYv+/COyp1aeMcmfrfruz+/nCMFiYyFF/Knn0yfrC85ZzNFjembFTw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-pBGyV4uBqOns+0UvhsTO8qgl8hO89PmiDYv+/COyp1aeMcmfrfruz+/nCMFiYyFF/Knn0yfrC85ZzNFjembFTw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-wrap-function': 7.22.20 + "@babel/core": 7.23.5 + "@babel/helper-annotate-as-pure": 7.22.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-wrap-function": 7.22.20 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-qsW0In3dbwQUbK8kejJ4R7IHVGwHJlV6lpG6UA7a9hSa2YEiAib+N1T2kr6PEeUT+Fl7najmSOS6SmAwCHK6Tw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-qsW0In3dbwQUbK8kejJ4R7IHVGwHJlV6lpG6UA7a9hSa2YEiAib+N1T2kr6PEeUT+Fl7najmSOS6SmAwCHK6Tw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-member-expression-to-functions': 7.23.0 - '@babel/helper-optimise-call-expression': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-member-expression-to-functions": 7.23.0 + "@babel/helper-optimise-call-expression": 7.22.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-n0H99E/K+Bika3++WNL17POvo4rKWZ7lZEp1Q+fStVbUi8nxPQEBOlTmCOxW/0JsS56SKKQ+ojAe2pHKJHN35w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-n0H99E/K+Bika3++WNL17POvo4rKWZ7lZEp1Q+fStVbUi8nxPQEBOlTmCOxW/0JsS56SKKQ+ojAe2pHKJHN35w== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-tK14r66JZKiC43p8Ki33yLBVJKlQDFoA8GYN67lWCDCqoL6EMMSuM9b+Iff2jHaM/RRFYl7K+iiru7hbRqNx8Q==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-tK14r66JZKiC43p8Ki33yLBVJKlQDFoA8GYN67lWCDCqoL6EMMSuM9b+Iff2jHaM/RRFYl7K+iiru7hbRqNx8Q== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.3 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-AsUnxuLhRYsisFiaJwvp1QF+I3KjD5FOxut14q/GzovUe6orHLesW2C7d754kRm53h5gqrz6sFl6sxc4BVtE/g==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-AsUnxuLhRYsisFiaJwvp1QF+I3KjD5FOxut14q/GzovUe6orHLesW2C7d754kRm53h5gqrz6sFl6sxc4BVtE/g== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/types': 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-mM4COjgZox8U+JcXQwPijIZLElkgEpO5rsERVDJTc2qfCDfERyob6k5WegS14SX18IIjv+XD+GrqNumY5JRCDw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-mM4COjgZox8U+JcXQwPijIZLElkgEpO5rsERVDJTc2qfCDfERyob6k5WegS14SX18IIjv+XD+GrqNumY5JRCDw== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-803gmbQdqwdf4olxrX4AJyFBV/RTr3rSmOj0rKwesmzlfhYNDEs+/iOcznzpNWlJlIlTJC2QfPFcHB6DlzdVLQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-803gmbQdqwdf4olxrX4AJyFBV/RTr3rSmOj0rKwesmzlfhYNDEs+/iOcznzpNWlJlIlTJC2QfPFcHB6DlzdVLQ== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-bMn7RmyFjY/mdECUbgn9eoSY4vqvacUnS9i9vGAGttgFWesO6B4CYWA7XlpbWgBt71iv/hfbPlynohStqnu5hA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-bMn7RmyFjY/mdECUbgn9eoSY4vqvacUnS9i9vGAGttgFWesO6B4CYWA7XlpbWgBt71iv/hfbPlynohStqnu5hA== } + engines: { node: ">=6.9.0" } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-pms/UwkOpnQe/PDAEdV/d7dVCoBbB+R4FvYoHGZz+4VPcg7RtYy2KP7S2lbuWM6FCSgob5wshfGESbC/hzNXZw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-pms/UwkOpnQe/PDAEdV/d7dVCoBbB+R4FvYoHGZz+4VPcg7RtYy2KP7S2lbuWM6FCSgob5wshfGESbC/hzNXZw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-function-name': 7.23.0 - '@babel/template': 7.22.15 - '@babel/types': 7.23.3 + "@babel/helper-function-name": 7.23.0 + "@babel/template": 7.22.15 + "@babel/types": 7.23.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-oO7us8FzTEsG3U6ag9MfdF1iA/7Z6dz+MtFhifZk8C8o453rGJFFWUP1t+ULM9TUIAzC9uxXEiXjOiVMyd7QPg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-oO7us8FzTEsG3U6ag9MfdF1iA/7Z6dz+MtFhifZk8C8o453rGJFFWUP1t+ULM9TUIAzC9uxXEiXjOiVMyd7QPg== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/template': 7.22.15 - '@babel/traverse': 7.23.5 - '@babel/types': 7.23.5 + "@babel/template": 7.22.15 + "@babel/traverse": 7.23.5 + "@babel/types": 7.23.5 transitivePeerDependencies: - supports-color dev: true /@babel/[email protected]: - resolution: {integrity: sha512-C/BaXcnnvBCmHTpz/VGZ8jgtE2aYlW4hxDhseJAWZb7gqGM/qtCK6iZUb0TyKFf7BOUsBH7Q7fkRsDRhg1XklQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-C/BaXcnnvBCmHTpz/VGZ8jgtE2aYlW4hxDhseJAWZb7gqGM/qtCK6iZUb0TyKFf7BOUsBH7Q7fkRsDRhg1XklQ== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-validator-identifier': 7.22.20 + "@babel/helper-validator-identifier": 7.22.20 chalk: 2.4.2 js-tokens: 4.0.0 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-acGdbYSfp2WheJoJm/EBBBLh/ID8KDc64ISZ9DYtBmC8/Q204PZJLHyzeB5qMzJ5trcOkybd78M4x2KWsUq++A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-acGdbYSfp2WheJoJm/EBBBLh/ID8KDc64ISZ9DYtBmC8/Q204PZJLHyzeB5qMzJ5trcOkybd78M4x2KWsUq++A== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-validator-identifier': 7.22.20 + "@babel/helper-validator-identifier": 7.22.20 chalk: 2.4.2 js-tokens: 4.0.0 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-vvPKKdMemU85V9WE/l5wZEmImpCtLqbnTvqDS2U1fJ96KrxoW7KrXhNsNCblQlg8Ck4b85yxdTyelsMUgFUXiw==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-vvPKKdMemU85V9WE/l5wZEmImpCtLqbnTvqDS2U1fJ96KrxoW7KrXhNsNCblQlg8Ck4b85yxdTyelsMUgFUXiw== } + engines: { node: ">=6.0.0" } hasBin: true dependencies: - '@babel/types': 7.23.0 + "@babel/types": 7.23.0 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-hOOqoiNXrmGdFbhgCzu6GiURxUgM27Xwd/aPuu8RfHEZPBzL1Z54okAHAQjXfcQNwvrlkAmAp4SlRTZ45vlthQ==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-hOOqoiNXrmGdFbhgCzu6GiURxUgM27Xwd/aPuu8RfHEZPBzL1Z54okAHAQjXfcQNwvrlkAmAp4SlRTZ45vlthQ== } + engines: { node: ">=6.0.0" } hasBin: true dependencies: - '@babel/types': 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.23.3(@babel/[email protected]): - resolution: {integrity: sha512-iRkKcCqb7iGnq9+3G6rZ+Ciz5VywC4XNRHe57lKM+jOeYAoR0lVqdeeDRfh0tQcTfw/+vBhHn926FmQhLtlFLQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-iRkKcCqb7iGnq9+3G6rZ+Ciz5VywC4XNRHe57lKM+jOeYAoR0lVqdeeDRfh0tQcTfw/+vBhHn926FmQhLtlFLQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-WwlxbfMNdVEpQjZmK5mhm7oSwD3dS6eU+Iwsi4Knl9wAletWem7kaRsGOG+8UEbRyqxY4SS5zvtfXwX+jMxUwQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-WwlxbfMNdVEpQjZmK5mhm7oSwD3dS6eU+Iwsi4Knl9wAletWem7kaRsGOG+8UEbRyqxY4SS5zvtfXwX+jMxUwQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.13.0 + "@babel/core": ^7.13.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/plugin-transform-optional-chaining': 7.23.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-skip-transparent-expression-wrappers": 7.22.5 + "@babel/plugin-transform-optional-chaining": 7.23.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-XaJak1qcityzrX0/IU5nKHb34VaibwP3saKqG6a/tppelgllOH13LUann4ZCIBcVOeE6H18K4Vx9QKkVww3z/w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-XaJak1qcityzrX0/IU5nKHb34VaibwP3saKqG6a/tppelgllOH13LUann4ZCIBcVOeE6H18K4Vx9QKkVww3z/w== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2(@babel/[email protected]): - resolution: {integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 + "@babel/core": 7.23.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==} + resolution: + { integrity: sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==} + resolution: + { integrity: sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==} + resolution: + { integrity: sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==} + resolution: + { integrity: sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-lPgDSU+SJLK3xmFDTV2ZRQAiM7UuUjGidwBywFavObCiZc1BeAAcMtHJKUya92hPHO+at63JJPLygilZard8jw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-lPgDSU+SJLK3xmFDTV2ZRQAiM7UuUjGidwBywFavObCiZc1BeAAcMtHJKUya92hPHO+at63JJPLygilZard8jw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-pawnE0P9g10xgoP7yKr6CK63K2FMsTE+FZidZO/1PwRdzmAPVs+HS1mAURUsgaoxammTJvULUdIkEK0gOcU2tA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-pawnE0P9g10xgoP7yKr6CK63K2FMsTE+FZidZO/1PwRdzmAPVs+HS1mAURUsgaoxammTJvULUdIkEK0gOcU2tA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==} + resolution: + { integrity: sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==} + resolution: + { integrity: sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==} + resolution: + { integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==} + resolution: + { integrity: sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==} + resolution: + { integrity: sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==} + resolution: + { integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==} + resolution: + { integrity: sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==} + resolution: + { integrity: sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg== } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-NzQcQrzaQPkaEwoTm4Mhyl8jI1huEL/WWIEvudjTCMJ9aBZNpsJbMASx7EQECtQQPS/DcnFpo0FIh3LvEO9cxQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-NzQcQrzaQPkaEwoTm4Mhyl8jI1huEL/WWIEvudjTCMJ9aBZNpsJbMASx7EQECtQQPS/DcnFpo0FIh3LvEO9cxQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-59GsVNavGxAXCDDbakWSMJhajASb4kBCqDjqJsv+p5nKdbz7istmZ3HrX3L2LuiI80+zsOADCvooqQH3qGCucQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-59GsVNavGxAXCDDbakWSMJhajASb4kBCqDjqJsv+p5nKdbz7istmZ3HrX3L2LuiI80+zsOADCvooqQH3qGCucQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-remap-async-to-generator': 7.22.20(@babel/[email protected]) - '@babel/plugin-syntax-async-generators': 7.8.4(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-remap-async-to-generator": 7.22.20(@babel/[email protected]) + "@babel/plugin-syntax-async-generators": 7.8.4(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-A7LFsKi4U4fomjqXJlZg/u0ft/n8/7n7lpffUP/ZULx/DtV9SGlNKZolHH6PE8Xl1ngCc0M11OaeZptXVkfKSw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-A7LFsKi4U4fomjqXJlZg/u0ft/n8/7n7lpffUP/ZULx/DtV9SGlNKZolHH6PE8Xl1ngCc0M11OaeZptXVkfKSw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-module-imports': 7.22.15 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-remap-async-to-generator': 7.22.20(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-module-imports": 7.22.15 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-remap-async-to-generator": 7.22.20(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vI+0sIaPIO6CNuM9Kk5VmXcMVRiOpDh7w2zZt9GXzmE/9KD70CUEVhvPR/etAeNK/FAEkhxQtXOzVF3EuRL41A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-vI+0sIaPIO6CNuM9Kk5VmXcMVRiOpDh7w2zZt9GXzmE/9KD70CUEVhvPR/etAeNK/FAEkhxQtXOzVF3EuRL41A== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-QPZxHrThbQia7UdvfpaRRlq/J9ciz1J4go0k+lPBXbgaNeY7IQrBj/9ceWjvMMI07/ZBzHl/F0R/2K0qH7jCVw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-QPZxHrThbQia7UdvfpaRRlq/J9ciz1J4go0k+lPBXbgaNeY7IQrBj/9ceWjvMMI07/ZBzHl/F0R/2K0qH7jCVw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-uM+AN8yCIjDPccsKGlw271xjJtGii+xQIF/uMPS8H15L12jZTsLfF4o5vNO7d/oUguOyfdikHGc/yi9ge4SGIg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-uM+AN8yCIjDPccsKGlw271xjJtGii+xQIF/uMPS8H15L12jZTsLfF4o5vNO7d/oUguOyfdikHGc/yi9ge4SGIg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-class-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-class-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-PENDVxdr7ZxKPyi5Ffc0LjXdnJyrJxyqF5T5YjlVg4a0VFfQHW0r8iAtRiDXkfHlu1wwcvdtnndGYIeJLSuRMQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-PENDVxdr7ZxKPyi5Ffc0LjXdnJyrJxyqF5T5YjlVg4a0VFfQHW0r8iAtRiDXkfHlu1wwcvdtnndGYIeJLSuRMQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.12.0 + "@babel/core": ^7.12.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-class-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-create-class-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-class-static-block": 7.14.5(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-FGEQmugvAEu2QtgtU0uTASXevfLMFfBeVCIIdcQhn/uBQsMTjBajdnAtanQlOcuihWh10PZ7+HWvc7NtBwP74w==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.23.5 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-function-name': 7.23.0 - '@babel/helper-optimise-call-expression': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-replace-supers': 7.22.20(@babel/[email protected]) - '@babel/helper-split-export-declaration': 7.22.6 + resolution: + { integrity: sha512-FGEQmugvAEu2QtgtU0uTASXevfLMFfBeVCIIdcQhn/uBQsMTjBajdnAtanQlOcuihWh10PZ7+HWvc7NtBwP74w== } + engines: { node: ">=6.9.0" } + peerDependencies: + "@babel/core": ^7.0.0-0 + dependencies: + "@babel/core": 7.23.5 + "@babel/helper-annotate-as-pure": 7.22.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-function-name": 7.23.0 + "@babel/helper-optimise-call-expression": 7.22.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-replace-supers": 7.22.20(@babel/[email protected]) + "@babel/helper-split-export-declaration": 7.22.6 globals: 11.12.0 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-dTj83UVTLw/+nbiHqQSFdwO9CbTtwq1DsDqm3CUEtDrZNET5rT5E6bIdTlOftDTDLMYxvxHNEYO4B9SLl8SLZw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-dTj83UVTLw/+nbiHqQSFdwO9CbTtwq1DsDqm3CUEtDrZNET5rT5E6bIdTlOftDTDLMYxvxHNEYO4B9SLl8SLZw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/template': 7.22.15 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/template": 7.22.15 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-n225npDqjDIr967cMScVKHXJs7rout1q+tt50inyBCPkyZ8KxeI6d+GIbSBTT/w/9WdlWDOej3V9HE5Lgk57gw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-n225npDqjDIr967cMScVKHXJs7rout1q+tt50inyBCPkyZ8KxeI6d+GIbSBTT/w/9WdlWDOej3V9HE5Lgk57gw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vgnFYDHAKzFaTVp+mneDsIEbnJ2Np/9ng9iviHw3P/KVcgONxpNULEW/51Z/BaFojG2GI2GwwXck5uV1+1NOYQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-vgnFYDHAKzFaTVp+mneDsIEbnJ2Np/9ng9iviHw3P/KVcgONxpNULEW/51Z/BaFojG2GI2GwwXck5uV1+1NOYQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-RrqQ+BQmU3Oyav3J+7/myfvRCq7Tbz+kKLLshUmMwNlDHExbGL7ARhajvoBJEvc+fCguPPu887N+3RRXBVKZUA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-RrqQ+BQmU3Oyav3J+7/myfvRCq7Tbz+kKLLshUmMwNlDHExbGL7ARhajvoBJEvc+fCguPPu887N+3RRXBVKZUA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vTG+cTGxPFou12Rj7ll+eD5yWeNl5/8xvQvF08y5Gv3v4mZQoyFf8/n9zg4q5vvCWt5jmgymfzMAldO7orBn7A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-vTG+cTGxPFou12Rj7ll+eD5yWeNl5/8xvQvF08y5Gv3v4mZQoyFf8/n9zg4q5vvCWt5jmgymfzMAldO7orBn7A== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-dynamic-import": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5fhCsl1odX96u7ILKHBj4/Y8vipoqwsJMh4csSA8qFfxrZDEA4Ssku2DyNvMJSmZNOEBT750LfFPbtrnTP90BQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-5fhCsl1odX96u7ILKHBj4/Y8vipoqwsJMh4csSA8qFfxrZDEA4Ssku2DyNvMJSmZNOEBT750LfFPbtrnTP90BQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-builder-binary-assignment-operator-visitor': 7.22.15 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-builder-binary-assignment-operator-visitor": 7.22.15 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-yCLhW34wpJWRdTxxWtFZASJisihrfyMOTOQexhVzA78jlU+dH7Dw+zQgcPepQ5F3C6bAIiblZZ+qBggJdHiBAg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-yCLhW34wpJWRdTxxWtFZASJisihrfyMOTOQexhVzA78jlU+dH7Dw+zQgcPepQ5F3C6bAIiblZZ+qBggJdHiBAg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-export-namespace-from": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-X8jSm8X1CMwxmK878qsUGJRmbysKNbdpTv/O1/v0LuY/ZkZrng5WYiekYSdg9m09OTmDDUWeEDsTE+17WYbAZw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-X8jSm8X1CMwxmK878qsUGJRmbysKNbdpTv/O1/v0LuY/ZkZrng5WYiekYSdg9m09OTmDDUWeEDsTE+17WYbAZw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-I1QXp1LxIvt8yLaib49dRW5Okt7Q4oaxao6tFVKS/anCdEOMtYwWVKoiOA1p34GOWIZjUK0E+zCp7+l1pfQyiw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-I1QXp1LxIvt8yLaib49dRW5Okt7Q4oaxao6tFVKS/anCdEOMtYwWVKoiOA1p34GOWIZjUK0E+zCp7+l1pfQyiw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-function-name': 7.23.0 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-function-name": 7.23.0 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-H9Ej2OiISIZowZHaBwF0tsJOih1PftXJtE8EWqlEIwpc7LMTGq0rPOrywKLQ4nefzx8/HMR0D3JGXoMHYvhi0A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-H9Ej2OiISIZowZHaBwF0tsJOih1PftXJtE8EWqlEIwpc7LMTGq0rPOrywKLQ4nefzx8/HMR0D3JGXoMHYvhi0A== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-json-strings': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-json-strings": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-wZ0PIXRxnwZvl9AYpqNUxpZ5BiTGrYt7kueGQ+N5FiQ7RCOD4cm8iShd6S6ggfVIWaJf2EMk8eRzAh52RfP4rQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-wZ0PIXRxnwZvl9AYpqNUxpZ5BiTGrYt7kueGQ+N5FiQ7RCOD4cm8iShd6S6ggfVIWaJf2EMk8eRzAh52RfP4rQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-+pD5ZbxofyOygEp+zZAfujY2ShNCXRpDRIPOiBmTO693hhyOEteZgl876Xs9SAHPQpcV0vz8LvA/T+w8AzyX8A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-+pD5ZbxofyOygEp+zZAfujY2ShNCXRpDRIPOiBmTO693hhyOEteZgl876Xs9SAHPQpcV0vz8LvA/T+w8AzyX8A== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-logical-assignment-operators": 7.10.4(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-sC3LdDBDi5x96LA+Ytekz2ZPk8i/Ck+DEuDbRAll5rknJ5XRTSaPKEYwomLcs1AA8wg9b3KjIQRsnApj+q51Ag==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-sC3LdDBDi5x96LA+Ytekz2ZPk8i/Ck+DEuDbRAll5rknJ5XRTSaPKEYwomLcs1AA8wg9b3KjIQRsnApj+q51Ag== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vJYQGxeKM4t8hYCKVBlZX/gtIY2I7mRGFNcm85sgXGMTBcoV3QdVtdpbcWEbzbfUIUZKwvgFT82mRvaQIebZzw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-vJYQGxeKM4t8hYCKVBlZX/gtIY2I7mRGFNcm85sgXGMTBcoV3QdVtdpbcWEbzbfUIUZKwvgFT82mRvaQIebZzw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-module-transforms': 7.23.3(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-module-transforms": 7.23.3(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-aVS0F65LKsdNOtcz6FRCpE4OgsP2OFnW46qNxNIX9h3wuzaNcSQsJysuMwqSibC98HPrf2vCgtxKNwS0DAlgcA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-aVS0F65LKsdNOtcz6FRCpE4OgsP2OFnW46qNxNIX9h3wuzaNcSQsJysuMwqSibC98HPrf2vCgtxKNwS0DAlgcA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-module-transforms': 7.23.3(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-simple-access': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-module-transforms": 7.23.3(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-simple-access": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-ZxyKGTkF9xT9YJuKQRo19ewf3pXpopuYQd8cDXqNzc3mUNbOME0RKMoZxviQk74hwzfQsEe66dE92MaZbdHKNQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-ZxyKGTkF9xT9YJuKQRo19ewf3pXpopuYQd8cDXqNzc3mUNbOME0RKMoZxviQk74hwzfQsEe66dE92MaZbdHKNQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-hoist-variables': 7.22.5 - '@babel/helper-module-transforms': 7.23.3(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-validator-identifier': 7.22.20 + "@babel/core": 7.23.5 + "@babel/helper-hoist-variables": 7.22.5 + "@babel/helper-module-transforms": 7.23.3(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-validator-identifier": 7.22.20 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-zHsy9iXX2nIsCBFPud3jKn1IRPWg3Ing1qOZgeKV39m1ZgIdpJqvlWVeiHBZC6ITRG0MfskhYe9cLgntfSFPIg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-zHsy9iXX2nIsCBFPud3jKn1IRPWg3Ing1qOZgeKV39m1ZgIdpJqvlWVeiHBZC6ITRG0MfskhYe9cLgntfSFPIg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-module-transforms': 7.23.3(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-module-transforms": 7.23.3(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-YJ3xKqtJMAT5/TIZnpAR3I+K+WaDowYbN3xyxI8zxx/Gsypwf9B9h0VB+1Nh6ACAAPRS5NSRje0uVv5i79HYGQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-YJ3xKqtJMAT5/TIZnpAR3I+K+WaDowYbN3xyxI8zxx/Gsypwf9B9h0VB+1Nh6ACAAPRS5NSRje0uVv5i79HYGQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-xzg24Lnld4DYIdysyf07zJ1P+iIfJpxtVFOzX4g+bsJ3Ng5Le7rXx9KwqKzuyaUeRnt+I1EICwQITqc0E2PmpA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-xzg24Lnld4DYIdysyf07zJ1P+iIfJpxtVFOzX4g+bsJ3Ng5Le7rXx9KwqKzuyaUeRnt+I1EICwQITqc0E2PmpA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-nullish-coalescing-operator": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-s9GO7fIBi/BLsZ0v3Rftr6Oe4t0ctJ8h4CCXfPoEJwmvAPMyNrfkOOJzm6b9PX9YXcCJWWQd/sBF/N26eBiMVw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-s9GO7fIBi/BLsZ0v3Rftr6Oe4t0ctJ8h4CCXfPoEJwmvAPMyNrfkOOJzm6b9PX9YXcCJWWQd/sBF/N26eBiMVw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-numeric-separator": 7.10.4(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-VxHt0ANkDmu8TANdE9Kc0rndo/ccsmfe2Cx2y5sI4hu3AukHQ5wAu4cM7j3ba8B9548ijVyclBU+nuDQftZsog==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-VxHt0ANkDmu8TANdE9Kc0rndo/ccsmfe2Cx2y5sI4hu3AukHQ5wAu4cM7j3ba8B9548ijVyclBU+nuDQftZsog== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/compat-data': 7.23.3 - '@babel/core': 7.23.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/[email protected]) - '@babel/plugin-transform-parameters': 7.23.3(@babel/[email protected]) + "@babel/compat-data": 7.23.3 + "@babel/core": 7.23.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-object-rest-spread": 7.8.3(@babel/[email protected]) + "@babel/plugin-transform-parameters": 7.23.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-BwQ8q0x2JG+3lxCVFohg+KbQM7plfpBwThdW9A6TMtWwLsbDA01Ek2Zb/AgDN39BiZsExm4qrXxjk+P1/fzGrA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-BwQ8q0x2JG+3lxCVFohg+KbQM7plfpBwThdW9A6TMtWwLsbDA01Ek2Zb/AgDN39BiZsExm4qrXxjk+P1/fzGrA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-replace-supers': 7.22.20(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-replace-supers": 7.22.20(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-LxYSb0iLjUamfm7f1D7GpiS4j0UAC8AOiehnsGAP8BEsIX8EOi3qV6bbctw8M7ZvLtcoZfZX5Z7rN9PlWk0m5A==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-LxYSb0iLjUamfm7f1D7GpiS4j0UAC8AOiehnsGAP8BEsIX8EOi3qV6bbctw8M7ZvLtcoZfZX5Z7rN9PlWk0m5A== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-optional-catch-binding": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-zvL8vIfIUgMccIAK1lxjvNv572JHFJIKb4MWBz5OGdBQA0fB0Xluix5rmOby48exiJc987neOmP/m9Fnpkz3Tg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-zvL8vIfIUgMccIAK1lxjvNv572JHFJIKb4MWBz5OGdBQA0fB0Xluix5rmOby48exiJc987neOmP/m9Fnpkz3Tg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-skip-transparent-expression-wrappers": 7.22.5 + "@babel/plugin-syntax-optional-chaining": 7.8.3(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-09lMt6UsUb3/34BbECKVbVwrT9bO6lILWln237z7sLaWnMsTi7Yc9fhX5DLpkJzAGfaReXI22wP41SZmnAA3Vw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-09lMt6UsUb3/34BbECKVbVwrT9bO6lILWln237z7sLaWnMsTi7Yc9fhX5DLpkJzAGfaReXI22wP41SZmnAA3Vw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-UzqRcRtWsDMTLrRWFvUBDwmw06tCQH9Rl1uAjfh6ijMSmGYQ+fpdB+cnqRC8EMh5tuuxSv0/TejGL+7vyj+50g==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-UzqRcRtWsDMTLrRWFvUBDwmw06tCQH9Rl1uAjfh6ijMSmGYQ+fpdB+cnqRC8EMh5tuuxSv0/TejGL+7vyj+50g== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-class-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-class-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-a5m2oLNFyje2e/rGKjVfAELTVI5mbA0FeZpBnkOWWV7eSmKQ+T/XW0Vf+29ScLzSxX+rnsarvU0oie/4m6hkxA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-a5m2oLNFyje2e/rGKjVfAELTVI5mbA0FeZpBnkOWWV7eSmKQ+T/XW0Vf+29ScLzSxX+rnsarvU0oie/4m6hkxA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-create-class-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-annotate-as-pure": 7.22.5 + "@babel/helper-create-class-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 + "@babel/plugin-syntax-private-property-in-object": 7.14.5(@babel/[email protected]) dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-jR3Jn3y7cZp4oEWPFAlRsSWjxKe4PZILGBSd4nis1TsC5qeSpb+nrtihJuDhNI7QHiVbUaiXa0X2RZY3/TI6Nw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-jR3Jn3y7cZp4oEWPFAlRsSWjxKe4PZILGBSd4nis1TsC5qeSpb+nrtihJuDhNI7QHiVbUaiXa0X2RZY3/TI6Nw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-KP+75h0KghBMcVpuKisx3XTu9Ncut8Q8TuvGO4IhY+9D5DFEckQefOuIsB/gQ2tG71lCke4NMrtIPS8pOj18BQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-KP+75h0KghBMcVpuKisx3XTu9Ncut8Q8TuvGO4IhY+9D5DFEckQefOuIsB/gQ2tG71lCke4NMrtIPS8pOj18BQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 regenerator-transform: 0.15.2 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-QnNTazY54YqgGxwIexMZva9gqbPa15t/x9VS+0fsEFWplwVpXYZivtgl43Z1vMpc1bdPP2PP8siFeVcnFvA3Cg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-QnNTazY54YqgGxwIexMZva9gqbPa15t/x9VS+0fsEFWplwVpXYZivtgl43Z1vMpc1bdPP2PP8siFeVcnFvA3Cg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-ED2fgqZLmexWiN+YNFX26fx4gh5qHDhn1O2gvEhreLW2iI63Sqm4llRLCXALKrCnbN4Jy0VcMQZl/SAzqug/jg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-ED2fgqZLmexWiN+YNFX26fx4gh5qHDhn1O2gvEhreLW2iI63Sqm4llRLCXALKrCnbN4Jy0VcMQZl/SAzqug/jg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-VvfVYlrlBVu+77xVTOAoxQ6mZbnIq5FM0aGBSFEcIh03qHf+zNqA4DC/3XMUozTg7bZV3e3mZQ0i13VB6v5yUg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-VvfVYlrlBVu+77xVTOAoxQ6mZbnIq5FM0aGBSFEcIh03qHf+zNqA4DC/3XMUozTg7bZV3e3mZQ0i13VB6v5yUg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-skip-transparent-expression-wrappers": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-HZOyN9g+rtvnOU3Yh7kSxXrKbzgrm5X4GncPY1QOquu7epga5MxKHVpYu2hvQnry/H+JjckSYRb93iNfsioAGg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-HZOyN9g+rtvnOU3Yh7kSxXrKbzgrm5X4GncPY1QOquu7epga5MxKHVpYu2hvQnry/H+JjckSYRb93iNfsioAGg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Flok06AYNp7GV2oJPZZcP9vZdszev6vPBkHLwxwSpaIqx75wn6mUd3UFWsSsA0l8nXAKkyCmL/sR02m8RYGeHg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-Flok06AYNp7GV2oJPZZcP9vZdszev6vPBkHLwxwSpaIqx75wn6mUd3UFWsSsA0l8nXAKkyCmL/sR02m8RYGeHg== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-4t15ViVnaFdrPC74be1gXBSMzXk3B4Us9lP7uLRQHTFpV5Dvt33pn+2MyyNxmN3VTTm3oTrZVMUmuw3oBnQ2oQ==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-4t15ViVnaFdrPC74be1gXBSMzXk3B4Us9lP7uLRQHTFpV5Dvt33pn+2MyyNxmN3VTTm3oTrZVMUmuw3oBnQ2oQ== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-OMCUx/bU6ChE3r4+ZdylEqAjaQgHAgipgW8nsCfu5pGqDcFytVd91AwRvUJSBZDz0exPGgnjoqhgRYLRjFZc9Q==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-OMCUx/bU6ChE3r4+ZdylEqAjaQgHAgipgW8nsCfu5pGqDcFytVd91AwRvUJSBZDz0exPGgnjoqhgRYLRjFZc9Q== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-KcLIm+pDZkWZQAFJ9pdfmh89EwVfmNovFBcXko8szpBeF8z68kWIPeKlmSOkT9BXJxs2C0uk+5LxoxIv62MROA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-KcLIm+pDZkWZQAFJ9pdfmh89EwVfmNovFBcXko8szpBeF8z68kWIPeKlmSOkT9BXJxs2C0uk+5LxoxIv62MROA== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-wMHpNA4x2cIA32b/ci3AfwNgheiva2W0WUKWTK7vBHBhDKfPsc5cFGNWm69WBqpwd86u1qwZ9PWevKqm1A3yAw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-wMHpNA4x2cIA32b/ci3AfwNgheiva2W0WUKWTK7vBHBhDKfPsc5cFGNWm69WBqpwd86u1qwZ9PWevKqm1A3yAw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0-0 + "@babel/core": ^7.0.0-0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-W7lliA/v9bNR83Qc3q1ip9CQMZ09CcHDbHfbLRDNuAhn1Mvkr1ZNF7hPmztMQvtTGVLJ9m8IZqWsTkXOml8dbw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-W7lliA/v9bNR83Qc3q1ip9CQMZ09CcHDbHfbLRDNuAhn1Mvkr1ZNF7hPmztMQvtTGVLJ9m8IZqWsTkXOml8dbw== } + engines: { node: ">=6.9.0" } peerDependencies: - '@babel/core': ^7.0.0 + "@babel/core": ^7.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 + "@babel/core": 7.23.5 + "@babel/helper-create-regexp-features-plugin": 7.22.15(@babel/[email protected]) + "@babel/helper-plugin-utils": 7.22.5 dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-ovzGc2uuyNfNAs/jyjIGxS8arOHS5FENZaNn4rtE7UdKMMkqHCvboHfcuhWLZNX5cB44QfcGNWjaevxMzzMf+Q==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/compat-data': 7.23.3 - '@babel/core': 7.23.5 - '@babel/helper-compilation-targets': 7.22.15 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-validator-option': 7.22.15 - '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression': 7.23.3(@babel/[email protected]) - '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining': 7.23.3(@babel/[email protected]) - '@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly': 7.23.3(@babel/[email protected]) - '@babel/plugin-proposal-private-property-in-object': 7.21.0-placeholder-for-preset-env.2(@babel/[email protected]) - '@babel/plugin-syntax-async-generators': 7.8.4(@babel/[email protected]) - '@babel/plugin-syntax-class-properties': 7.12.13(@babel/[email protected]) - '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-import-assertions': 7.23.3(@babel/[email protected]) - '@babel/plugin-syntax-import-attributes': 7.23.3(@babel/[email protected]) - '@babel/plugin-syntax-import-meta': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-json-strings': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-top-level-await': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-unicode-sets-regex': 7.18.6(@babel/[email protected]) - '@babel/plugin-transform-arrow-functions': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-async-generator-functions': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-async-to-generator': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-block-scoped-functions': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-block-scoping': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-class-properties': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-class-static-block': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-classes': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-computed-properties': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-destructuring': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-dotall-regex': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-duplicate-keys': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-dynamic-import': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-exponentiation-operator': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-export-namespace-from': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-for-of': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-function-name': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-json-strings': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-literals': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-logical-assignment-operators': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-member-expression-literals': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-modules-amd': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-modules-commonjs': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-modules-systemjs': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-modules-umd': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-named-capturing-groups-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-new-target': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-nullish-coalescing-operator': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-numeric-separator': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-object-rest-spread': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-object-super': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-optional-catch-binding': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-optional-chaining': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-parameters': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-private-methods': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-private-property-in-object': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-property-literals': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-regenerator': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-reserved-words': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-shorthand-properties': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-spread': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-sticky-regex': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-template-literals': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-typeof-symbol': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-unicode-escapes': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-unicode-property-regex': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-unicode-regex': 7.23.3(@babel/[email protected]) - '@babel/plugin-transform-unicode-sets-regex': 7.23.3(@babel/[email protected]) - '@babel/preset-modules': 0.1.6-no-external-plugins(@babel/[email protected]) + resolution: + { integrity: sha512-ovzGc2uuyNfNAs/jyjIGxS8arOHS5FENZaNn4rtE7UdKMMkqHCvboHfcuhWLZNX5cB44QfcGNWjaevxMzzMf+Q== } + engines: { node: ">=6.9.0" } + peerDependencies: + "@babel/core": ^7.0.0-0 + dependencies: + "@babel/compat-data": 7.23.3 + "@babel/core": 7.23.5 + "@babel/helper-compilation-targets": 7.22.15 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/helper-validator-option": 7.22.15 + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": 7.23.3(@babel/[email protected]) + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": 7.23.3(@babel/[email protected]) + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": 7.23.3(@babel/[email protected]) + "@babel/plugin-proposal-private-property-in-object": 7.21.0-placeholder-for-preset-env.2(@babel/[email protected]) + "@babel/plugin-syntax-async-generators": 7.8.4(@babel/[email protected]) + "@babel/plugin-syntax-class-properties": 7.12.13(@babel/[email protected]) + "@babel/plugin-syntax-class-static-block": 7.14.5(@babel/[email protected]) + "@babel/plugin-syntax-dynamic-import": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-export-namespace-from": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-import-assertions": 7.23.3(@babel/[email protected]) + "@babel/plugin-syntax-import-attributes": 7.23.3(@babel/[email protected]) + "@babel/plugin-syntax-import-meta": 7.10.4(@babel/[email protected]) + "@babel/plugin-syntax-json-strings": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-logical-assignment-operators": 7.10.4(@babel/[email protected]) + "@babel/plugin-syntax-nullish-coalescing-operator": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-numeric-separator": 7.10.4(@babel/[email protected]) + "@babel/plugin-syntax-object-rest-spread": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-optional-catch-binding": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-optional-chaining": 7.8.3(@babel/[email protected]) + "@babel/plugin-syntax-private-property-in-object": 7.14.5(@babel/[email protected]) + "@babel/plugin-syntax-top-level-await": 7.14.5(@babel/[email protected]) + "@babel/plugin-syntax-unicode-sets-regex": 7.18.6(@babel/[email protected]) + "@babel/plugin-transform-arrow-functions": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-async-generator-functions": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-async-to-generator": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-block-scoped-functions": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-block-scoping": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-class-properties": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-class-static-block": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-classes": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-computed-properties": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-destructuring": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-dotall-regex": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-duplicate-keys": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-dynamic-import": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-exponentiation-operator": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-export-namespace-from": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-for-of": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-function-name": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-json-strings": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-literals": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-logical-assignment-operators": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-member-expression-literals": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-modules-amd": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-modules-commonjs": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-modules-systemjs": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-modules-umd": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-named-capturing-groups-regex": 7.22.5(@babel/[email protected]) + "@babel/plugin-transform-new-target": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-nullish-coalescing-operator": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-numeric-separator": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-object-rest-spread": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-object-super": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-optional-catch-binding": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-optional-chaining": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-parameters": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-private-methods": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-private-property-in-object": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-property-literals": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-regenerator": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-reserved-words": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-shorthand-properties": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-spread": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-sticky-regex": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-template-literals": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-typeof-symbol": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-unicode-escapes": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-unicode-property-regex": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-unicode-regex": 7.23.3(@babel/[email protected]) + "@babel/plugin-transform-unicode-sets-regex": 7.23.3(@babel/[email protected]) + "@babel/preset-modules": 0.1.6-no-external-plugins(@babel/[email protected]) babel-plugin-polyfill-corejs2: 0.4.6(@babel/[email protected]) babel-plugin-polyfill-corejs3: 0.8.5(@babel/[email protected]) babel-plugin-polyfill-regenerator: 0.5.3(@babel/[email protected]) @@ -2779,48 +2886,53 @@ packages: dev: true /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==} + resolution: + { integrity: sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA== } peerDependencies: - '@babel/core': ^7.0.0-0 \|\| ^8.0.0-0 <8.0.0 + "@babel/core": ^7.0.0-0 \|\| ^8.0.0-0 <8.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/types': 7.23.3 + "@babel/core": 7.23.5 + "@babel/helper-plugin-utils": 7.22.5 + "@babel/types": 7.23.3 esutils: 2.0.3 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==} + resolution: + { integrity: sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA== } dev: true /@babel/[email protected]: - resolution: {integrity: sha512-8jI69toZqqcsnqGGqwGS4Qb1VwLOEp4hz+CXPywcvjs60u3B4Pom/U/7rm4W8tMOYEB+E9wgD0mW1l3r8qlI9Q==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-8jI69toZqqcsnqGGqwGS4Qb1VwLOEp4hz+CXPywcvjs60u3B4Pom/U/7rm4W8tMOYEB+E9wgD0mW1l3r8qlI9Q== } + engines: { node: ">=6.9.0" } dependencies: regenerator-runtime: 0.13.11 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-QPErUVm4uyJa60rkI73qneDacvdvzxshT3kksGqlGWYdOTIUOwJ7RDUL8sGqslY1uXWSL6xMFKEXDS3ox2uF0w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-QPErUVm4uyJa60rkI73qneDacvdvzxshT3kksGqlGWYdOTIUOwJ7RDUL8sGqslY1uXWSL6xMFKEXDS3ox2uF0w== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/code-frame': 7.23.5 - '@babel/parser': 7.23.5 - '@babel/types': 7.23.5 + "@babel/code-frame": 7.23.5 + "@babel/parser": 7.23.5 + "@babel/types": 7.23.5 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-czx7Xy5a6sapWWRx61m1Ke1Ra4vczu1mCTtJam5zRTBOonfdJ+S/B6HYmGYu3fJtr8GGET3si6IhgWVBhJ/m8w==} - engines: {node: '>=6.9.0'} - dependencies: - '@babel/code-frame': 7.23.5 - '@babel/generator': 7.23.5 - '@babel/helper-environment-visitor': 7.22.20 - '@babel/helper-function-name': 7.23.0 - '@babel/helper-hoist-variables': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 - '@babel/parser': 7.23.5 - '@babel/types': 7.23.5 + resolution: + { integrity: sha512-czx7Xy5a6sapWWRx61m1Ke1Ra4vczu1mCTtJam5zRTBOonfdJ+S/B6HYmGYu3fJtr8GGET3si6IhgWVBhJ/m8w== } + engines: { node: ">=6.9.0" } + dependencies: + "@babel/code-frame": 7.23.5 + "@babel/generator": 7.23.5 + "@babel/helper-environment-visitor": 7.22.20 + "@babel/helper-function-name": 7.23.0 + "@babel/helper-hoist-variables": 7.22.5 + "@babel/helper-split-export-declaration": 7.22.6 + "@babel/parser": 7.23.5 + "@babel/types": 7.23.5 debug: 4.3.4([email protected]) globals: 11.12.0 transitivePeerDependencies: @@ -2828,52 +2940,58 @@ packages: dev: true /@babel/[email protected]: - resolution: {integrity: sha512-0oIyUfKoI3mSqMvsxBdclDwxXKXAUA8v/apZbc+iSyARYou1o8ZGDxbUYyLFoW2arqS2jDGqJuZvv1d/io1axg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-0oIyUfKoI3mSqMvsxBdclDwxXKXAUA8v/apZbc+iSyARYou1o8ZGDxbUYyLFoW2arqS2jDGqJuZvv1d/io1axg== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-string-parser': 7.22.5 - '@babel/helper-validator-identifier': 7.22.20 + "@babel/helper-string-parser": 7.22.5 + "@babel/helper-validator-identifier": 7.22.20 to-fast-properties: 2.0.0 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-OZnvoH2l8PK5eUvEcUyCt/sXgr/h+UWpVuBbOljwcrAgUl6lpchoQ++PHGyQy1AtYnVA6CEq3y5xeEI10brpXw==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-OZnvoH2l8PK5eUvEcUyCt/sXgr/h+UWpVuBbOljwcrAgUl6lpchoQ++PHGyQy1AtYnVA6CEq3y5xeEI10brpXw== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-string-parser': 7.22.5 - '@babel/helper-validator-identifier': 7.22.20 + "@babel/helper-string-parser": 7.22.5 + "@babel/helper-validator-identifier": 7.22.20 to-fast-properties: 2.0.0 dev: true /@babel/[email protected]: - resolution: {integrity: sha512-ON5kSOJwVO6xXVRTvOI0eOnWe7VdUcIpsovGo9U/Br4Ie4UVFQTboO2cYnDhAGU6Fp+UxSiT+pMft0SMHfuq6w==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-ON5kSOJwVO6xXVRTvOI0eOnWe7VdUcIpsovGo9U/Br4Ie4UVFQTboO2cYnDhAGU6Fp+UxSiT+pMft0SMHfuq6w== } + engines: { node: ">=6.9.0" } dependencies: - '@babel/helper-string-parser': 7.23.4 - '@babel/helper-validator-identifier': 7.22.20 + "@babel/helper-string-parser": 7.23.4 + "@babel/helper-validator-identifier": 7.22.20 to-fast-properties: 2.0.0 dev: true /@colors/[email protected]: - resolution: {integrity: sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==} - engines: {node: '>=0.1.90'} + resolution: + { integrity: sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ== } + engines: { node: ">=0.1.90" } dev: true /@colors/[email protected]: - resolution: {integrity: sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA==} - engines: {node: '>=0.1.90'} + resolution: + { integrity: sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA== } + engines: { node: ">=0.1.90" } dev: true /@commitlint/[email protected]([email protected]): - resolution: {integrity: sha512-zop98yfB3A6NveYAZ3P1Mb6bIXuCeWgnUfVNkH4yhIMQpQfzFwseadazOuSn0OOfTt0lWuFauehpm9GcqM5lww==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-zop98yfB3A6NveYAZ3P1Mb6bIXuCeWgnUfVNkH4yhIMQpQfzFwseadazOuSn0OOfTt0lWuFauehpm9GcqM5lww== } + engines: { node: ">=v18" } hasBin: true dependencies: - '@commitlint/format': 18.4.3 - '@commitlint/lint': 18.4.3 - '@commitlint/load': 18.4.3([email protected]) - '@commitlint/read': 18.4.3 - '@commitlint/types': 18.4.3 + "@commitlint/format": 18.4.3 + "@commitlint/lint": 18.4.3 + "@commitlint/load": 18.4.3([email protected]) + "@commitlint/read": 18.4.3 + "@commitlint/types": 18.4.3 execa: 5.1.1 lodash.isfunction: 3.0.9 resolve-from: 5.0.0 @@ -2884,25 +3002,28 @@ packages: dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-729eRRaNta7JZF07qf6SAGSghoDEp9mH7yHU0m7ff0q89W97wDrWCyZ3yoV3mcQJwbhlmVmZPTkPcm7qiAu8WA==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-729eRRaNta7JZF07qf6SAGSghoDEp9mH7yHU0m7ff0q89W97wDrWCyZ3yoV3mcQJwbhlmVmZPTkPcm7qiAu8WA== } + engines: { node: ">=v18" } dependencies: conventional-changelog-conventionalcommits: 7.0.2 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-FPZZmTJBARPCyef9ohRC9EANiQEKSWIdatx5OlgeHKu878dWwpyeFauVkhzuBRJFcCA4Uvz/FDtlDKs008IHcA==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-FPZZmTJBARPCyef9ohRC9EANiQEKSWIdatx5OlgeHKu878dWwpyeFauVkhzuBRJFcCA4Uvz/FDtlDKs008IHcA== } + engines: { node: ">=v18" } dependencies: - '@commitlint/types': 18.4.3 + "@commitlint/types": 18.4.3 ajv: 8.12.0 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-MI4fwD9TWDVn4plF5+7JUyLLbkOdzIRBmVeNlk4dcGlkrVA+/l5GLcpN66q9LkFsFv6G2X31y89ApA3hqnqIFg==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-MI4fwD9TWDVn4plF5+7JUyLLbkOdzIRBmVeNlk4dcGlkrVA+/l5GLcpN66q9LkFsFv6G2X31y89ApA3hqnqIFg== } + engines: { node: ">=v18" } dependencies: - '@commitlint/types': 18.4.3 + "@commitlint/types": 18.4.3 lodash.camelcase: 4.3.0 lodash.kebabcase: 4.1.1 lodash.snakecase: 4.1.1 @@ -2911,45 +3032,50 @@ packages: dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-t7FM4c+BdX9WWZCPrrbV5+0SWLgT3kCq7e7/GhHCreYifg3V8qyvO127HF796vyFql75n4TFF+5v1asOOWkV1Q==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-t7FM4c+BdX9WWZCPrrbV5+0SWLgT3kCq7e7/GhHCreYifg3V8qyvO127HF796vyFql75n4TFF+5v1asOOWkV1Q== } + engines: { node: ">=v18" } dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-8b+ItXYHxAhRAXFfYki5PpbuMMOmXYuzLxib65z2XTqki59YDQJGpJ/wB1kEE5MQDgSTQWtKUrA8n9zS/1uIDQ==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-8b+ItXYHxAhRAXFfYki5PpbuMMOmXYuzLxib65z2XTqki59YDQJGpJ/wB1kEE5MQDgSTQWtKUrA8n9zS/1uIDQ== } + engines: { node: ">=v18" } dependencies: - '@commitlint/types': 18.4.3 + "@commitlint/types": 18.4.3 chalk: 4.1.2 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-ZseOY9UfuAI32h9w342Km4AIaTieeFskm2ZKdrG7r31+c6zGBzuny9KQhwI9puc0J3GkUquEgKJblCl7pMnjwg==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-ZseOY9UfuAI32h9w342Km4AIaTieeFskm2ZKdrG7r31+c6zGBzuny9KQhwI9puc0J3GkUquEgKJblCl7pMnjwg== } + engines: { node: ">=v18" } dependencies: - '@commitlint/types': 18.4.3 + "@commitlint/types": 18.4.3 semver: 7.5.4 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-18u3MRgEXNbnYkMOWoncvq6QB8/90m9TbERKgdPqVvS+zQ/MsuRhdvHYCIXGXZxUb0YI4DV2PC4bPneBV/fYuA==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-18u3MRgEXNbnYkMOWoncvq6QB8/90m9TbERKgdPqVvS+zQ/MsuRhdvHYCIXGXZxUb0YI4DV2PC4bPneBV/fYuA== } + engines: { node: ">=v18" } dependencies: - '@commitlint/is-ignored': 18.4.3 - '@commitlint/parse': 18.4.3 - '@commitlint/rules': 18.4.3 - '@commitlint/types': 18.4.3 + "@commitlint/is-ignored": 18.4.3 + "@commitlint/parse": 18.4.3 + "@commitlint/rules": 18.4.3 + "@commitlint/types": 18.4.3 dev: true /@commitlint/[email protected]([email protected]): - resolution: {integrity: sha512-v6j2WhvRQJrcJaj5D+EyES2WKTxPpxENmNpNG3Ww8MZGik3jWRXtph0QTzia5ZJyPh2ib5aC/6BIDymkUUM58Q==} - engines: {node: '>=v18'} - dependencies: - '@commitlint/config-validator': 18.4.3 - '@commitlint/execute-rule': 18.4.3 - '@commitlint/resolve-extends': 18.4.3 - '@commitlint/types': 18.4.3 - '@types/node': 18.17.0 + resolution: + { integrity: sha512-v6j2WhvRQJrcJaj5D+EyES2WKTxPpxENmNpNG3Ww8MZGik3jWRXtph0QTzia5ZJyPh2ib5aC/6BIDymkUUM58Q== } + engines: { node: ">=v18" } + dependencies: + "@commitlint/config-validator": 18.4.3 + "@commitlint/execute-rule": 18.4.3 + "@commitlint/resolve-extends": 18.4.3 + "@commitlint/types": 18.4.3 + "@types/node": 18.17.0 chalk: 4.1.2 cosmiconfig: 8.3.6([email protected]) cosmiconfig-typescript-loader: 5.0.0(@types/[email protected])([email protected])([email protected]) @@ -2962,36 +3088,40 @@ packages: dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-ddJ7AztWUIoEMAXoewx45lKEYEOeOlBVWjk8hDMUGpprkuvWULpaXczqdjwVtjrKT3JhhN+gMs8pm5G3vB2how==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-ddJ7AztWUIoEMAXoewx45lKEYEOeOlBVWjk8hDMUGpprkuvWULpaXczqdjwVtjrKT3JhhN+gMs8pm5G3vB2how== } + engines: { node: ">=v18" } dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-eoH7CXM9L+/Me96KVcfJ27EIIbA5P9sqw3DqjJhRYuhaULIsPHFs5S5GBDCqT0vKZQDx0DgxhMpW6AQbnKrFtA==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-eoH7CXM9L+/Me96KVcfJ27EIIbA5P9sqw3DqjJhRYuhaULIsPHFs5S5GBDCqT0vKZQDx0DgxhMpW6AQbnKrFtA== } + engines: { node: ">=v18" } dependencies: - '@commitlint/types': 18.4.3 + "@commitlint/types": 18.4.3 conventional-changelog-angular: 7.0.0 conventional-commits-parser: 5.0.0 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-H4HGxaYA6OBCimZAtghL+B+SWu8ep4X7BwgmedmqWZRHxRLcX2q0bWBtUm5FsMbluxbOfrJwOs/Z0ah4roP/GQ==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-H4HGxaYA6OBCimZAtghL+B+SWu8ep4X7BwgmedmqWZRHxRLcX2q0bWBtUm5FsMbluxbOfrJwOs/Z0ah4roP/GQ== } + engines: { node: ">=v18" } dependencies: - '@commitlint/top-level': 18.4.3 - '@commitlint/types': 18.4.3 + "@commitlint/top-level": 18.4.3 + "@commitlint/types": 18.4.3 fs-extra: 11.1.1 git-raw-commits: 2.0.11 minimist: 1.2.8 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-30sk04LZWf8+SDgJrbJCjM90gTg2LxsD9cykCFeFu+JFHvBFq5ugzp2eO/DJGylAdVaqxej3c7eTSE64hR/lnw==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-30sk04LZWf8+SDgJrbJCjM90gTg2LxsD9cykCFeFu+JFHvBFq5ugzp2eO/DJGylAdVaqxej3c7eTSE64hR/lnw== } + engines: { node: ">=v18" } dependencies: - '@commitlint/config-validator': 18.4.3 - '@commitlint/types': 18.4.3 + "@commitlint/config-validator": 18.4.3 + "@commitlint/types": 18.4.3 import-fresh: 3.3.0 lodash.mergewith: 4.6.2 resolve-from: 5.0.0 @@ -2999,44 +3129,50 @@ packages: dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-8KIeukDf45BiY+Lul1T0imSNXF0sMrlLG6JpLLKolkmYVQ6PxxoNOriwyZ3UTFFpaVbPy0rcITaV7U9JCAfDTA==} - engines: {node: '>=v18'} - dependencies: - '@commitlint/ensure': 18.4.3 - '@commitlint/message': 18.4.3 - '@commitlint/to-lines': 18.4.3 - '@commitlint/types': 18.4.3 + resolution: + { integrity: sha512-8KIeukDf45BiY+Lul1T0imSNXF0sMrlLG6JpLLKolkmYVQ6PxxoNOriwyZ3UTFFpaVbPy0rcITaV7U9JCAfDTA== } + engines: { node: ">=v18" } + dependencies: + "@commitlint/ensure": 18.4.3 + "@commitlint/message": 18.4.3 + "@commitlint/to-lines": 18.4.3 + "@commitlint/types": 18.4.3 execa: 5.1.1 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-fy1TAleik4Zfru1RJ8ZU6cOSvgSVhUellxd3WZV1D5RwHZETt1sZdcA4mQN2y3VcIZsUNKkW0Mq8CM9/L9harQ==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-fy1TAleik4Zfru1RJ8ZU6cOSvgSVhUellxd3WZV1D5RwHZETt1sZdcA4mQN2y3VcIZsUNKkW0Mq8CM9/L9harQ== } + engines: { node: ">=v18" } dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-E6fJPBLPFL5R8+XUNSYkj4HekIOuGMyJo3mIx2PkYc3clel+pcWQ7TConqXxNWW4x1ugigiIY2RGot55qUq1hw==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-E6fJPBLPFL5R8+XUNSYkj4HekIOuGMyJo3mIx2PkYc3clel+pcWQ7TConqXxNWW4x1ugigiIY2RGot55qUq1hw== } + engines: { node: ">=v18" } dependencies: find-up: 5.0.0 dev: true /@commitlint/[email protected]: - resolution: {integrity: sha512-cvzx+vtY/I2hVBZHCLrpoh+sA0hfuzHwDc+BAFPimYLjJkpHnghQM+z8W/KyLGkygJh3BtI3xXXq+dKjnSWEmA==} - engines: {node: '>=v18'} + resolution: + { integrity: sha512-cvzx+vtY/I2hVBZHCLrpoh+sA0hfuzHwDc+BAFPimYLjJkpHnghQM+z8W/KyLGkygJh3BtI3xXXq+dKjnSWEmA== } + engines: { node: ">=v18" } dependencies: chalk: 4.1.2 dev: true /@cspotcode/[email protected]: - resolution: {integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw== } + engines: { node: ">=12" } dependencies: - '@jridgewell/trace-mapping': 0.3.9 + "@jridgewell/trace-mapping": 0.3.9 dev: true /@dabh/[email protected]: - resolution: {integrity: sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA==} + resolution: + { integrity: sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA== } dependencies: colorspace: 1.1.4 enabled: 2.0.0 @@ -3044,7 +3180,8 @@ packages: dev: true /@datalust/[email protected]([email protected]): - resolution: {integrity: sha512-+2jseaj02d0uKWEfrYDVoAqJ89u33jd/KYItE/kbAsH21HlULm9ZN//S0C7+MUKsGStM0JnclByvvdyk5YmxjA==} + resolution: + { integrity: sha512-+2jseaj02d0uKWEfrYDVoAqJ89u33jd/KYItE/kbAsH21HlULm9ZN//S0C7+MUKsGStM0JnclByvvdyk5YmxjA== } peerDependencies: winston: ^3.0.0 dependencies: @@ -3056,13 +3193,15 @@ packages: dev: true /@discoveryjs/[email protected]: - resolution: {integrity: sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==} - engines: {node: '>=10.0.0'} + resolution: + { integrity: sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== } + engines: { node: ">=10.0.0" } dev: true /@electron/[email protected]: - resolution: {integrity: sha512-eFZVFoRXb3GFGd7Ak7W4+6jBl9wBtiZ4AaYOse97ej6mKj5tkyO0dUnUChs1IhJZtx1BENo4/p4WUTXpi6vT+g==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-eFZVFoRXb3GFGd7Ak7W4+6jBl9wBtiZ4AaYOse97ej6mKj5tkyO0dUnUChs1IhJZtx1BENo4/p4WUTXpi6vT+g== } + engines: { node: ">=12" } dependencies: debug: 4.3.4([email protected]) env-paths: 2.2.1 @@ -3078,8 +3217,9 @@ packages: dev: true /@es-joy/[email protected]: - resolution: {integrity: sha512-aKUhyn1QI5Ksbqcr3fFJj16p99QdjUxXAEuFst1Z47DRyoiMwivIH9MV/ARcJOCXVjPfjITciej8ZD2O/6qUmw==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-aKUhyn1QI5Ksbqcr3fFJj16p99QdjUxXAEuFst1Z47DRyoiMwivIH9MV/ARcJOCXVjPfjITciej8ZD2O/6qUmw== } + engines: { node: ">=16" } dependencies: comment-parser: 1.4.1 esquery: 1.5.0 @@ -3087,8 +3227,9 @@ packages: dev: true /@eslint-community/[email protected]([email protected]): - resolution: {integrity: sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } peerDependencies: eslint: ^6.0.0 \|\| ^7.0.0 \|\| >=8.0.0 dependencies: @@ -3097,13 +3238,15 @@ packages: dev: true /@eslint-community/[email protected]: - resolution: {integrity: sha512-pPTNuaAG3QMH+buKyBIGJs3g/S5y0caxw0ygM3YyE6yJFySwiGGSzA+mM3KJ8QQvzeLh3blwgSonkFjgQdxzMw==} - engines: {node: ^12.0.0 \|\| ^14.0.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-pPTNuaAG3QMH+buKyBIGJs3g/S5y0caxw0ygM3YyE6yJFySwiGGSzA+mM3KJ8QQvzeLh3blwgSonkFjgQdxzMw== } + engines: { node: ^12.0.0 \|\| ^14.0.0 \|\| >=16.0.0 } dev: true /@eslint/[email protected]: - resolution: {integrity: sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } dependencies: ajv: 6.12.6 debug: 4.3.4([email protected]) @@ -3119,21 +3262,24 @@ packages: dev: true /@eslint/[email protected]: - resolution: {integrity: sha512-qQfo2mxH5yVom1kacMtZZJFVdW+E70mqHMJvVg6WTLo+VBuQJ4TojZlfWBjK0ve5BdEeNAVxOsl/nvNMpJOaJA==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-qQfo2mxH5yVom1kacMtZZJFVdW+E70mqHMJvVg6WTLo+VBuQJ4TojZlfWBjK0ve5BdEeNAVxOsl/nvNMpJOaJA== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } dev: true /@fortawesome/[email protected]: - resolution: {integrity: sha512-m5cPn3e2+FDCOgi1mz0RexTUvvQibBebOUlUlW0+YrMjDTPkiJ6VTKukA1GRsvRw+12KyJndNjj0O4AgTxm2Pg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-m5cPn3e2+FDCOgi1mz0RexTUvvQibBebOUlUlW0+YrMjDTPkiJ6VTKukA1GRsvRw+12KyJndNjj0O4AgTxm2Pg== } + engines: { node: ">=6" } requiresBuild: true dev: true /@humanwhocodes/[email protected]: - resolution: {integrity: sha512-JSBDMiDKSzQVngfRjOdFXgFfklaXI4K9nLF49Auh21lmBWRLIK3+xTErTWD4KU54pb6coM6ESE7Awz/FNU3zgQ==} - engines: {node: '>=10.10.0'} + resolution: + { integrity: sha512-JSBDMiDKSzQVngfRjOdFXgFfklaXI4K9nLF49Auh21lmBWRLIK3+xTErTWD4KU54pb6coM6ESE7Awz/FNU3zgQ== } + engines: { node: ">=10.10.0" } dependencies: - '@humanwhocodes/object-schema': 2.0.1 + "@humanwhocodes/object-schema": 2.0.1 debug: 4.3.4([email protected]) minimatch: 3.1.2 transitivePeerDependencies: @@ -3141,22 +3287,26 @@ packages: dev: true /@humanwhocodes/[email protected]: - resolution: {integrity: sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==} - engines: {node: '>=12.22'} + resolution: + { integrity: sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA== } + engines: { node: ">=12.22" } dev: true /@humanwhocodes/[email protected]: - resolution: {integrity: sha512-dvuCeX5fC9dXgJn9t+X5atfmgQAzUOWqS1254Gh0m6i8wKd10ebXkfNKiRK+1GWi/yTvvLDHpoxLr0xxxeslWw==} + resolution: + { integrity: sha512-dvuCeX5fC9dXgJn9t+X5atfmgQAzUOWqS1254Gh0m6i8wKd10ebXkfNKiRK+1GWi/yTvvLDHpoxLr0xxxeslWw== } dev: true /@hutson/[email protected]: - resolution: {integrity: sha512-H9XAx3hc0BQHY6l+IFSWHDySypcXsvsuLhgYLUGywmJ5pswRVQJUHpOsobnLYp2ZUaUlKiKDrgWWhosOwAEM8Q==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-H9XAx3hc0BQHY6l+IFSWHDySypcXsvsuLhgYLUGywmJ5pswRVQJUHpOsobnLYp2ZUaUlKiKDrgWWhosOwAEM8Q== } + engines: { node: ">=6.9.0" } dev: true /@isaacs/[email protected]: - resolution: {integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA== } + engines: { node: ">=12" } dependencies: string-width: 5.1.2 string-width-cjs: /[email protected] @@ -3167,8 +3317,9 @@ packages: dev: true /@istanbuljs/[email protected]: - resolution: {integrity: sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ== } + engines: { node: ">=8" } dependencies: camelcase: 5.3.1 find-up: 4.1.0 @@ -3178,88 +3329,101 @@ packages: dev: true /@istanbuljs/[email protected]([email protected]): - resolution: {integrity: sha512-iKGIyMoyJuFnJRSVTZ78POIRvNnwZaWIf8vG4ZS3rQq58MMDrqEX2nnzx0R28V2X8JvmKYiqY9FP2hlJsm8A0w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-iKGIyMoyJuFnJRSVTZ78POIRvNnwZaWIf8vG4ZS3rQq58MMDrqEX2nnzx0R28V2X8JvmKYiqY9FP2hlJsm8A0w== } + engines: { node: ">=8" } peerDependencies: - nyc: '>=15' + nyc: ">=15" dependencies: - '@istanbuljs/schema': 0.1.3 + "@istanbuljs/schema": 0.1.3 nyc: 15.1.0 dev: true /@istanbuljs/[email protected]: - resolution: {integrity: sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== } + engines: { node: ">=8" } dev: true /@jest/[email protected]: - resolution: {integrity: sha512-rxLjXyJBTL4LQeJW3aKo0M/+GkCOXsO+8i9Iu7eDb6KwtP65ayoDsitrdPBtujxQ88k4wI2FNYfa6TOGwSn6cQ==} - engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-rxLjXyJBTL4LQeJW3aKo0M/+GkCOXsO+8i9Iu7eDb6KwtP65ayoDsitrdPBtujxQ88k4wI2FNYfa6TOGwSn6cQ== } + engines: { node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0 } dependencies: - '@sinclair/typebox': 0.27.8 + "@sinclair/typebox": 0.27.8 dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ== } + engines: { node: ">=6.0.0" } dependencies: - '@jridgewell/set-array': 1.1.2 - '@jridgewell/sourcemap-codec': 1.4.15 - '@jridgewell/trace-mapping': 0.3.18 + "@jridgewell/set-array": 1.1.2 + "@jridgewell/sourcemap-codec": 1.4.15 + "@jridgewell/trace-mapping": 0.3.18 dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w== } + engines: { node: ">=6.0.0" } dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA== } + engines: { node: ">=6.0.0" } dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw== } + engines: { node: ">=6.0.0" } dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-UTYAUj/wviwdsMfzoSJspJxbkH5o1snzwX0//0ENX1u/55kkZZkcTZP6u9bwKGkv+dkk9at4m1Cpt0uY80kcpQ==} + resolution: + { integrity: sha512-UTYAUj/wviwdsMfzoSJspJxbkH5o1snzwX0//0ENX1u/55kkZZkcTZP6u9bwKGkv+dkk9at4m1Cpt0uY80kcpQ== } dependencies: - '@jridgewell/gen-mapping': 0.3.3 - '@jridgewell/trace-mapping': 0.3.18 + "@jridgewell/gen-mapping": 0.3.3 + "@jridgewell/trace-mapping": 0.3.18 dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==} + resolution: + { integrity: sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw== } dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==} + resolution: + { integrity: sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg== } dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA==} + resolution: + { integrity: sha512-w+niJYzMHdd7USdiH2U6869nqhD2nbfZXND5Yp93qIbEmnDNk7PD48o+YchRVpzMU7M6jVCbenTR7PA1FLQ9pA== } dependencies: - '@jridgewell/resolve-uri': 3.1.0 - '@jridgewell/sourcemap-codec': 1.4.14 + "@jridgewell/resolve-uri": 3.1.0 + "@jridgewell/sourcemap-codec": 1.4.14 dev: true /@jridgewell/[email protected]: - resolution: {integrity: sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==} + resolution: + { integrity: sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ== } dependencies: - '@jridgewell/resolve-uri': 3.1.1 - '@jridgewell/sourcemap-codec': 1.4.15 + "@jridgewell/resolve-uri": 3.1.1 + "@jridgewell/sourcemap-codec": 1.4.15 dev: true /@lerna/[email protected]([email protected]): - resolution: {integrity: sha512-mCeEhjFDRwPY7J4uxCjqdzPwPFBUGlkdlQjBidaX5XaoQcxR2hAAvgHZKfVGkUUEZKfyPcWwKzen4KydNB2G7A==} - engines: {node: '>=18.0.0'} - dependencies: - '@npmcli/run-script': 6.0.2 - '@nx/devkit': 17.1.3([email protected]) - '@octokit/plugin-enterprise-rest': 6.0.1 - '@octokit/rest': 19.0.11 + resolution: + { integrity: sha512-mCeEhjFDRwPY7J4uxCjqdzPwPFBUGlkdlQjBidaX5XaoQcxR2hAAvgHZKfVGkUUEZKfyPcWwKzen4KydNB2G7A== } + engines: { node: ">=18.0.0" } + dependencies: + "@npmcli/run-script": 6.0.2 + "@nx/devkit": 17.1.3([email protected]) + "@octokit/plugin-enterprise-rest": 6.0.1 + "@octokit/rest": 19.0.11 byte-size: 8.1.1 chalk: 4.1.0 clone-deep: 4.0.1 @@ -3321,8 +3485,8 @@ packages: yargs: 17.7.2 yargs-parser: 21.1.1 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' + - "@swc-node/register" + - "@swc/core" - bluebird - debug - encoding @@ -3331,7 +3495,8 @@ packages: dev: true /@mapbox/[email protected]: - resolution: {integrity: sha512-4ySo4CjzStuprMwk35H5pPbkymjv1SF3jGLj6rAHp/xT/RF7TL7bd9CTm1xDY49K2qF7jmR/g7k+SkLETP6opA==} + resolution: + { integrity: sha512-4ySo4CjzStuprMwk35H5pPbkymjv1SF3jGLj6rAHp/xT/RF7TL7bd9CTm1xDY49K2qF7jmR/g7k+SkLETP6opA== } hasBin: true dependencies: detect-libc: 2.0.1 @@ -3349,51 +3514,58 @@ packages: dev: true /@microsoft/[email protected]: - resolution: {integrity: sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==} + resolution: + { integrity: sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw== } dependencies: - '@microsoft/tsdoc': 0.14.2 + "@microsoft/tsdoc": 0.14.2 ajv: 6.12.6 jju: 1.4.0 resolve: 1.19.0 dev: true /@microsoft/[email protected]: - resolution: {integrity: sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==} + resolution: + { integrity: sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug== } dev: true /@nodelib/[email protected]: - resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== } + engines: { node: ">= 8" } dependencies: - '@nodelib/fs.stat': 2.0.5 + "@nodelib/fs.stat": 2.0.5 run-parallel: 1.2.0 dev: true /@nodelib/[email protected]: - resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== } + engines: { node: ">= 8" } dev: true /@nodelib/[email protected]: - resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== } + engines: { node: ">= 8" } dependencies: - '@nodelib/fs.scandir': 2.1.5 + "@nodelib/fs.scandir": 2.1.5 fastq: 1.15.0 dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-7kZUAaLscfgbwBQRbvdMYaZOWyMEcPTH/tJjnyAWJ/dvvs9Ef+CERx/qJb9GExJpl1qipaDGn7KqHnFGGixd0w==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-7kZUAaLscfgbwBQRbvdMYaZOWyMEcPTH/tJjnyAWJ/dvvs9Ef+CERx/qJb9GExJpl1qipaDGn7KqHnFGGixd0w== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: semver: 7.5.4 dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-9hwoB3gStVfa0N31ymBmrX+GuDGdVA/QWShZVqE0HK2Af+7QGGrCTbZia/SW0ImUTjTne7SP91qxDmtXvDHRPQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-9hwoB3gStVfa0N31ymBmrX+GuDGdVA/QWShZVqE0HK2Af+7QGGrCTbZia/SW0ImUTjTne7SP91qxDmtXvDHRPQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@npmcli/promise-spawn': 6.0.2 + "@npmcli/promise-spawn": 6.0.2 lru-cache: 7.18.3 npm-pick-manifest: 8.0.1 proc-log: 3.0.0 @@ -3406,8 +3578,9 @@ packages: dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-xACzLPhnfD51GKvTOOuNX2/V4G4mz9/1I2MfDoye9kBM3RYe5g2YbscsaGoTlaWqkxeiapBWyseULVKpSVHtKQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-xACzLPhnfD51GKvTOOuNX2/V4G4mz9/1I2MfDoye9kBM3RYe5g2YbscsaGoTlaWqkxeiapBWyseULVKpSVHtKQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } hasBin: true dependencies: npm-bundled: 3.0.0 @@ -3415,23 +3588,26 @@ packages: dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-gp8pRXC2oOxu0DUE1/M3bYtb1b3/DbJ5aM113+XJBgfXdussRAsX0YOrOhdd8WvnAR6auDBvJomGAkLKA5ydxA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-gp8pRXC2oOxu0DUE1/M3bYtb1b3/DbJ5aM113+XJBgfXdussRAsX0YOrOhdd8WvnAR6auDBvJomGAkLKA5ydxA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-gGq0NJkIGSwdbUt4yhdF8ZrmkGKVz9vAdVzpOfnom+V8PLSmSOVhZwbNvZZS1EYcJN5hzzKBxmmVVAInM6HQLg==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-gGq0NJkIGSwdbUt4yhdF8ZrmkGKVz9vAdVzpOfnom+V8PLSmSOVhZwbNvZZS1EYcJN5hzzKBxmmVVAInM6HQLg== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: which: 3.0.1 dev: true /@npmcli/[email protected]: - resolution: {integrity: sha512-NCcr1uQo1k5U+SYlnIrbAh3cxy+OQT1VtqiAbxdymSlptbzBb62AjH2xXgjNCoP073hoa1CfCAcwoZ8k96C4nA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-NCcr1uQo1k5U+SYlnIrbAh3cxy+OQT1VtqiAbxdymSlptbzBb62AjH2xXgjNCoP073hoa1CfCAcwoZ8k96C4nA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@npmcli/node-gyp': 3.0.0 - '@npmcli/promise-spawn': 6.0.2 + "@npmcli/node-gyp": 3.0.0 + "@npmcli/promise-spawn": 6.0.2 node-gyp: 9.4.0 read-package-json-fast: 3.0.2 which: 3.0.1 @@ -3440,15 +3616,17 @@ packages: dev: true /@nrwl/[email protected]([email protected]): - resolution: {integrity: sha512-8HfIY7P3yIYfQ/XKuHoq0GGLA9GpwWtBlI9kPQ0ygjuJ9BkpiGMtQvO6003zs7c6vpc2vNeG+Jmi72+EKvoN5A==} + resolution: + { integrity: sha512-8HfIY7P3yIYfQ/XKuHoq0GGLA9GpwWtBlI9kPQ0ygjuJ9BkpiGMtQvO6003zs7c6vpc2vNeG+Jmi72+EKvoN5A== } dependencies: - '@nx/devkit': 17.1.3([email protected]) + "@nx/devkit": 17.1.3([email protected]) transitivePeerDependencies: - nx dev: true /@nrwl/[email protected]: - resolution: {integrity: sha512-oHO5T1HRJsR9mbRd8eUqMBPCgqVZLSbAh3zJoPFmhEmjbM4YB9ePRpgYFT8dRNeZUOUd/8Yt7Pb6EVWOHvpD/w==} + resolution: + { integrity: sha512-oHO5T1HRJsR9mbRd8eUqMBPCgqVZLSbAh3zJoPFmhEmjbM4YB9ePRpgYFT8dRNeZUOUd/8Yt7Pb6EVWOHvpD/w== } dependencies: nx-cloud: 16.5.2 transitivePeerDependencies: @@ -3456,33 +3634,36 @@ packages: dev: true /@nrwl/[email protected]: - resolution: {integrity: sha512-9YpfEkUpVqOweqgQvMDcWApNx4jhCqBNH5IByZj302Enp3TLnQSvhuX5Dfr8hNQRQokIpEn6tW8SGTctTM5LXw==} + resolution: + { integrity: sha512-9YpfEkUpVqOweqgQvMDcWApNx4jhCqBNH5IByZj302Enp3TLnQSvhuX5Dfr8hNQRQokIpEn6tW8SGTctTM5LXw== } hasBin: true dependencies: nx: 17.1.3 tslib: 2.6.0 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' + - "@swc-node/register" + - "@swc/core" - debug dev: true /@nrwl/[email protected]: - resolution: {integrity: sha512-V5nLZ58DIZLlJQASYHKo9mUcdm2FbzjJeoKwi0X3VXUvU1ftforFxNIQ7BqS0qjZJKKHjpgZ+cAH0xeVysS5kA==} + resolution: + { integrity: sha512-V5nLZ58DIZLlJQASYHKo9mUcdm2FbzjJeoKwi0X3VXUvU1ftforFxNIQ7BqS0qjZJKKHjpgZ+cAH0xeVysS5kA== } dependencies: - '@nx/workspace': 17.1.3 + "@nx/workspace": 17.1.3 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' + - "@swc-node/register" + - "@swc/core" - debug dev: true /@nx/[email protected]([email protected]): - resolution: {integrity: sha512-1Is7ooovg3kdGJ5VdkePulRUDaMYLLULr+LwXgx7oHSW7AY2iCmhkoOE/vSR7DJ6rkey2gYx7eT1IoRoORiIaQ==} + resolution: + { integrity: sha512-1Is7ooovg3kdGJ5VdkePulRUDaMYLLULr+LwXgx7oHSW7AY2iCmhkoOE/vSR7DJ6rkey2gYx7eT1IoRoORiIaQ== } peerDependencies: - nx: '>= 16 <= 18' + nx: ">= 16 <= 18" dependencies: - '@nrwl/devkit': 17.1.3([email protected]) + "@nrwl/devkit": 17.1.3([email protected]) ejs: 3.1.9 enquirer: 2.3.6 ignore: 5.2.4 @@ -3493,8 +3674,9 @@ packages: dev: true /@nx/[email protected]: - resolution: {integrity: sha512-f4qLa0y3C4uuhYKgq+MU892WaQvtvmHqrEhHINUOxYXNiLy2sgyJPW0mOZvzXtC4dPaUmiVaFP5RMVzc8Lxhtg==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-f4qLa0y3C4uuhYKgq+MU892WaQvtvmHqrEhHINUOxYXNiLy2sgyJPW0mOZvzXtC4dPaUmiVaFP5RMVzc8Lxhtg== } + engines: { node: ">= 10" } cpu: [arm64] os: [darwin] requiresBuild: true @@ -3502,8 +3684,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-kh76ZjqkLeQUIAfTa9G/DFFf+e1sZ5ipDzk7zFGhZ2k68PoQoFdsFOO3C513JmuEdavspts6Hkifsqh61TaE+A==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-kh76ZjqkLeQUIAfTa9G/DFFf+e1sZ5ipDzk7zFGhZ2k68PoQoFdsFOO3C513JmuEdavspts6Hkifsqh61TaE+A== } + engines: { node: ">= 10" } cpu: [x64] os: [darwin] requiresBuild: true @@ -3511,8 +3694,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-CRuVL5ZSLb+Gc8vwMUUe9Pl/1Z26YtXMKTahBMQh2dac63vzLgzqIV4c66aduUl1x2M0kGYBSIIRG9z0/BgWeg==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-CRuVL5ZSLb+Gc8vwMUUe9Pl/1Z26YtXMKTahBMQh2dac63vzLgzqIV4c66aduUl1x2M0kGYBSIIRG9z0/BgWeg== } + engines: { node: ">= 10" } cpu: [x64] os: [freebsd] requiresBuild: true @@ -3520,8 +3704,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-KDBmd5tSrg93g/oij/eGW4yeVNVK3DBIM4VYAS2vtkIgVOGoqcQ+SEIeMK3nMUJP9jGyblt3QNj5ZsJBtScwQw==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-KDBmd5tSrg93g/oij/eGW4yeVNVK3DBIM4VYAS2vtkIgVOGoqcQ+SEIeMK3nMUJP9jGyblt3QNj5ZsJBtScwQw== } + engines: { node: ">= 10" } cpu: [arm] os: [linux] requiresBuild: true @@ -3529,8 +3714,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-W2tNL/7sIwoQKLmuy68Usd6TZzIZvxZt4UE30kDwGc2RSap6RCHAvDbzSxtW+L4+deC9UxX0Tty0VuW+J8FjSg==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-W2tNL/7sIwoQKLmuy68Usd6TZzIZvxZt4UE30kDwGc2RSap6RCHAvDbzSxtW+L4+deC9UxX0Tty0VuW+J8FjSg== } + engines: { node: ">= 10" } cpu: [arm64] os: [linux] requiresBuild: true @@ -3538,8 +3724,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-Oto3gkLd7yweuVUCsSHwm4JkAIbcxpPJP0ycRHI/PRHPMIOPiMX8r651QM1amMyKAbJtAe047nyb9Sh1X0FA4A==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-Oto3gkLd7yweuVUCsSHwm4JkAIbcxpPJP0ycRHI/PRHPMIOPiMX8r651QM1amMyKAbJtAe047nyb9Sh1X0FA4A== } + engines: { node: ">= 10" } cpu: [arm64] os: [linux] requiresBuild: true @@ -3547,8 +3734,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-pJS994sa5PBPFak93RydTB9KdEmiVb3rgiSB7PDBegphERbzHEB77B7G8M5TZ62dGlMdplIEKmdhY5XNqeAf9A==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-pJS994sa5PBPFak93RydTB9KdEmiVb3rgiSB7PDBegphERbzHEB77B7G8M5TZ62dGlMdplIEKmdhY5XNqeAf9A== } + engines: { node: ">= 10" } cpu: [x64] os: [linux] requiresBuild: true @@ -3556,8 +3744,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-4Hcx5Fg/88jV+bcTr6P0dM4unXNvKgrGJe3oK9/sgEhiW6pD2UAFjv16CCSRcWhDUAzUDqcwnD2fgg+vnAJG6g==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-4Hcx5Fg/88jV+bcTr6P0dM4unXNvKgrGJe3oK9/sgEhiW6pD2UAFjv16CCSRcWhDUAzUDqcwnD2fgg+vnAJG6g== } + engines: { node: ">= 10" } cpu: [x64] os: [linux] requiresBuild: true @@ -3565,8 +3754,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-dUasEuskmDxUL36XA0GZqSb9233suE4wKhxrMobyFBzHUZ2tq/unzOpPjYfqDBie4QIvF8tEpAjQsLds8LWgbw==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-dUasEuskmDxUL36XA0GZqSb9233suE4wKhxrMobyFBzHUZ2tq/unzOpPjYfqDBie4QIvF8tEpAjQsLds8LWgbw== } + engines: { node: ">= 10" } cpu: [arm64] os: [win32] requiresBuild: true @@ -3574,8 +3764,9 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-eTuTpBHFvA5NFJh/iosmqCL4JOAjDrwXLSMgfKrZKjiApHMG1T/5Hb+PrsNpt+WnGp94ur7c4Dtx4xD5vlpAEw==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-eTuTpBHFvA5NFJh/iosmqCL4JOAjDrwXLSMgfKrZKjiApHMG1T/5Hb+PrsNpt+WnGp94ur7c4Dtx4xD5vlpAEw== } + engines: { node: ">= 10" } cpu: [x64] os: [win32] requiresBuild: true @@ -3583,35 +3774,38 @@ packages: optional: true /@nx/[email protected]: - resolution: {integrity: sha512-Je9nml9NJZJ0Ga70njK4N8KNSP7MnlxiVlosMzBAWDGrgnW+A403nae9pstEC2uGKpce2T7jBqFewAy+3U6JbA==} + resolution: + { integrity: sha512-Je9nml9NJZJ0Ga70njK4N8KNSP7MnlxiVlosMzBAWDGrgnW+A403nae9pstEC2uGKpce2T7jBqFewAy+3U6JbA== } dependencies: - '@nrwl/workspace': 17.1.3 - '@nx/devkit': 17.1.3([email protected]) + "@nrwl/workspace": 17.1.3 + "@nx/devkit": 17.1.3([email protected]) chalk: 4.1.2 enquirer: 2.3.6 nx: 17.1.3 tslib: 2.6.0 yargs-parser: 21.1.1 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' + - "@swc-node/register" + - "@swc/core" - debug dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-TWFX7cZF2LXoCvdmJWY7XVPi74aSY0+FfBZNSXEXFkMpjcqsQwDSYVv5FhRFaI0V1ECnwbz4j59T/G+rXNWaIQ==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-TWFX7cZF2LXoCvdmJWY7XVPi74aSY0+FfBZNSXEXFkMpjcqsQwDSYVv5FhRFaI0V1ECnwbz4j59T/G+rXNWaIQ== } + engines: { node: ">= 14" } dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-rYKilwgzQ7/imScn3M9/pFfUf4I1AZEH3KhyJmtPdE2zfaXAn2mFfUy4FbKewzc2We5y/LlKLj36fWJLKC2SIQ==} - engines: {node: '>= 14'} - dependencies: - '@octokit/auth-token': 3.0.4 - '@octokit/graphql': 5.0.6 - '@octokit/request': 6.2.8 - '@octokit/request-error': 3.0.3 - '@octokit/types': 9.3.2 + resolution: + { integrity: sha512-rYKilwgzQ7/imScn3M9/pFfUf4I1AZEH3KhyJmtPdE2zfaXAn2mFfUy4FbKewzc2We5y/LlKLj36fWJLKC2SIQ== } + engines: { node: ">= 14" } + dependencies: + "@octokit/auth-token": 3.0.4 + "@octokit/graphql": 5.0.6 + "@octokit/request": 6.2.8 + "@octokit/request-error": 3.0.3 + "@octokit/types": 9.3.2 before-after-hook: 2.2.3 universal-user-agent: 6.0.0 transitivePeerDependencies: @@ -3619,78 +3813,87 @@ packages: dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-5L4fseVRUsDFGR00tMWD/Trdeeihn999rTMGRMC1G/Ldi1uWlWJzI98H4Iak5DB/RVvQuyMYKqSK/R6mbSOQyg==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-5L4fseVRUsDFGR00tMWD/Trdeeihn999rTMGRMC1G/Ldi1uWlWJzI98H4Iak5DB/RVvQuyMYKqSK/R6mbSOQyg== } + engines: { node: ">= 14" } dependencies: - '@octokit/types': 9.3.2 + "@octokit/types": 9.3.2 is-plain-object: 5.0.0 universal-user-agent: 6.0.0 dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-Fxyxdy/JH0MnIB5h+UQ3yCoh1FG4kWXfFKkpWqjZHw/p+Kc8Y44Hu/kCgNBT6nU1shNumEchmW/sUO1JuQnPcw==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-Fxyxdy/JH0MnIB5h+UQ3yCoh1FG4kWXfFKkpWqjZHw/p+Kc8Y44Hu/kCgNBT6nU1shNumEchmW/sUO1JuQnPcw== } + engines: { node: ">= 14" } dependencies: - '@octokit/request': 6.2.8 - '@octokit/types': 9.3.2 + "@octokit/request": 6.2.8 + "@octokit/types": 9.3.2 universal-user-agent: 6.0.0 transitivePeerDependencies: - encoding dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw==} + resolution: + { integrity: sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw== } dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-93uGjlhUD+iNg1iWhUENAtJata6w5nE+V4urXOAlIXdco6xNZtUSfYY8dzp3Udy74aqO/B5UZL80x/YMa5PKRw==} + resolution: + { integrity: sha512-93uGjlhUD+iNg1iWhUENAtJata6w5nE+V4urXOAlIXdco6xNZtUSfYY8dzp3Udy74aqO/B5UZL80x/YMa5PKRw== } dev: true /@octokit/[email protected](@octokit/[email protected]): - resolution: {integrity: sha512-qhrmtQeHU/IivxucOV1bbI/xZyC/iOBhclokv7Sut5vnejAIAEXVcGQeRpQlU39E0WwK9lNvJHphHri/DB6lbQ==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-qhrmtQeHU/IivxucOV1bbI/xZyC/iOBhclokv7Sut5vnejAIAEXVcGQeRpQlU39E0WwK9lNvJHphHri/DB6lbQ== } + engines: { node: ">= 14" } peerDependencies: - '@octokit/core': '>=4' + "@octokit/core": ">=4" dependencies: - '@octokit/core': 4.2.4 - '@octokit/tsconfig': 1.0.2 - '@octokit/types': 9.3.2 + "@octokit/core": 4.2.4 + "@octokit/tsconfig": 1.0.2 + "@octokit/types": 9.3.2 dev: true /@octokit/[email protected](@octokit/[email protected]): - resolution: {integrity: sha512-mLUsMkgP7K/cnFEw07kWqXGF5LKrOkD+lhCrKvPHXWDywAwuDUeDwWBpc69XK3pNX0uKiVt8g5z96PJ6z9xCFA==} + resolution: + { integrity: sha512-mLUsMkgP7K/cnFEw07kWqXGF5LKrOkD+lhCrKvPHXWDywAwuDUeDwWBpc69XK3pNX0uKiVt8g5z96PJ6z9xCFA== } peerDependencies: - '@octokit/core': '>=3' + "@octokit/core": ">=3" dependencies: - '@octokit/core': 4.2.4 + "@octokit/core": 4.2.4 dev: true /@octokit/[email protected](@octokit/[email protected]): - resolution: {integrity: sha512-I5Gml6kTAkzVlN7KCtjOM+Ruwe/rQppp0QU372K1GP7kNOYEKe8Xn5BW4sE62JAHdwpq95OQK/qGNyKQMUzVgA==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-I5Gml6kTAkzVlN7KCtjOM+Ruwe/rQppp0QU372K1GP7kNOYEKe8Xn5BW4sE62JAHdwpq95OQK/qGNyKQMUzVgA== } + engines: { node: ">= 14" } peerDependencies: - '@octokit/core': '>=3' + "@octokit/core": ">=3" dependencies: - '@octokit/core': 4.2.4 - '@octokit/types': 10.0.0 + "@octokit/core": 4.2.4 + "@octokit/types": 10.0.0 dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-crqw3V5Iy2uOU5Np+8M/YexTlT8zxCfI+qu+LxUB7SZpje4Qmx3mub5DfEKSO8Ylyk0aogi6TYdf6kxzh2BguQ==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-crqw3V5Iy2uOU5Np+8M/YexTlT8zxCfI+qu+LxUB7SZpje4Qmx3mub5DfEKSO8Ylyk0aogi6TYdf6kxzh2BguQ== } + engines: { node: ">= 14" } dependencies: - '@octokit/types': 9.3.2 + "@octokit/types": 9.3.2 deprecation: 2.3.1 once: 1.4.0 dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-ow4+pkVQ+6XVVsekSYBzJC0VTVvh/FCTUUgTsboGq+DTeWdyIFV8WSCdo0RIxk6wSkBTHqIK1mYuY7nOBXOchw==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-ow4+pkVQ+6XVVsekSYBzJC0VTVvh/FCTUUgTsboGq+DTeWdyIFV8WSCdo0RIxk6wSkBTHqIK1mYuY7nOBXOchw== } + engines: { node: ">= 14" } dependencies: - '@octokit/endpoint': 7.0.6 - '@octokit/request-error': 3.0.3 - '@octokit/types': 9.3.2 + "@octokit/endpoint": 7.0.6 + "@octokit/request-error": 3.0.3 + "@octokit/types": 9.3.2 is-plain-object: 5.0.0 node-fetch: 2.6.12 universal-user-agent: 6.0.0 @@ -3699,119 +3902,139 @@ packages: dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-m2a9VhaP5/tUw8FwfnW2ICXlXpLPIqxtg3XcAiGMLj/Xhw3RSBfZ8le/466ktO1Gcjr8oXudGnHhxV1TXJgFxw==} - engines: {node: '>= 14'} - dependencies: - '@octokit/core': 4.2.4 - '@octokit/plugin-paginate-rest': 6.1.2(@octokit/[email protected]) - '@octokit/plugin-request-log': 1.0.4(@octokit/[email protected]) - '@octokit/plugin-rest-endpoint-methods': 7.2.3(@octokit/[email protected]) + resolution: + { integrity: sha512-m2a9VhaP5/tUw8FwfnW2ICXlXpLPIqxtg3XcAiGMLj/Xhw3RSBfZ8le/466ktO1Gcjr8oXudGnHhxV1TXJgFxw== } + engines: { node: ">= 14" } + dependencies: + "@octokit/core": 4.2.4 + "@octokit/plugin-paginate-rest": 6.1.2(@octokit/[email protected]) + "@octokit/plugin-request-log": 1.0.4(@octokit/[email protected]) + "@octokit/plugin-rest-endpoint-methods": 7.2.3(@octokit/[email protected]) transitivePeerDependencies: - encoding dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-I0vDR0rdtP8p2lGMzvsJzbhdOWy405HcGovrspJ8RRibHnyRgggUSNO5AIox5LmqiwmatHKYsvj6VGFHkqS7lA==} + resolution: + { integrity: sha512-I0vDR0rdtP8p2lGMzvsJzbhdOWy405HcGovrspJ8RRibHnyRgggUSNO5AIox5LmqiwmatHKYsvj6VGFHkqS7lA== } dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-Vm8IddVmhCgU1fxC1eyinpwqzXPEYu0NrYzD3YZjlGjyftdLBTeqNblRC0jmJmgxbJIsQlyogVeGnrNaaMVzIg==} + resolution: + { integrity: sha512-Vm8IddVmhCgU1fxC1eyinpwqzXPEYu0NrYzD3YZjlGjyftdLBTeqNblRC0jmJmgxbJIsQlyogVeGnrNaaMVzIg== } dependencies: - '@octokit/openapi-types': 18.0.0 + "@octokit/openapi-types": 18.0.0 dev: true /@octokit/[email protected]: - resolution: {integrity: sha512-D4iHGTdAnEEVsB8fl95m1hiz7D5YiRdQ9b/OEb3BYRVwbLsGHcRVPz+u+BgRLNk0Q0/4iZCBqDN96j2XNxfXrA==} + resolution: + { integrity: sha512-D4iHGTdAnEEVsB8fl95m1hiz7D5YiRdQ9b/OEb3BYRVwbLsGHcRVPz+u+BgRLNk0Q0/4iZCBqDN96j2XNxfXrA== } dependencies: - '@octokit/openapi-types': 18.0.0 + "@octokit/openapi-types": 18.0.0 dev: true /@pkgjs/[email protected]: - resolution: {integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg== } + engines: { node: ">=14" } requiresBuild: true dev: true optional: true /@polka/[email protected]: - resolution: {integrity: sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g==} + resolution: + { integrity: sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g== } dev: true /@popperjs/[email protected]: - resolution: {integrity: sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==} + resolution: + { integrity: sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A== } dev: true /@putout/[email protected]: - resolution: {integrity: sha512-KvmGa9BMeCO1rvMJ7o69DUwELHBkVa7Pb2HWTQoN2XpDtH8F6RfTO8KYpb+zHp6hH6K6FhUxtuAG4gW0j3EZvg==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-KvmGa9BMeCO1rvMJ7o69DUwELHBkVa7Pb2HWTQoN2XpDtH8F6RfTO8KYpb+zHp6hH6K6FhUxtuAG4gW0j3EZvg== } + engines: { node: ">=16" } dev: true /@sigstore/[email protected]: - resolution: {integrity: sha512-a31EnjuIDSX8IXBUib3cYLDRlPMU36AWX4xS8ysLaNu4ZzUesDiPt83pgrW2X1YLMe5L2HbDyaKK5BrL4cNKaQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-a31EnjuIDSX8IXBUib3cYLDRlPMU36AWX4xS8ysLaNu4ZzUesDiPt83pgrW2X1YLMe5L2HbDyaKK5BrL4cNKaQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /@sigstore/[email protected]: - resolution: {integrity: sha512-vjwcYePJzM01Ha6oWWZ9gNcdIgnzyFxfqfWzph483DPJTH8Tb7f7bQRRll3CYVkyH56j0AgcPAcl6Vg95DPF+Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-vjwcYePJzM01Ha6oWWZ9gNcdIgnzyFxfqfWzph483DPJTH8Tb7f7bQRRll3CYVkyH56j0AgcPAcl6Vg95DPF+Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@sigstore/protobuf-specs': 0.1.0 + "@sigstore/protobuf-specs": 0.1.0 tuf-js: 1.1.7 transitivePeerDependencies: - supports-color dev: true /@sinclair/[email protected]: - resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==} + resolution: + { integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA== } dev: true /@sindresorhus/[email protected]: - resolution: {integrity: sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw== } + engines: { node: ">=10" } dev: true /@sphinxxxx/[email protected]: - resolution: {integrity: sha512-XExJS3cLqgrmNBIP3bBw6+1oQ1ksGjFh0+oClDKFYpCCqx/hlqwWO5KO/S63fzUo67SxI9dMrF0y5T/Ey7h8Zw==} + resolution: + { integrity: sha512-XExJS3cLqgrmNBIP3bBw6+1oQ1ksGjFh0+oClDKFYpCCqx/hlqwWO5KO/S63fzUo67SxI9dMrF0y5T/Ey7h8Zw== } dev: true /@szmarczak/[email protected]: - resolution: {integrity: sha512-4BAffykYOgO+5nzBWYwE3W90sBgLJoUPRWWcL8wlyiM8IB8ipJz3UMJ9KXQd1RKQXpKp8Tutn80HZtWsu2u76w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-4BAffykYOgO+5nzBWYwE3W90sBgLJoUPRWWcL8wlyiM8IB8ipJz3UMJ9KXQd1RKQXpKp8Tutn80HZtWsu2u76w== } + engines: { node: ">=10" } dependencies: defer-to-connect: 2.0.1 dev: true /@tootallnate/[email protected]: - resolution: {integrity: sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A== } + engines: { node: ">= 10" } dev: true /@tsconfig/[email protected]: - resolution: {integrity: sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==} + resolution: + { integrity: sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA== } dev: true /@tsconfig/[email protected]: - resolution: {integrity: sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==} + resolution: + { integrity: sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag== } dev: true /@tsconfig/[email protected]: - resolution: {integrity: sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==} + resolution: + { integrity: sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow== } dev: true /@tsconfig/[email protected]: - resolution: {integrity: sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==} + resolution: + { integrity: sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA== } dev: true /@tsparticles/[email protected]([email protected]): - resolution: {integrity: sha512-g1T4MmgGS+spKMxU1kaYgz7lxEvSi24C7SxfGEfC1Fr9KDiaai4iNDAzASDTCkCfq9clxrZ69FPM7f15v2Juqg==} + resolution: + { integrity: sha512-g1T4MmgGS+spKMxU1kaYgz7lxEvSi24C7SxfGEfC1Fr9KDiaai4iNDAzASDTCkCfq9clxrZ69FPM7f15v2Juqg== } hasBin: true dependencies: - '@tsparticles/eslint-config': 2.0.0 - '@tsparticles/prettier-config': 2.0.0 - '@tsparticles/tsconfig': 2.0.0 - '@tsparticles/webpack-plugin': 2.0.0 - '@typescript-eslint/eslint-plugin': 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) + "@tsparticles/eslint-config": 2.0.0 + "@tsparticles/prettier-config": 2.0.0 + "@tsparticles/tsconfig": 2.0.0 + "@tsparticles/webpack-plugin": 2.0.0 + "@typescript-eslint/eslint-plugin": 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) commander: 11.1.0 eslint: 8.55.0 eslint-config-prettier: 9.1.0([email protected]) @@ -3828,8 +4051,8 @@ packages: typescript: 5.3.2 webpack: 5.89.0([email protected]) transitivePeerDependencies: - - '@swc/core' - - '@webpack-cli/generators' + - "@swc/core" + - "@webpack-cli/generators" - bufferutil - esbuild - eslint-import-resolver-typescript @@ -3842,11 +4065,12 @@ packages: dev: true /@tsparticles/[email protected]: - resolution: {integrity: sha512-V1Pd5Hw57qEtGaja+7QxiKPCiIfnifFZAXEewvRlTRePoTKget9TxiGoH9Vw9T+qyZqu5UbLm596sspiRkqoFA==} + resolution: + { integrity: sha512-V1Pd5Hw57qEtGaja+7QxiKPCiIfnifFZAXEewvRlTRePoTKget9TxiGoH9Vw9T+qyZqu5UbLm596sspiRkqoFA== } dependencies: - '@tsparticles/prettier-config': 2.0.0 - '@typescript-eslint/eslint-plugin': 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) + "@tsparticles/prettier-config": 2.0.0 + "@typescript-eslint/eslint-plugin": 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) eslint: 8.55.0 eslint-config-prettier: 9.1.0([email protected]) eslint-plugin-import: 2.29.0(@typescript-eslint/[email protected])([email protected]) @@ -3861,30 +4085,33 @@ packages: dev: true /@tsparticles/[email protected]: - resolution: {integrity: sha512-0cXfb2hMmA3Mu41HLu4JNCnbG/yfv9ExqVP/R5v6HSWt+uGxidYl3TJWh/bKnWwXJMK04h4Y4bLfdSZQJ7Yizw==} + resolution: + { integrity: sha512-0cXfb2hMmA3Mu41HLu4JNCnbG/yfv9ExqVP/R5v6HSWt+uGxidYl3TJWh/bKnWwXJMK04h4Y4bLfdSZQJ7Yizw== } dependencies: prettier: 3.1.0 prettier-plugin-multiline-arrays: 3.0.1([email protected]) dev: true /@tsparticles/[email protected]: - resolution: {integrity: sha512-yWeTlTj13+kpHfeFgqn4XjuzDhvxtSQpBiNRsxPPPpRj3chNRNmzd1Qkq0tn3v1G6LL/Cc6eH+jopsDiCM75nQ==} + resolution: + { integrity: sha512-yWeTlTj13+kpHfeFgqn4XjuzDhvxtSQpBiNRsxPPPpRj3chNRNmzd1Qkq0tn3v1G6LL/Cc6eH+jopsDiCM75nQ== } dependencies: typescript: 5.3.2 dev: true /@tsparticles/[email protected]: - resolution: {integrity: sha512-tk44F7oYevlLE9NAh3oj+cFd5t/ii6ru/YYxAMnRyPqVpBvuTSisxCwspbvnXInEOSpEQeXw/MtKgoeZPjHOYQ==} - dependencies: - '@babel/core': 7.23.5 - '@babel/preset-env': 7.23.3(@babel/[email protected]) - '@tsparticles/eslint-config': 2.0.0 - '@tsparticles/prettier-config': 2.0.0 - '@types/node': 20.10.3 - '@types/webpack-bundle-analyzer': 4.6.3([email protected]) - '@types/webpack-env': 1.18.4 - '@typescript-eslint/eslint-plugin': 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) + resolution: + { integrity: sha512-tk44F7oYevlLE9NAh3oj+cFd5t/ii6ru/YYxAMnRyPqVpBvuTSisxCwspbvnXInEOSpEQeXw/MtKgoeZPjHOYQ== } + dependencies: + "@babel/core": 7.23.5 + "@babel/preset-env": 7.23.3(@babel/[email protected]) + "@tsparticles/eslint-config": 2.0.0 + "@tsparticles/prettier-config": 2.0.0 + "@types/node": 20.10.3 + "@types/webpack-bundle-analyzer": 4.6.3([email protected]) + "@types/webpack-env": 1.18.4 + "@typescript-eslint/eslint-plugin": 6.13.1(@typescript-eslint/[email protected])([email protected])([email protected]) + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) babel-loader: 9.1.3(@babel/[email protected])([email protected]) browserslist: 4.22.2 copyfiles: 2.4.1 @@ -3902,8 +4129,8 @@ packages: webpack-bundle-analyzer: 4.10.1 webpack-cli: 5.1.4([email protected])([email protected]) transitivePeerDependencies: - - '@swc/core' - - '@webpack-cli/generators' + - "@swc/core" + - "@webpack-cli/generators" - bufferutil - esbuild - eslint-import-resolver-typescript @@ -3915,256 +4142,298 @@ packages: dev: true /@tufjs/[email protected]: - resolution: {integrity: sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /@tufjs/[email protected]: - resolution: {integrity: sha512-qaGV9ltJP0EO25YfFUPhxRVK0evXFIAGicsVXuRim4Ed9cjPxYhNnNJ49SFmbeLgtxpslIkX317IgpfcHPVj/A==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-qaGV9ltJP0EO25YfFUPhxRVK0evXFIAGicsVXuRim4Ed9cjPxYhNnNJ49SFmbeLgtxpslIkX317IgpfcHPVj/A== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@tufjs/canonical-json': 1.0.0 + "@tufjs/canonical-json": 1.0.0 minimatch: 9.0.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-ALYone6pm6QmwZoAgeyNksccT9Q4AWZQ6PvfwR37GT6r6FWUPguq6sUmNGSMV2Wr761oQoBxwGGa6DR5o1DC9g==} + resolution: + { integrity: sha512-ALYone6pm6QmwZoAgeyNksccT9Q4AWZQ6PvfwR37GT6r6FWUPguq6sUmNGSMV2Wr761oQoBxwGGa6DR5o1DC9g== } dependencies: - '@types/connect': 3.4.35 - '@types/node': 20.10.3 + "@types/connect": 3.4.35 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-IQ3EbTzGxIigb1I3qPZc1rWJnH0BmSKv5QYTalEwweFvyBDLSAe24zP0le/hyi7ecGfZVlIVAg4BZqb8WBwKqw==} + resolution: + { integrity: sha512-IQ3EbTzGxIigb1I3qPZc1rWJnH0BmSKv5QYTalEwweFvyBDLSAe24zP0le/hyi7ecGfZVlIVAg4BZqb8WBwKqw== } dependencies: - '@types/http-cache-semantics': 4.0.1 - '@types/keyv': 3.1.4 - '@types/node': 20.10.3 - '@types/responselike': 1.0.0 + "@types/http-cache-semantics": 4.0.1 + "@types/keyv": 3.1.4 + "@types/node": 20.10.3 + "@types/responselike": 1.0.0 dev: true /@types/[email protected]: - resolution: {integrity: sha512-qQR1dr2rGIHYlJulmr8Ioq3De0Le9E4MJ5AiaeAETJJpndT1uUNHsGFK3L/UIu+rbkQSdj8J/w2bCsBZc/Y5fQ==} + resolution: + { integrity: sha512-qQR1dr2rGIHYlJulmr8Ioq3De0Le9E4MJ5AiaeAETJJpndT1uUNHsGFK3L/UIu+rbkQSdj8J/w2bCsBZc/Y5fQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-CaWami/rQdycHKnOR+UIfBNxNeqLC5f1KqMdclbsf+TsiLgXwYm2/+KlAefcR3ODom7Fuz4bvWazDMsmfaV5gw==} + resolution: + { integrity: sha512-CaWami/rQdycHKnOR+UIfBNxNeqLC5f1KqMdclbsf+TsiLgXwYm2/+KlAefcR3ODom7Fuz4bvWazDMsmfaV5gw== } dependencies: - '@types/connect': 3.4.35 + "@types/connect": 3.4.35 dev: true /@types/[email protected]: - resolution: {integrity: sha512-cdeYyv4KWoEgpBISTxWvqYsVy444DOqehiF3fM3ne10AmJ62RSyNkUnxMJXHQWRQQX2eR94m5y1IZyDwBjV9FQ==} + resolution: + { integrity: sha512-cdeYyv4KWoEgpBISTxWvqYsVy444DOqehiF3fM3ne10AmJ62RSyNkUnxMJXHQWRQQX2eR94m5y1IZyDwBjV9FQ== } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA==} + resolution: + { integrity: sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA== } dependencies: - '@types/eslint': 8.44.0 - '@types/estree': 1.0.1 + "@types/eslint": 8.44.0 + "@types/estree": 1.0.1 dev: true /@types/[email protected]: - resolution: {integrity: sha512-gsF+c/0XOguWgaOgvFs+xnnRqt9GwgTvIks36WpE6ueeI4KCEHHd8K/CKHqhOqrJKsYH8m27kRzQEvWXAwXUTw==} + resolution: + { integrity: sha512-gsF+c/0XOguWgaOgvFs+xnnRqt9GwgTvIks36WpE6ueeI4KCEHHd8K/CKHqhOqrJKsYH8m27kRzQEvWXAwXUTw== } dependencies: - '@types/estree': 1.0.1 - '@types/json-schema': 7.0.12 + "@types/estree": 1.0.1 + "@types/json-schema": 7.0.12 dev: true /@types/[email protected]: - resolution: {integrity: sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA==} + resolution: + { integrity: sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-wALWQwrgiB2AWTT91CB62b6Yt0sNHpznUXeZEcnPU3DRdlDIz74x8Qg1UUYKSVFi+va5vKOLYRBI1bRKiLLKIg==} + resolution: + { integrity: sha512-wALWQwrgiB2AWTT91CB62b6Yt0sNHpznUXeZEcnPU3DRdlDIz74x8Qg1UUYKSVFi+va5vKOLYRBI1bRKiLLKIg== } dependencies: - '@types/node': 20.10.3 - '@types/qs': 6.9.7 - '@types/range-parser': 1.2.4 - '@types/send': 0.17.1 + "@types/node": 20.10.3 + "@types/qs": 6.9.7 + "@types/range-parser": 1.2.4 + "@types/send": 0.17.1 dev: true /@types/[email protected]: - resolution: {integrity: sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==} + resolution: + { integrity: sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ== } dependencies: - '@types/body-parser': 1.19.2 - '@types/express-serve-static-core': 4.17.35 - '@types/qs': 6.9.7 - '@types/serve-static': 1.15.1 + "@types/body-parser": 1.19.2 + "@types/express-serve-static-core": 4.17.35 + "@types/qs": 6.9.7 + "@types/serve-static": 1.15.1 dev: true /@types/[email protected]: - resolution: {integrity: sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ==} + resolution: + { integrity: sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-/7kkMsC+/kMs7gAYmmBR9P0vGTnOoLhQhyhQJSlXGI5bzTHp6xdo0TtKWQAsz6pmSAeVqKSbqeyP6hytqr9FDw==} + resolution: + { integrity: sha512-/7kkMsC+/kMs7gAYmmBR9P0vGTnOoLhQhyhQJSlXGI5bzTHp6xdo0TtKWQAsz6pmSAeVqKSbqeyP6hytqr9FDw== } dependencies: - '@types/node': 20.10.3 - '@types/tough-cookie': 4.0.2 + "@types/node": 20.10.3 + "@types/tough-cookie": 4.0.2 parse5: 7.1.2 dev: true /@types/[email protected]: - resolution: {integrity: sha512-Hr5Jfhc9eYOQNPYO5WLDq/n4jqijdHNlDXjuAQkkt+mWdQR+XJToOHrsD4cPaMXpn6KO7y2+wM8AZEs8VpBLVA==} + resolution: + { integrity: sha512-Hr5Jfhc9eYOQNPYO5WLDq/n4jqijdHNlDXjuAQkkt+mWdQR+XJToOHrsD4cPaMXpn6KO7y2+wM8AZEs8VpBLVA== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==} + resolution: + { integrity: sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==} + resolution: + { integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg== } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-2RXcRKdivPmn67pwjytvHoRv46AeXaLYVUWA0zkel1XSAOH5i71G0KfUdE5u3g80T155gR3Fo3ilVaqparLsVA==} + resolution: + { integrity: sha512-2RXcRKdivPmn67pwjytvHoRv46AeXaLYVUWA0zkel1XSAOH5i71G0KfUdE5u3g80T155gR3Fo3ilVaqparLsVA== } dependencies: - '@types/ws': 8.5.4 + "@types/ws": 8.5.4 dev: true /@types/[email protected]: - resolution: {integrity: sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==} + resolution: + { integrity: sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-Y4XFY5VJAuw0FgAqPNd6NNoV44jbq9Bz2L7Rh/J6jLTiHBSBJa9fxqQIvkIld4GsoDOcCbvzOUAbLPsSKKg+uA==} + resolution: + { integrity: sha512-Y4XFY5VJAuw0FgAqPNd6NNoV44jbq9Bz2L7Rh/J6jLTiHBSBJa9fxqQIvkIld4GsoDOcCbvzOUAbLPsSKKg+uA== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==} + resolution: + { integrity: sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ==} + resolution: + { integrity: sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-dJvrYWxP/UcXm36Qn36fxhUKu8A/xMRXVT2cliFF1Z7UA9liG5Psj3ezNSZw+5puH2czDXRLcXQxf8JbJt0ejg==} + resolution: + { integrity: sha512-dJvrYWxP/UcXm36Qn36fxhUKu8A/xMRXVT2cliFF1Z7UA9liG5Psj3ezNSZw+5puH2czDXRLcXQxf8JbJt0ejg== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-6sfo1qTulpVbkxECP+AVrHV9OoJqhzCsfTNp5NIG+enM4HyM3HvZCO798WShIXBN0+QtDIcutJCjsVYnQP5rIQ==} + resolution: + { integrity: sha512-6sfo1qTulpVbkxECP+AVrHV9OoJqhzCsfTNp5NIG+enM4HyM3HvZCO798WShIXBN0+QtDIcutJCjsVYnQP5rIQ== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-GXZxEtOxYGFchyUzxvKI14iff9KZ2DI+A6a37o6EQevtg6uO9t+aUZKcaC1Te5Ng1OnLM7K9NVVj+FbecD9cJg==} + resolution: + { integrity: sha512-GXZxEtOxYGFchyUzxvKI14iff9KZ2DI+A6a37o6EQevtg6uO9t+aUZKcaC1Te5Ng1OnLM7K9NVVj+FbecD9cJg== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-XJavIpZqiXID5Yxnxv3RUDKTN5b81ddNC3ecsA0SoFXz/QU8OGBwZGMomiq0zw+uuqbL/krztv/DINAQ/EV4gg==} + resolution: + { integrity: sha512-XJavIpZqiXID5Yxnxv3RUDKTN5b81ddNC3ecsA0SoFXz/QU8OGBwZGMomiq0zw+uuqbL/krztv/DINAQ/EV4gg== } dependencies: undici-types: 5.26.5 dev: true /@types/[email protected]: - resolution: {integrity: sha512-TlgT8JntpcbmKUFzjhsyhGfP2fsiz1Mv56im6enJ905xG1DAYesxJaeSbGqQmAw8OWPdhyJGhGSQGKRNJ45u9w==} + resolution: + { integrity: sha512-TlgT8JntpcbmKUFzjhsyhGfP2fsiz1Mv56im6enJ905xG1DAYesxJaeSbGqQmAw8OWPdhyJGhGSQGKRNJ45u9w== } dependencies: undici-types: 5.26.5 dev: true /@types/[email protected]: - resolution: {integrity: sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw==} + resolution: + { integrity: sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-FGa1F62FT09qcrueBA6qYTrJPVDzah9a+493+o2PCXsesWHIn27G98TsSMs3WPNbZIEj4+VJf6saSFpvD+3Zsw==} + resolution: + { integrity: sha512-FGa1F62FT09qcrueBA6qYTrJPVDzah9a+493+o2PCXsesWHIn27G98TsSMs3WPNbZIEj4+VJf6saSFpvD+3Zsw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-EEhsLsD6UsDM1yFhAvy0Cjr6VwmpMWqFBCb9w07wVugF7w9nfajxLuVmngTIpgS6svCnm6Vaw+MZhoDCKnOfsw==} + resolution: + { integrity: sha512-EEhsLsD6UsDM1yFhAvy0Cjr6VwmpMWqFBCb9w07wVugF7w9nfajxLuVmngTIpgS6svCnm6Vaw+MZhoDCKnOfsw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-85Y2BjiufFzaMIlvJDvTTB8Fxl2xfLo4HgmHzVBz08w4wDePCTjYw66PdrolO0kzli3yam/YCgRufyo1DdQVTA==} + resolution: + { integrity: sha512-85Y2BjiufFzaMIlvJDvTTB8Fxl2xfLo4HgmHzVBz08w4wDePCTjYw66PdrolO0kzli3yam/YCgRufyo1DdQVTA== } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-G8hZ6XJiHnuhQKR7ZmysCeJWE08o8T0AXtk5darsCaTVsYZhhgUrq53jizaR2FvsoeCwJhlmwTjkXBY5Pn/ZHw==} + resolution: + { integrity: sha512-G8hZ6XJiHnuhQKR7ZmysCeJWE08o8T0AXtk5darsCaTVsYZhhgUrq53jizaR2FvsoeCwJhlmwTjkXBY5Pn/ZHw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-Cwo8LE/0rnvX7kIIa3QHCkcuF21c05Ayb0ZfxPiv0W8VRiZiNW/WuRupHKpqqGVGf7SUA44QSOUKaEd9lIrd/Q==} + resolution: + { integrity: sha512-Cwo8LE/0rnvX7kIIa3QHCkcuF21c05Ayb0ZfxPiv0W8VRiZiNW/WuRupHKpqqGVGf7SUA44QSOUKaEd9lIrd/Q== } dependencies: - '@types/mime': 1.3.2 - '@types/node': 20.10.3 + "@types/mime": 1.3.2 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-NUo5XNiAdULrJENtJXZZ3fHtfMolzZwczzBbnAeBbqBwG+LaG6YaJtuwzwGSQZ2wsCrxjEhNNjAkKigy3n8teQ==} + resolution: + { integrity: sha512-NUo5XNiAdULrJENtJXZZ3fHtfMolzZwczzBbnAeBbqBwG+LaG6YaJtuwzwGSQZ2wsCrxjEhNNjAkKigy3n8teQ== } dependencies: - '@types/mime': 3.0.1 - '@types/node': 20.10.3 + "@types/mime": 3.0.1 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-u0BzfnIgn/0I1YpAJGhkj9lUTLeiuiDXYOagXwe2aAsX8OKDFEWP6vqMMPxy4leQeX45LNDdCEjDJkuRxPCv7A==} + resolution: + { integrity: sha512-u0BzfnIgn/0I1YpAJGhkj9lUTLeiuiDXYOagXwe2aAsX8OKDFEWP6vqMMPxy4leQeX45LNDdCEjDJkuRxPCv7A== } dependencies: - '@types/node': 20.8.10 + "@types/node": 20.8.10 dev: true /@types/[email protected]: - resolution: {integrity: sha512-Q5vtl1W5ue16D+nIaW8JWebSSraJVlK+EthKn7e7UcD4KWsaSJ8BqGPXNaPghgtcn/fhvrN17Tv8ksUsQpiplw==} + resolution: + { integrity: sha512-Q5vtl1W5ue16D+nIaW8JWebSSraJVlK+EthKn7e7UcD4KWsaSJ8BqGPXNaPghgtcn/fhvrN17Tv8ksUsQpiplw== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-txGIh+0eDFzKGC25zORnswy+br1Ha7hj5cMVwKIU7+s0U2AxxJru/jZSMU6OC9MJWP6+pc/hc6ZjyZShpsyY2g==} + resolution: + { integrity: sha512-txGIh+0eDFzKGC25zORnswy+br1Ha7hj5cMVwKIU7+s0U2AxxJru/jZSMU6OC9MJWP6+pc/hc6ZjyZShpsyY2g== } dev: true /@types/[email protected]([email protected]): - resolution: {integrity: sha512-XYU3m7oRb1tlE8YhwkKLi1xba2buNB9V4VkQtOVTfJuUm/413pE/UCMVcPDFFBwpzGkr9y1WbSEvdPjKVPt0gw==} + resolution: + { integrity: sha512-XYU3m7oRb1tlE8YhwkKLi1xba2buNB9V4VkQtOVTfJuUm/413pE/UCMVcPDFFBwpzGkr9y1WbSEvdPjKVPt0gw== } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 tapable: 2.2.1 webpack: 5.89.0([email protected]) transitivePeerDependencies: - - '@swc/core' + - "@swc/core" - esbuild - uglify-js - webpack-cli dev: true /@types/[email protected]: - resolution: {integrity: sha512-I6e+9+HtWADAWeeJWDFQtdk4EVSAbj6Rtz4q8fJ7mSr1M0jzlFcs8/HZ+Xb5SHzVm1dxH7aUiI+A8kA8Gcrm0A==} + resolution: + { integrity: sha512-I6e+9+HtWADAWeeJWDFQtdk4EVSAbj6Rtz4q8fJ7mSr1M0jzlFcs8/HZ+Xb5SHzVm1dxH7aUiI+A8kA8Gcrm0A== } dev: true /@types/[email protected]: - resolution: {integrity: sha512-zdQDHKUgcX/zBc4GrwsE/7dVdAD8JR4EuiAXiiUhhfyIJXXb2+PrGshFyeXWQPMmmZ2XxgaqclgpIC7eTXc1mg==} + resolution: + { integrity: sha512-zdQDHKUgcX/zBc4GrwsE/7dVdAD8JR4EuiAXiiUhhfyIJXXb2+PrGshFyeXWQPMmmZ2XxgaqclgpIC7eTXc1mg== } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 dev: true /@types/[email protected]: - resolution: {integrity: sha512-Cn6WYCm0tXv8p6k+A8PvbDG763EDpBoTzHdA+Q/MF6H3sapGjCm9NzoaJncJS9tUKSuCoDs9XHxYYsQDgxR6kw==} + resolution: + { integrity: sha512-Cn6WYCm0tXv8p6k+A8PvbDG763EDpBoTzHdA+Q/MF6H3sapGjCm9NzoaJncJS9tUKSuCoDs9XHxYYsQDgxR6kw== } requiresBuild: true dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 dev: true optional: true /@typescript-eslint/[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): - resolution: {integrity: sha512-5bQDGkXaxD46bPvQt08BUz9YSaO4S0fB1LB5JHQuXTfkGPI3+UUeS387C/e9jRie5GqT8u5kFTrMvAjtX4O5kA==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-5bQDGkXaxD46bPvQt08BUz9YSaO4S0fB1LB5JHQuXTfkGPI3+UUeS387C/e9jRie5GqT8u5kFTrMvAjtX4O5kA== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } peerDependencies: - '@typescript-eslint/parser': ^6.0.0 \|\| ^6.0.0-alpha + "@typescript-eslint/parser": ^6.0.0 \|\| ^6.0.0-alpha eslint: ^7.0.0 \|\| ^8.0.0 - typescript: '' + typescript: "" peerDependenciesMeta: typescript: optional: true dependencies: - '@eslint-community/regexpp': 4.6.2 - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) - '@typescript-eslint/scope-manager': 6.13.1 - '@typescript-eslint/type-utils': 6.13.1([email protected])([email protected]) - '@typescript-eslint/utils': 6.13.1([email protected])([email protected]) - '@typescript-eslint/visitor-keys': 6.13.1 + "@eslint-community/regexpp": 4.6.2 + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) + "@typescript-eslint/scope-manager": 6.13.1 + "@typescript-eslint/type-utils": 6.13.1([email protected])([email protected]) + "@typescript-eslint/utils": 6.13.1([email protected])([email protected]) + "@typescript-eslint/visitor-keys": 6.13.1 debug: 4.3.4([email protected]) eslint: 8.55.0 graphemer: 1.4.0 @@ -4178,19 +4447,20 @@ packages: dev: true /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-fs2XOhWCzRhqMmQf0eicLa/CWSaYss2feXsy7xBD/pLyWke/jCIVc2s1ikEAtSW7ina1HNhv7kONoEfVNEcdDQ==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-fs2XOhWCzRhqMmQf0eicLa/CWSaYss2feXsy7xBD/pLyWke/jCIVc2s1ikEAtSW7ina1HNhv7kONoEfVNEcdDQ== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } peerDependencies: eslint: ^7.0.0 \|\| ^8.0.0 - typescript: '' + typescript: "" peerDependenciesMeta: typescript: optional: true dependencies: - '@typescript-eslint/scope-manager': 6.13.1 - '@typescript-eslint/types': 6.13.1 - '@typescript-eslint/typescript-estree': 6.13.1([email protected]) - '@typescript-eslint/visitor-keys': 6.13.1 + "@typescript-eslint/scope-manager": 6.13.1 + "@typescript-eslint/types": 6.13.1 + "@typescript-eslint/typescript-estree": 6.13.1([email protected]) + "@typescript-eslint/visitor-keys": 6.13.1 debug: 4.3.4([email protected]) eslint: 8.55.0 typescript: 5.3.2 @@ -4199,25 +4469,27 @@ packages: dev: true /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-BW0kJ7ceiKi56GbT2KKzZzN+nDxzQK2DS6x0PiSMPjciPgd/JRQGMibyaN2cPt2cAvuoH0oNvn2fwonHI+4QUQ==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-BW0kJ7ceiKi56GbT2KKzZzN+nDxzQK2DS6x0PiSMPjciPgd/JRQGMibyaN2cPt2cAvuoH0oNvn2fwonHI+4QUQ== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } dependencies: - '@typescript-eslint/types': 6.13.1 - '@typescript-eslint/visitor-keys': 6.13.1 + "@typescript-eslint/types": 6.13.1 + "@typescript-eslint/visitor-keys": 6.13.1 dev: true /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-A2qPlgpxx2v//3meMqQyB1qqTg1h1dJvzca7TugM3Yc2USDY+fsRBiojAEo92HO7f5hW5mjAUF6qobOPzlBCBQ==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-A2qPlgpxx2v//3meMqQyB1qqTg1h1dJvzca7TugM3Yc2USDY+fsRBiojAEo92HO7f5hW5mjAUF6qobOPzlBCBQ== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } peerDependencies: eslint: ^7.0.0 \|\| ^8.0.0 - typescript: '' + typescript: "" peerDependenciesMeta: typescript: optional: true dependencies: - '@typescript-eslint/typescript-estree': 6.13.1([email protected]) - '@typescript-eslint/utils': 6.13.1([email protected])([email protected]) + "@typescript-eslint/typescript-estree": 6.13.1([email protected]) + "@typescript-eslint/utils": 6.13.1([email protected])([email protected]) debug: 4.3.4([email protected]) eslint: 8.55.0 ts-api-utils: 1.0.1([email protected]) @@ -4227,21 +4499,23 @@ packages: dev: true /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-gjeEskSmiEKKFIbnhDXUyiqVma1gRCQNbVZ1C8q7Zjcxh3WZMbzWVfGE9rHfWd1msQtPS0BVD9Jz9jded44eKg==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-gjeEskSmiEKKFIbnhDXUyiqVma1gRCQNbVZ1C8q7Zjcxh3WZMbzWVfGE9rHfWd1msQtPS0BVD9Jz9jded44eKg== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } dev: true /@typescript-eslint/[email protected]([email protected]): - resolution: {integrity: sha512-sBLQsvOC0Q7LGcUHO5qpG1HxRgePbT6wwqOiGLpR8uOJvPJbfs0mW3jPA3ujsDvfiVwVlWUDESNXv44KtINkUQ==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-sBLQsvOC0Q7LGcUHO5qpG1HxRgePbT6wwqOiGLpR8uOJvPJbfs0mW3jPA3ujsDvfiVwVlWUDESNXv44KtINkUQ== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } peerDependencies: - typescript: '' + typescript: "" peerDependenciesMeta: typescript: optional: true dependencies: - '@typescript-eslint/types': 6.13.1 - '@typescript-eslint/visitor-keys': 6.13.1 + "@typescript-eslint/types": 6.13.1 + "@typescript-eslint/visitor-keys": 6.13.1 debug: 4.3.4([email protected]) globby: 11.1.0 is-glob: 4.0.3 @@ -4253,17 +4527,18 @@ packages: dev: true /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-ouPn/zVoan92JgAegesTXDB/oUp6BP1v8WpfYcqh649ejNc9Qv+B4FF2Ff626kO1xg0wWwwG48lAJ4JuesgdOw==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-ouPn/zVoan92JgAegesTXDB/oUp6BP1v8WpfYcqh649ejNc9Qv+B4FF2Ff626kO1xg0wWwwG48lAJ4JuesgdOw== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } peerDependencies: eslint: ^7.0.0 \|\| ^8.0.0 dependencies: - '@eslint-community/eslint-utils': 4.4.0([email protected]) - '@types/json-schema': 7.0.12 - '@types/semver': 7.5.0 - '@typescript-eslint/scope-manager': 6.13.1 - '@typescript-eslint/types': 6.13.1 - '@typescript-eslint/typescript-estree': 6.13.1([email protected]) + "@eslint-community/eslint-utils": 4.4.0([email protected]) + "@types/json-schema": 7.0.12 + "@types/semver": 7.5.0 + "@typescript-eslint/scope-manager": 6.13.1 + "@typescript-eslint/types": 6.13.1 + "@typescript-eslint/typescript-estree": 6.13.1([email protected]) eslint: 8.55.0 semver: 7.5.4 transitivePeerDependencies: @@ -4272,126 +4547,144 @@ packages: dev: true /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-NDhQUy2tg6XGNBGDRm1XybOHSia8mcXmlbKWoQP+nm1BIIMxa55shyJfZkHpEBN62KNPLrocSM2PdPcaLgDKMQ==} - engines: {node: ^16.0.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-NDhQUy2tg6XGNBGDRm1XybOHSia8mcXmlbKWoQP+nm1BIIMxa55shyJfZkHpEBN62KNPLrocSM2PdPcaLgDKMQ== } + engines: { node: ^16.0.0 \|\| >=18.0.0 } dependencies: - '@typescript-eslint/types': 6.13.1 + "@typescript-eslint/types": 6.13.1 eslint-visitor-keys: 3.4.3 dev: true /@ungap/[email protected]: - resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==} + resolution: + { integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-IN1xI7PwOvLPgjcf180gC1bqn3q/QaOCwYUahIOhbYUu8KA/3tw2RT/T0Gidi1l7Hhj5D/INhJxiICObqpMu4Q==} + resolution: + { integrity: sha512-IN1xI7PwOvLPgjcf180gC1bqn3q/QaOCwYUahIOhbYUu8KA/3tw2RT/T0Gidi1l7Hhj5D/INhJxiICObqpMu4Q== } dependencies: - '@webassemblyjs/helper-numbers': 1.11.6 - '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + "@webassemblyjs/helper-numbers": 1.11.6 + "@webassemblyjs/helper-wasm-bytecode": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==} + resolution: + { integrity: sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==} + resolution: + { integrity: sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-z3nFzdcp1mb8nEOFFk8DrYLpHvhKC3grJD2ardfKOzmbmJvEf/tPIqCY+sNcwZIY8ZD7IkB2l7/pqhUhqm7hLA==} + resolution: + { integrity: sha512-z3nFzdcp1mb8nEOFFk8DrYLpHvhKC3grJD2ardfKOzmbmJvEf/tPIqCY+sNcwZIY8ZD7IkB2l7/pqhUhqm7hLA== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==} + resolution: + { integrity: sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g== } dependencies: - '@webassemblyjs/floating-point-hex-parser': 1.11.6 - '@webassemblyjs/helper-api-error': 1.11.6 - '@xtuc/long': 4.2.2 + "@webassemblyjs/floating-point-hex-parser": 1.11.6 + "@webassemblyjs/helper-api-error": 1.11.6 + "@xtuc/long": 4.2.2 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==} + resolution: + { integrity: sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-LPpZbSOwTpEC2cgn4hTydySy1Ke+XEu+ETXuoyvuyezHO3Kjdu90KK95Sh9xTbmjrCsUwvWwCOQQNta37VrS9g==} + resolution: + { integrity: sha512-LPpZbSOwTpEC2cgn4hTydySy1Ke+XEu+ETXuoyvuyezHO3Kjdu90KK95Sh9xTbmjrCsUwvWwCOQQNta37VrS9g== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/helper-buffer': 1.11.6 - '@webassemblyjs/helper-wasm-bytecode': 1.11.6 - '@webassemblyjs/wasm-gen': 1.11.6 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/helper-buffer": 1.11.6 + "@webassemblyjs/helper-wasm-bytecode": 1.11.6 + "@webassemblyjs/wasm-gen": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==} + resolution: + { integrity: sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg== } dependencies: - '@xtuc/ieee754': 1.2.0 + "@xtuc/ieee754": 1.2.0 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==} + resolution: + { integrity: sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ== } dependencies: - '@xtuc/long': 4.2.2 + "@xtuc/long": 4.2.2 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==} + resolution: + { integrity: sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA== } dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-Ybn2I6fnfIGuCR+Faaz7YcvtBKxvoLV3Lebn1tM4o/IAJzmi9AWYIPWpyBfU8cC+JxAO57bk4+zdsTjJR+VTOw==} + resolution: + { integrity: sha512-Ybn2I6fnfIGuCR+Faaz7YcvtBKxvoLV3Lebn1tM4o/IAJzmi9AWYIPWpyBfU8cC+JxAO57bk4+zdsTjJR+VTOw== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/helper-buffer': 1.11.6 - '@webassemblyjs/helper-wasm-bytecode': 1.11.6 - '@webassemblyjs/helper-wasm-section': 1.11.6 - '@webassemblyjs/wasm-gen': 1.11.6 - '@webassemblyjs/wasm-opt': 1.11.6 - '@webassemblyjs/wasm-parser': 1.11.6 - '@webassemblyjs/wast-printer': 1.11.6 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/helper-buffer": 1.11.6 + "@webassemblyjs/helper-wasm-bytecode": 1.11.6 + "@webassemblyjs/helper-wasm-section": 1.11.6 + "@webassemblyjs/wasm-gen": 1.11.6 + "@webassemblyjs/wasm-opt": 1.11.6 + "@webassemblyjs/wasm-parser": 1.11.6 + "@webassemblyjs/wast-printer": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-3XOqkZP/y6B4F0PBAXvI1/bky7GryoogUtfwExeP/v7Nzwo1QLcq5oQmpKlftZLbT+ERUOAZVQjuNVak6UXjPA==} + resolution: + { integrity: sha512-3XOqkZP/y6B4F0PBAXvI1/bky7GryoogUtfwExeP/v7Nzwo1QLcq5oQmpKlftZLbT+ERUOAZVQjuNVak6UXjPA== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/helper-wasm-bytecode': 1.11.6 - '@webassemblyjs/ieee754': 1.11.6 - '@webassemblyjs/leb128': 1.11.6 - '@webassemblyjs/utf8': 1.11.6 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/helper-wasm-bytecode": 1.11.6 + "@webassemblyjs/ieee754": 1.11.6 + "@webassemblyjs/leb128": 1.11.6 + "@webassemblyjs/utf8": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-cOrKuLRE7PCe6AsOVl7WasYf3wbSo4CeOk6PkrjS7g57MFfVUF9u6ysQBBODX0LdgSvQqRiGz3CXvIDKcPNy4g==} + resolution: + { integrity: sha512-cOrKuLRE7PCe6AsOVl7WasYf3wbSo4CeOk6PkrjS7g57MFfVUF9u6ysQBBODX0LdgSvQqRiGz3CXvIDKcPNy4g== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/helper-buffer': 1.11.6 - '@webassemblyjs/wasm-gen': 1.11.6 - '@webassemblyjs/wasm-parser': 1.11.6 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/helper-buffer": 1.11.6 + "@webassemblyjs/wasm-gen": 1.11.6 + "@webassemblyjs/wasm-parser": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-6ZwPeGzMJM3Dqp3hCsLgESxBGtT/OeCvCZ4TA1JUPYgmhAx38tTPR9JaKy0S5H3evQpO/h2uWs2j6Yc/fjkpTQ==} + resolution: + { integrity: sha512-6ZwPeGzMJM3Dqp3hCsLgESxBGtT/OeCvCZ4TA1JUPYgmhAx38tTPR9JaKy0S5H3evQpO/h2uWs2j6Yc/fjkpTQ== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/helper-api-error': 1.11.6 - '@webassemblyjs/helper-wasm-bytecode': 1.11.6 - '@webassemblyjs/ieee754': 1.11.6 - '@webassemblyjs/leb128': 1.11.6 - '@webassemblyjs/utf8': 1.11.6 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/helper-api-error": 1.11.6 + "@webassemblyjs/helper-wasm-bytecode": 1.11.6 + "@webassemblyjs/ieee754": 1.11.6 + "@webassemblyjs/leb128": 1.11.6 + "@webassemblyjs/utf8": 1.11.6 dev: true /@webassemblyjs/[email protected]: - resolution: {integrity: sha512-JM7AhRcE+yW2GWYaKeHL5vt4xqee5N2WcezptmgyhNS+ScggqcT1OtXykhAb13Sn5Yas0j2uv9tHgrjwvzAP4A==} + resolution: + { integrity: sha512-JM7AhRcE+yW2GWYaKeHL5vt4xqee5N2WcezptmgyhNS+ScggqcT1OtXykhAb13Sn5Yas0j2uv9tHgrjwvzAP4A== } dependencies: - '@webassemblyjs/ast': 1.11.6 - '@xtuc/long': 4.2.2 + "@webassemblyjs/ast": 1.11.6 + "@xtuc/long": 4.2.2 dev: true /@webpack-cli/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-wy0mglZpDSiSS0XHrVR+BAdId2+yxPSoJW8fsna3ZpYSlufjvxnP4YbKTCBZnNIcGN4r6ZPXV55X4mYExOfLmw==} - engines: {node: '>=14.15.0'} + resolution: + { integrity: sha512-wy0mglZpDSiSS0XHrVR+BAdId2+yxPSoJW8fsna3ZpYSlufjvxnP4YbKTCBZnNIcGN4r6ZPXV55X4mYExOfLmw== } + engines: { node: ">=14.15.0" } peerDependencies: webpack: 5.x.x webpack-cli: 5.x.x @@ -4401,8 +4694,9 @@ packages: dev: true /@webpack-cli/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-zLHQdI/Qs1UyT5UBdWNqsARasIA+AaF8t+4u2aS2nEpBQh2mWIVb8qAklq0eUENnC5mOItrIB4LiS9xMtph18A==} - engines: {node: '>=14.15.0'} + resolution: + { integrity: sha512-zLHQdI/Qs1UyT5UBdWNqsARasIA+AaF8t+4u2aS2nEpBQh2mWIVb8qAklq0eUENnC5mOItrIB4LiS9xMtph18A== } + engines: { node: ">=14.15.0" } peerDependencies: webpack: 5.x.x webpack-cli: 5.x.x @@ -4412,12 +4706,13 @@ packages: dev: true /@webpack-cli/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-lqaoKnRYBdo1UgDX8uF24AfGMifWK19TxPmM5FHc2vAGxrJ/qtyUyFBWoY1tISZdelsQ5fBcOusifo5o5wSJxQ==} - engines: {node: '>=14.15.0'} + resolution: + { integrity: sha512-lqaoKnRYBdo1UgDX8uF24AfGMifWK19TxPmM5FHc2vAGxrJ/qtyUyFBWoY1tISZdelsQ5fBcOusifo5o5wSJxQ== } + engines: { node: ">=14.15.0" } peerDependencies: webpack: 5.x.x webpack-cli: 5.x.x - webpack-dev-server: '' + webpack-dev-server: "" peerDependenciesMeta: webpack-dev-server: optional: true @@ -4427,34 +4722,40 @@ packages: dev: true /@xtuc/[email protected]: - resolution: {integrity: sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==} + resolution: + { integrity: sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA== } dev: true /@xtuc/[email protected]: - resolution: {integrity: sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==} + resolution: + { integrity: sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ== } dev: true /@yarnpkg/[email protected]: - resolution: {integrity: sha512-GpSwvyXOcOOlV70vbnzjj4fW5xW/FdUF6nQEt1ENy7m4ZCczi1+/buVUPAqmGfqznsORNFzUMjctTIp8a9tuCQ==} + resolution: + { integrity: sha512-GpSwvyXOcOOlV70vbnzjj4fW5xW/FdUF6nQEt1ENy7m4ZCczi1+/buVUPAqmGfqznsORNFzUMjctTIp8a9tuCQ== } dev: true /@yarnpkg/[email protected]: - resolution: {integrity: sha512-aiATs7pSutzda/rq8fnuPwTglyVwjM22bNnK2ZgjrpAjQHSSl3lztd2f9evst1W/qnC58DRz7T7QndUDumAR4Q==} - engines: {node: '>=14.15.0'} + resolution: + { integrity: sha512-aiATs7pSutzda/rq8fnuPwTglyVwjM22bNnK2ZgjrpAjQHSSl3lztd2f9evst1W/qnC58DRz7T7QndUDumAR4Q== } + engines: { node: ">=14.15.0" } dependencies: js-yaml: 3.14.1 tslib: 2.6.0 dev: true /@zkochan/[email protected]: - resolution: {integrity: sha512-nzvgl3VfhcELQ8LyVrYOru+UtAy1nrygk2+AGbTm8a5YcO6o8lSjAT+pfg3vJWxIoZKOUhrK6UU7xW/+00kQrg==} + resolution: + { integrity: sha512-nzvgl3VfhcELQ8LyVrYOru+UtAy1nrygk2+AGbTm8a5YcO6o8lSjAT+pfg3vJWxIoZKOUhrK6UU7xW/+00kQrg== } hasBin: true dependencies: argparse: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ==} + resolution: + { integrity: sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ== } hasBin: true dependencies: jsonparse: 1.3.1 @@ -4462,30 +4763,35 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==} + resolution: + { integrity: sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q== } dev: true /[email protected]: - resolution: {integrity: sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==} - engines: {node: '>=6.5'} + resolution: + { integrity: sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg== } + engines: { node: ">=6.5" } dependencies: event-target-shim: 5.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw== } + engines: { node: ">= 0.6" } dependencies: mime-types: 2.1.35 negotiator: 0.6.3 dev: true /[email protected]: - resolution: {integrity: sha512-3DnE5bZF6Ji+l4F5acoLk+rV7mxrUt1C4r61Xy9owp5rVM4lj5NL8GJfoX6Jnnbhx6kKV7Vdpb+Tco+0ORTvhg==} + resolution: + { integrity: sha512-3DnE5bZF6Ji+l4F5acoLk+rV7mxrUt1C4r61Xy9owp5rVM4lj5NL8GJfoX6Jnnbhx6kKV7Vdpb+Tco+0ORTvhg== } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-cmMwop9x+8KFhxvKrKfPYmN6/pKTYYHBqLa0DfvVZcKMJWNyWLnaqND7dx/qn66R7ewM1UX5XMaDVP5wlVTaVA==} + resolution: + { integrity: sha512-cmMwop9x+8KFhxvKrKfPYmN6/pKTYYHBqLa0DfvVZcKMJWNyWLnaqND7dx/qn66R7ewM1UX5XMaDVP5wlVTaVA== } peerDependencies: acorn: ^8 dependencies: @@ -4493,7 +4799,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} + resolution: + { integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== } peerDependencies: acorn: ^6.0.0 \|\| ^7.0.0 \|\| ^8.0.0 dependencies: @@ -4501,29 +4808,34 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==} - engines: {node: '>=0.4.0'} + resolution: + { integrity: sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA== } + engines: { node: ">=0.4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==} - engines: {node: '>=0.4.0'} + resolution: + { integrity: sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A== } + engines: { node: ">=0.4.0" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==} - engines: {node: '>=0.4.0'} + resolution: + { integrity: sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw== } + engines: { node: ">=0.4.0" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-qQLMr+8o0WC4FZGQTcJiKBVC59JylcPSrTtk6usvmIDFUOCKegapy1VHQwRbFMOFyb/inzUVqHs+eMYKDM1YeQ==} + resolution: + { integrity: sha512-qQLMr+8o0WC4FZGQTcJiKBVC59JylcPSrTtk6usvmIDFUOCKegapy1VHQwRbFMOFyb/inzUVqHs+eMYKDM1YeQ== } dev: true /[email protected]: - resolution: {integrity: sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==} - engines: {node: '>= 6.0.0'} + resolution: + { integrity: sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ== } + engines: { node: ">= 6.0.0" } dependencies: debug: 4.3.4([email protected]) transitivePeerDependencies: @@ -4531,8 +4843,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-o/zjMZRhJxny7OyEF+Op8X+efiELC7k7yOjMzgfzVqOzXqkBkWI79YoTdOtsuWd5BWhAGAuOY/Xa6xpiaWXiNg==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-o/zjMZRhJxny7OyEF+Op8X+efiELC7k7yOjMzgfzVqOzXqkBkWI79YoTdOtsuWd5BWhAGAuOY/Xa6xpiaWXiNg== } + engines: { node: ">= 14" } dependencies: debug: 4.3.4([email protected]) transitivePeerDependencies: @@ -4540,8 +4853,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7Epl1Blf4Sy37j4v9f9FjICCh4+KAQOyXgHEwlyBiAQLbhKdq/i2QQU3amQalS/wPhdPzDXPL5DMR5bkn+YeWg==} - engines: {node: '>= 8.0.0'} + resolution: + { integrity: sha512-7Epl1Blf4Sy37j4v9f9FjICCh4+KAQOyXgHEwlyBiAQLbhKdq/i2QQU3amQalS/wPhdPzDXPL5DMR5bkn+YeWg== } + engines: { node: ">= 8.0.0" } dependencies: debug: 4.3.4([email protected]) depd: 2.0.0 @@ -4551,15 +4865,17 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== } + engines: { node: ">=8" } dependencies: clean-stack: 2.2.0 indent-string: 4.0.0 dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==} + resolution: + { integrity: sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA== } peerDependencies: ajv: ^8.0.0 peerDependenciesMeta: @@ -4570,7 +4886,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==} + resolution: + { integrity: sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ== } peerDependencies: ajv: ^6.9.1 dependencies: @@ -4578,7 +4895,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==} + resolution: + { integrity: sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw== } peerDependencies: ajv: ^8.8.2 dependencies: @@ -4587,7 +4905,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==} + resolution: + { integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== } dependencies: fast-deep-equal: 3.1.3 fast-json-stable-stringify: 2.1.0 @@ -4596,7 +4915,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==} + resolution: + { integrity: sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA== } dependencies: fast-deep-equal: 3.1.3 json-schema-traverse: 1.0.0 @@ -4605,141 +4925,166 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== } + engines: { node: ">=8" } dependencies: type-fest: 0.21.3 dev: true /[email protected]: - resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==} + resolution: + { integrity: sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ== } dev: true /[email protected]: - resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== } + engines: { node: ">=4" } dependencies: color-convert: 1.9.3 dev: true /[email protected]: - resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== } + engines: { node: ">=8" } dependencies: color-convert: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== } + engines: { node: ">= 8" } dependencies: normalize-path: 3.0.0 picomatch: 2.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-7yeyCEurROLQJFv5Xj4lEGTy0borxepjFv1g22oAdqFu//SrAlDl1O1Nxx15SH1RoliUml6p8dwJW9jvZughhg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-7yeyCEurROLQJFv5Xj4lEGTy0borxepjFv1g22oAdqFu//SrAlDl1O1Nxx15SH1RoliUml6p8dwJW9jvZughhg== } + engines: { node: ">=8" } dependencies: default-require-extensions: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==} + resolution: + { integrity: sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ== } dev: true /[email protected]: - resolution: {integrity: sha512-Xg+9RwCg/0p32teKdGMPTPnVXKD0w3DfHnFTficozsAgsvq2XenPJq/MYpzzQ/v8zrOyJn6Ds39VA4JIDwFfqw==} + resolution: + { integrity: sha512-Xg+9RwCg/0p32teKdGMPTPnVXKD0w3DfHnFTficozsAgsvq2XenPJq/MYpzzQ/v8zrOyJn6Ds39VA4JIDwFfqw== } dev: true /[email protected]: - resolution: {integrity: sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig== } + engines: { node: ">=14" } dev: true /[email protected]: - resolution: {integrity: sha512-Ci/qENmwHnsYo9xKIcUJN5LeDKdJ6R1Z1j9V/J5wyq8nh/mYPEpIKJbBZXtZjG04HiK7zV/p6Vs9952MrMeUIw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Ci/qENmwHnsYo9xKIcUJN5LeDKdJ6R1Z1j9V/J5wyq8nh/mYPEpIKJbBZXtZjG04HiK7zV/p6Vs9952MrMeUIw== } + engines: { node: ">=10" } dependencies: delegates: 1.0.0 readable-stream: 3.6.2 dev: true /[email protected]: - resolution: {integrity: sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } dependencies: delegates: 1.0.0 readable-stream: 3.6.2 dev: true /[email protected]: - resolution: {integrity: sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==} + resolution: + { integrity: sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA== } dev: true /[email protected]: - resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==} + resolution: + { integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== } dependencies: sprintf-js: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} + resolution: + { integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== } dev: true /[email protected]: - resolution: {integrity: sha512-LPuwb2P+NrQw3XhxGc36+XSvuBPopovXYTR9Ew++Du9Yb/bx5AzBfrIsBoj0EZUifjQU+sHL21sseZ3jerWO/A==} + resolution: + { integrity: sha512-LPuwb2P+NrQw3XhxGc36+XSvuBPopovXYTR9Ew++Du9Yb/bx5AzBfrIsBoj0EZUifjQU+sHL21sseZ3jerWO/A== } dependencies: call-bind: 1.0.5 is-array-buffer: 3.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-THtfYS6KtME/yIAhKjZ2ul7XI96lQGHRputJQHO80LAWQnuGP4iCIN8vdMRboGbIEYBwU33q8Tch1os2+X0kMg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-THtfYS6KtME/yIAhKjZ2ul7XI96lQGHRputJQHO80LAWQnuGP4iCIN8vdMRboGbIEYBwU33q8Tch1os2+X0kMg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==} + resolution: + { integrity: sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg== } dev: true /[email protected]: - resolution: {integrity: sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng==} + resolution: + { integrity: sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng== } dev: true /[email protected]: - resolution: {integrity: sha512-dlcsNBIiWhPkHdOEEKnehA+RNUWDc4UqFtnIXU4uuYDPtA4LDkr7qip2p0VvFAEXNDr0yWZ9PJyIRiGjRLQzwQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-dlcsNBIiWhPkHdOEEKnehA+RNUWDc4UqFtnIXU4uuYDPtA4LDkr7qip2p0VvFAEXNDr0yWZ9PJyIRiGjRLQzwQ== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -4749,25 +5094,29 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Dxr6QJj/RdU/hCaBjOfxW+q6lyuVE6JFWIrAUpuOOhoJJoQ99cUn3igRaHVB5P9WrgFVN0FfArM3x0cueOU8ng==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-Dxr6QJj/RdU/hCaBjOfxW+q6lyuVE6JFWIrAUpuOOhoJJoQ99cUn3igRaHVB5P9WrgFVN0FfArM3x0cueOU8ng== } + engines: { node: ">=0.10.0" } dependencies: array-uniq: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-LzLoiOMAxvy+Gd3BAq3B7VeIgPdo+Q8hthvKtXybMvRV0jrXfJM/t8mw7nNlpEcVlVUnCnM2KSX4XU5HmpodOA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-LzLoiOMAxvy+Gd3BAq3B7VeIgPdo+Q8hthvKtXybMvRV0jrXfJM/t8mw7nNlpEcVlVUnCnM2KSX4XU5HmpodOA== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -4777,8 +5126,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -4787,8 +5137,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -4797,8 +5148,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-yMBKppFur/fbHu9/6USUe03bZ4knMYiwFBcyiaXB8Go0qNehwX6inYPzK9U0NeQvGxKthcmHcaR8P5MStSRBAw==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-yMBKppFur/fbHu9/6USUe03bZ4knMYiwFBcyiaXB8Go0qNehwX6inYPzK9U0NeQvGxKthcmHcaR8P5MStSRBAw== } + engines: { node: ">= 0.4" } dependencies: array-buffer-byte-length: 1.0.0 call-bind: 1.0.5 @@ -4810,42 +5162,51 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==} + resolution: + { integrity: sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA== } dev: true /[email protected]: - resolution: {integrity: sha512-TaTivMB6pYI1kXwrFlEhLeGfOqoDNdTxjCdwRfFFkEA30Eu+k48W34nlok2EYWJfFFzqaEmichdNM7th6M5HNw==} + resolution: + { integrity: sha512-TaTivMB6pYI1kXwrFlEhLeGfOqoDNdTxjCdwRfFFkEA30Eu+k48W34nlok2EYWJfFFzqaEmichdNM7th6M5HNw== } dev: true /[email protected]: - resolution: {integrity: sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==} + resolution: + { integrity: sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw== } dev: true /[email protected]: - resolution: {integrity: sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ==} + resolution: + { integrity: sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ== } dev: true /[email protected]: - resolution: {integrity: sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==} + resolution: + { integrity: sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q== } dev: true /[email protected]: - resolution: {integrity: sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-00tXVRwKx/FZr/IDVFt4C+f9FYairX517WoGCL6dpOntqLkZofjhu43F/Xl44UOpqa+9sLFDrG/XAnFsUYgkDA==} + resolution: + { integrity: sha512-00tXVRwKx/FZr/IDVFt4C+f9FYairX517WoGCL6dpOntqLkZofjhu43F/Xl44UOpqa+9sLFDrG/XAnFsUYgkDA== } dependencies: follow-redirects: 1.15.2 form-data: 4.0.0 @@ -4855,7 +5216,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Q28iYCWzNHjAm+yEAot5QaAMxhMghWLFVf7rRdwhUI+c2jix2DUXjAHXVi+s1ibs3mjPO/cCgbA++3BjD0vP/A==} + resolution: + { integrity: sha512-Q28iYCWzNHjAm+yEAot5QaAMxhMghWLFVf7rRdwhUI+c2jix2DUXjAHXVi+s1ibs3mjPO/cCgbA++3BjD0vP/A== } dependencies: follow-redirects: 1.15.2 form-data: 4.0.0 @@ -4865,80 +5227,90 @@ packages: dev: true /[email protected](@babel/[email protected])([email protected]): - resolution: {integrity: sha512-xG3ST4DglodGf8qSwv0MdeWLhrDsw/32QMdTO5T1ZIp9gQur0HkCyFs7Awskr10JKXFXwpAhiCuYX5oGXnRGbw==} - engines: {node: '>= 14.15.0'} + resolution: + { integrity: sha512-xG3ST4DglodGf8qSwv0MdeWLhrDsw/32QMdTO5T1ZIp9gQur0HkCyFs7Awskr10JKXFXwpAhiCuYX5oGXnRGbw== } + engines: { node: ">= 14.15.0" } peerDependencies: - '@babel/core': ^7.12.0 - webpack: '>=5' + "@babel/core": ^7.12.0 + webpack: ">=5" dependencies: - '@babel/core': 7.23.5 + "@babel/core": 7.23.5 find-cache-dir: 4.0.0 schema-utils: 4.2.0 webpack: 5.89.0([email protected]) dev: true /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-jhHiWVZIlnPbEUKSSNb9YoWcQGdlTLq7z1GHL4AjFxaoOUMuuEVJ+Y4pAaQUGOGk93YsVCKPbqbfw3m0SM6H8Q==} + resolution: + { integrity: sha512-jhHiWVZIlnPbEUKSSNb9YoWcQGdlTLq7z1GHL4AjFxaoOUMuuEVJ+Y4pAaQUGOGk93YsVCKPbqbfw3m0SM6H8Q== } peerDependencies: - '@babel/core': ^7.4.0 \|\| ^8.0.0-0 <8.0.0 + "@babel/core": ^7.4.0 \|\| ^8.0.0-0 <8.0.0 dependencies: - '@babel/compat-data': 7.23.3 - '@babel/core': 7.23.5 - '@babel/helper-define-polyfill-provider': 0.4.3(@babel/[email protected]) + "@babel/compat-data": 7.23.3 + "@babel/core": 7.23.5 + "@babel/helper-define-polyfill-provider": 0.4.3(@babel/[email protected]) semver: 6.3.1 transitivePeerDependencies: - supports-color dev: true /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Q6CdATeAvbScWPNLB8lzSO7fgUVBkQt6zLgNlfyeCr/EQaEQR+bWiBYYPYAFyE528BMjRhL+1QBMOI4jc/c5TA==} + resolution: + { integrity: sha512-Q6CdATeAvbScWPNLB8lzSO7fgUVBkQt6zLgNlfyeCr/EQaEQR+bWiBYYPYAFyE528BMjRhL+1QBMOI4jc/c5TA== } peerDependencies: - '@babel/core': ^7.4.0 \|\| ^8.0.0-0 <8.0.0 + "@babel/core": ^7.4.0 \|\| ^8.0.0-0 <8.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-define-polyfill-provider': 0.4.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-define-polyfill-provider": 0.4.3(@babel/[email protected]) core-js-compat: 3.33.1 transitivePeerDependencies: - supports-color dev: true /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-8sHeDOmXC8csczMrYEOf0UTNa4yE2SxV5JGeT/LP1n0OYVDUUFPxG9vdk2AlDlIit4t+Kf0xCtpgXPBwnn/9pw==} + resolution: + { integrity: sha512-8sHeDOmXC8csczMrYEOf0UTNa4yE2SxV5JGeT/LP1n0OYVDUUFPxG9vdk2AlDlIit4t+Kf0xCtpgXPBwnn/9pw== } peerDependencies: - '@babel/core': ^7.4.0 \|\| ^8.0.0-0 <8.0.0 + "@babel/core": ^7.4.0 \|\| ^8.0.0-0 <8.0.0 dependencies: - '@babel/core': 7.23.5 - '@babel/helper-define-polyfill-provider': 0.4.3(@babel/[email protected]) + "@babel/core": 7.23.5 + "@babel/helper-define-polyfill-provider": 0.4.3(@babel/[email protected]) transitivePeerDependencies: - supports-color dev: true /[email protected]: - resolution: {integrity: sha512-GAwkz0AihzY5bkwIY5QDR+LvsRQgB/B+1foMPvi0FZPMl5fjD7ICiznUiBdLYMH1QYe6vqu4gWYytZOccLouFw==} - engines: {node: '>= 10.0.0'} + resolution: + { integrity: sha512-GAwkz0AihzY5bkwIY5QDR+LvsRQgB/B+1foMPvi0FZPMl5fjD7ICiznUiBdLYMH1QYe6vqu4gWYytZOccLouFw== } + engines: { node: ">= 10.0.0" } dependencies: - '@babel/types': 7.23.0 + "@babel/types": 7.23.0 dev: true /[email protected]: - resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + resolution: + { integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== } dev: true /[email protected]: - resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==} + resolution: + { integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA== } dev: true /[email protected]: - resolution: {integrity: sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ==} + resolution: + { integrity: sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ== } dev: true /[email protected]: - resolution: {integrity: sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==} + resolution: + { integrity: sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w== } dependencies: buffer: 5.7.1 inherits: 2.0.4 @@ -4946,8 +5318,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-jWi7abTbYwajOytWCQc37VulmWiRae5RyTpaCyDcS5/lMdtwSz5lOpDE67srw/HYe35f1z3fDQw+3txg7gNtWw==} - engines: {node: '>= 0.8', npm: 1.2.8000 \|\| >= 1.4.16} + resolution: + { integrity: sha512-jWi7abTbYwajOytWCQc37VulmWiRae5RyTpaCyDcS5/lMdtwSz5lOpDE67srw/HYe35f1z3fDQw+3txg7gNtWw== } + engines: { node: ">= 0.8", npm: 1.2.8000 \|\| >= 1.4.16 } dependencies: bytes: 3.1.2 content-type: 1.0.5 @@ -4966,50 +5339,58 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-d0II/GO9uf9lfUHH2BQsjxzRJZBdsjgsBiW4BvhWk/3qoKwQFjIDVN19PfX8F2D/r9PCMTtLWjYVCFrpeYUzsw==} + resolution: + { integrity: sha512-d0II/GO9uf9lfUHH2BQsjxzRJZBdsjgsBiW4BvhWk/3qoKwQFjIDVN19PfX8F2D/r9PCMTtLWjYVCFrpeYUzsw== } requiresBuild: true dev: true optional: true /[email protected](@popperjs/[email protected]): - resolution: {integrity: sha512-D32nmNWiQHo94BKHLmOrdjlL05q1c8oxbtBphQFb9Z5to6eGRDCm0QgeaZ4zFBHzfg2++rqa2JkqCcxDy0sH0g==} + resolution: + { integrity: sha512-D32nmNWiQHo94BKHLmOrdjlL05q1c8oxbtBphQFb9Z5to6eGRDCm0QgeaZ4zFBHzfg2++rqa2JkqCcxDy0sH0g== } peerDependencies: - '@popperjs/core': ^2.11.8 + "@popperjs/core": ^2.11.8 dependencies: - '@popperjs/core': 2.11.8 + "@popperjs/core": 2.11.8 dev: true /[email protected]: - resolution: {integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==} + resolution: + { integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== } dependencies: balanced-match: 1.0.2 concat-map: 0.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} + resolution: + { integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== } dependencies: balanced-match: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== } + engines: { node: ">=8" } dependencies: fill-range: 7.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-8CVjaLJGuSKMVTxJ2DpBl5XnlNDiT4cQFeuCJJrvJmts9YrTZDizTX7PjC2s6W4x+MBGZeEY6dGMrF04/6Hgqg==} + resolution: + { integrity: sha512-8CVjaLJGuSKMVTxJ2DpBl5XnlNDiT4cQFeuCJJrvJmts9YrTZDizTX7PjC2s6W4x+MBGZeEY6dGMrF04/6Hgqg== } dev: true /[email protected]: - resolution: {integrity: sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==} + resolution: + { integrity: sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw== } dev: true /[email protected]: - resolution: {integrity: sha512-0UgcrvQmBDvZHFGdYUehrCNIazki7/lUP3kkoi/r3YB2amZbFM9J43ZRkJTXBUZK4gmx56+Sqk9+Vs9mwZx9+A==} - engines: {node: ^6 \|\| ^7 \|\| ^8 \|\| ^9 \|\| ^10 \|\| ^11 \|\| ^12 \|\| >=13.7} + resolution: + { integrity: sha512-0UgcrvQmBDvZHFGdYUehrCNIazki7/lUP3kkoi/r3YB2amZbFM9J43ZRkJTXBUZK4gmx56+Sqk9+Vs9mwZx9+A== } + engines: { node: ^6 \|\| ^7 \|\| ^8 \|\| ^9 \|\| ^10 \|\| ^11 \|\| ^12 \|\| >=13.7 } hasBin: true dependencies: caniuse-lite: 1.0.30001565 @@ -5019,50 +5400,59 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ==} + resolution: + { integrity: sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ== } dev: true /[email protected]: - resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} + resolution: + { integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== } dev: true /[email protected]: - resolution: {integrity: sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==} + resolution: + { integrity: sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ== } dependencies: base64-js: 1.5.1 ieee754: 1.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ==} + resolution: + { integrity: sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ== } dev: true /[email protected]: - resolution: {integrity: sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==} + resolution: + { integrity: sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ== } dependencies: semver: 7.5.4 dev: true /[email protected]: - resolution: {integrity: sha512-tUkzZWK0M/qdoLEqikxBWe4kumyuwjl3HO6zHTr4yEI23EojPtLYXdG1+AQY7MN0cGyNDvEaJ8wiYQm6P2bPxg==} - engines: {node: '>=12.17'} + resolution: + { integrity: sha512-tUkzZWK0M/qdoLEqikxBWe4kumyuwjl3HO6zHTr4yEI23EojPtLYXdG1+AQY7MN0cGyNDvEaJ8wiYQm6P2bPxg== } + engines: { node: ">=12.17" } dev: true /[email protected]: - resolution: {integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-jAdjGxmPxZh0IipMdR7fK/4sDSrHMLUV0+GvVUsjwyGNKHsh79kW/otg+GkbXwl6Uzvy9wsvHOX4nUoWldeZMg==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-jAdjGxmPxZh0IipMdR7fK/4sDSrHMLUV0+GvVUsjwyGNKHsh79kW/otg+GkbXwl6Uzvy9wsvHOX4nUoWldeZMg== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@npmcli/fs': 3.1.0 + "@npmcli/fs": 3.1.0 fs-minipass: 3.0.2 glob: 10.3.10 lru-cache: 7.18.3 @@ -5077,13 +5467,15 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA==} - engines: {node: '>=10.6.0'} + resolution: + { integrity: sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA== } + engines: { node: ">=10.6.0" } dev: true /[email protected]: - resolution: {integrity: sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew== } + engines: { node: ">=8" } dependencies: clone-response: 1.0.3 get-stream: 5.2.0 @@ -5095,8 +5487,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-kpqOvwXnjjN44D89K5ccQC+RUrsy7jB/XLlRrx0D7/2HNcTPqzsb6XgYoErwko6QsV184CA2YgS1fxDiiDZMWA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-kpqOvwXnjjN44D89K5ccQC+RUrsy7jB/XLlRrx0D7/2HNcTPqzsb6XgYoErwko6QsV184CA2YgS1fxDiiDZMWA== } + engines: { node: ">=8" } dependencies: hasha: 5.2.2 make-dir: 3.1.0 @@ -5105,14 +5498,16 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA==} + resolution: + { integrity: sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA== } dependencies: function-bind: 1.1.2 get-intrinsic: 1.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-C3nQxfFZxFRVoJoGKKI8y3MOEo129NQ+FgQ08iye+Mk4zNZZGdjfs06bVTr+DBSlA66Q2VEcMki/cUCP4SercQ==} + resolution: + { integrity: sha512-C3nQxfFZxFRVoJoGKKI8y3MOEo129NQ+FgQ08iye+Mk4zNZZGdjfs06bVTr+DBSlA66Q2VEcMki/cUCP4SercQ== } dependencies: function-bind: 1.1.2 get-intrinsic: 1.2.2 @@ -5120,20 +5515,23 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==} + resolution: + { integrity: sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw== } dependencies: pascal-case: 3.1.2 tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg== } + engines: { node: ">=8" } dependencies: camelcase: 5.3.1 map-obj: 4.3.0 @@ -5141,25 +5539,29 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-xrE//a3O7TP0vaJ8ikzkD2c2NgcVUvsEe2IvFTntV4Yd1Z9FVzh+gW+enX96L0psrbaFMcVcH2l90xNuGDWc8w==} + resolution: + { integrity: sha512-xrE//a3O7TP0vaJ8ikzkD2c2NgcVUvsEe2IvFTntV4Yd1Z9FVzh+gW+enX96L0psrbaFMcVcH2l90xNuGDWc8w== } dev: true /[email protected]: - resolution: {integrity: sha512-ItanGBMrmRV7Py2Z+Xhs7cT+FNt5K0vPL4p9EZ/UX/Mu7hFbkxSjKF2KVtPwX7UYWp7dRKnrTvReflgrItJbdw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-ItanGBMrmRV7Py2Z+Xhs7cT+FNt5K0vPL4p9EZ/UX/Mu7hFbkxSjKF2KVtPwX7UYWp7dRKnrTvReflgrItJbdw== } + engines: { node: ">=6" } requiresBuild: true dependencies: - '@mapbox/node-pre-gyp': 1.0.10 + "@mapbox/node-pre-gyp": 1.0.10 nan: 2.17.0 simple-get: 3.1.1 transitivePeerDependencies: @@ -5168,8 +5570,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-0UXG04VuVbruMUYbJ6JctvH0YnC/4q3/AkT18q4NaITo91CUm0liMS9VqzT9vZhVQ/1eqPanMWjBM+Juhfb/9g==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-0UXG04VuVbruMUYbJ6JctvH0YnC/4q3/AkT18q4NaITo91CUm0liMS9VqzT9vZhVQ/1eqPanMWjBM+Juhfb/9g== } + engines: { node: ">=4" } dependencies: assertion-error: 1.1.0 check-error: 1.0.3 @@ -5181,8 +5584,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== } + engines: { node: ">=4" } dependencies: ansi-styles: 3.2.1 escape-string-regexp: 1.0.5 @@ -5190,40 +5594,46 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A== } + engines: { node: ">=10" } dependencies: ansi-styles: 4.3.0 supports-color: 7.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== } + engines: { node: ">=10" } dependencies: ansi-styles: 4.3.0 supports-color: 7.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-+UqJQjFEFaTAs3bNsF2j2kEN1baG/zghZbdqoYEDxGZtJo9LBzl1A+m0D4n3qKx8N2FNv8/Xp6yV9mQmBuptaw==} + resolution: + { integrity: sha512-+UqJQjFEFaTAs3bNsF2j2kEN1baG/zghZbdqoYEDxGZtJo9LBzl1A+m0D4n3qKx8N2FNv8/Xp6yV9mQmBuptaw== } dependencies: is-regex: 1.1.4 dev: true /[email protected]: - resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==} + resolution: + { integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA== } dev: true /[email protected]: - resolution: {integrity: sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==} + resolution: + { integrity: sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg== } dependencies: get-func-name: 2.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==} - engines: {node: '>= 8.10.0'} + resolution: + { integrity: sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw== } + engines: { node: ">= 8.10.0" } dependencies: anymatch: 3.1.3 braces: 3.0.2 @@ -5237,56 +5647,66 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg==} - engines: {node: '>=6.0'} + resolution: + { integrity: sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg== } + engines: { node: ">=6.0" } dev: true /[email protected]: - resolution: {integrity: sha512-eXTggHWSooYhq49F2opQhuHWgzucfF2YgODK4e1566GQs5BIfP30B0oenwBJHfWxAs2fyPB1s7Mg949zLf61Yw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-eXTggHWSooYhq49F2opQhuHWgzucfF2YgODK4e1566GQs5BIfP30B0oenwBJHfWxAs2fyPB1s7Mg949zLf61Yw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-JVJbM+f3d3Q704rF4bqQ5UUyTtuJ0JRKNbTKVEeujCCBoMdkEi+V+e8oktO9qGQNSvHrFTM6JZRXrUvGR1czww==} - engines: {node: '>= 10.0'} + resolution: + { integrity: sha512-JVJbM+f3d3Q704rF4bqQ5UUyTtuJ0JRKNbTKVEeujCCBoMdkEi+V+e8oktO9qGQNSvHrFTM6JZRXrUvGR1czww== } + engines: { node: ">= 10.0" } dependencies: source-map: 0.6.1 dev: true /[email protected]: - resolution: {integrity: sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw== } + engines: { node: ">=8" } dependencies: restore-cursor: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-4/aL9X3Wh0yiMQlE+eeRhWP6vclO3QRtw1JHKIT0FFUs5FjpFmESqtMvYZ0+lbzBw900b95mS0hohy+qn2VK/g==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-4/aL9X3Wh0yiMQlE+eeRhWP6vclO3QRtw1JHKIT0FFUs5FjpFmESqtMvYZ0+lbzBw900b95mS0hohy+qn2VK/g== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw== } + engines: { node: ">= 10" } dev: true /[email protected]: - resolution: {integrity: sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==} + resolution: + { integrity: sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ== } dependencies: string-width: 4.2.3 strip-ansi: 6.0.1 @@ -5294,7 +5714,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==} + resolution: + { integrity: sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ== } dependencies: string-width: 4.2.3 strip-ansi: 6.0.1 @@ -5302,8 +5723,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ== } + engines: { node: ">=12" } dependencies: string-width: 4.2.3 strip-ansi: 6.0.1 @@ -5311,8 +5733,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ== } + engines: { node: ">=6" } dependencies: is-plain-object: 2.0.4 kind-of: 6.0.3 @@ -5320,133 +5743,157 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA==} + resolution: + { integrity: sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA== } dependencies: mimic-response: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==} - engines: {node: '>=0.8'} + resolution: + { integrity: sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg== } + engines: { node: ">=0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-S9iI9y0nKR4hwEQsVWpyxld/6kRfGepGfzff83FcaiEBpmvlbA2nnGe7Cylgrx2f/p1P5S5wpRm9oL8z1PbS3Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-S9iI9y0nKR4hwEQsVWpyxld/6kRfGepGfzff83FcaiEBpmvlbA2nnGe7Cylgrx2f/p1P5S5wpRm9oL8z1PbS3Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} + resolution: + { integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== } dependencies: color-name: 1.1.3 dev: true /[email protected]: - resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} - engines: {node: '>=7.0.0'} + resolution: + { integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== } + engines: { node: ">=7.0.0" } dependencies: color-name: 1.1.4 dev: true /[email protected]: - resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==} + resolution: + { integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw== } dev: true /[email protected]: - resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} + resolution: + { integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== } dev: true /[email protected]: - resolution: {integrity: sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==} + resolution: + { integrity: sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg== } dependencies: color-name: 1.1.4 simple-swizzle: 0.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==} + resolution: + { integrity: sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==} + resolution: + { integrity: sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA== } dependencies: color-convert: 1.9.3 color-string: 1.9.1 dev: true /[email protected]: - resolution: {integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==} + resolution: + { integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== } dev: true /[email protected]: - resolution: {integrity: sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w==} + resolution: + { integrity: sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w== } dependencies: color: 3.2.1 text-hex: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-lomjuFZKfM6MSAnV9aCZC9sc0qGbmZdfygNv+nCpqVkSKdCxCklLtd16O0EILGkImHw9ZpHkAnHaB+8Zxq5W6Q==} - engines: {node: '>=8.0.0'} + resolution: + { integrity: sha512-lomjuFZKfM6MSAnV9aCZC9sc0qGbmZdfygNv+nCpqVkSKdCxCklLtd16O0EILGkImHw9ZpHkAnHaB+8Zxq5W6Q== } + engines: { node: ">=8.0.0" } dependencies: strip-ansi: 6.0.1 wcwidth: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== } + engines: { node: ">= 0.8" } dependencies: delayed-stream: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug== } + engines: { node: ">=14" } dev: true /[email protected]: - resolution: {integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ== } + engines: { node: ">=16" } dev: true /[email protected]: - resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} + resolution: + { integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== } dev: true /[email protected]: - resolution: {integrity: sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw== } + engines: { node: ">= 10" } dev: true /[email protected]: - resolution: {integrity: sha512-buhp5kePrmda3vhc5B9t7pUQXAb2Tnd0qgpkIhPhkHXxJpiPJ11H0ZEU0oBpJ2QztSbzG/ZxMj/CHsYJqRHmyg==} - engines: {node: '>= 12.0.0'} + resolution: + { integrity: sha512-buhp5kePrmda3vhc5B9t7pUQXAb2Tnd0qgpkIhPhkHXxJpiPJ11H0ZEU0oBpJ2QztSbzG/ZxMj/CHsYJqRHmyg== } + engines: { node: ">= 12.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==} + resolution: + { integrity: sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w== } dev: true /[email protected]: - resolution: {integrity: sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==} + resolution: + { integrity: sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg== } dev: true /[email protected]: - resolution: {integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==} + resolution: + { integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA== } dependencies: array-ify: 1.0.0 dot-prop: 5.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} + resolution: + { integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg== } dev: true /[email protected]: - resolution: {integrity: sha512-MWufYdFw53ccGjCA+Ol7XJYpAlW6/prSMzuPOTRnJGcGzuhLn4Scrz7qf6o8bROZ514ltazcIFJZevcfbo0x7A==} - engines: {'0': node >= 6.0} + resolution: + { integrity: sha512-MWufYdFw53ccGjCA+Ol7XJYpAlW6/prSMzuPOTRnJGcGzuhLn4Scrz7qf6o8bROZ514ltazcIFJZevcfbo0x7A== } + engines: { "0": node >= 6.0 } dependencies: buffer-from: 1.1.2 inherits: 2.0.4 @@ -5455,8 +5902,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-1dP4gpXFhei8IOtlXRE/T/4H88ElHgTiUzh71YUmtjTEHMSRS2Z/fgOxHSxxusGHogsRfxNq1vyAwxSC+EVyDg==} - engines: {node: ^14.13.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-1dP4gpXFhei8IOtlXRE/T/4H88ElHgTiUzh71YUmtjTEHMSRS2Z/fgOxHSxxusGHogsRfxNq1vyAwxSC+EVyDg== } + engines: { node: ^14.13.0 \|\| >=16.0.0 } hasBin: true dependencies: chalk: 4.1.2 @@ -5471,49 +5919,57 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-3R0kMOdL7CjJpU66fzAkCe6HNtd3AavCS4m+uW4KtJjrdGPT0SQEZieAYd+cm+lJoBznNQ4lqipYWkhBMgk00g==} + resolution: + { integrity: sha512-3R0kMOdL7CjJpU66fzAkCe6HNtd3AavCS4m+uW4KtJjrdGPT0SQEZieAYd+cm+lJoBznNQ4lqipYWkhBMgk00g== } dev: true /[email protected]: - resolution: {integrity: sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==} + resolution: + { integrity: sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ== } dev: true /[email protected]: - resolution: {integrity: sha512-vCrqcSIq4//Gx74TXXCGnHpulY1dskqLTFGDmhrGxzeXL8lF8kvXv6mpNWlJj1uD4DW23D4ljAqbY4RRaaUZIw==} + resolution: + { integrity: sha512-vCrqcSIq4//Gx74TXXCGnHpulY1dskqLTFGDmhrGxzeXL8lF8kvXv6mpNWlJj1uD4DW23D4ljAqbY4RRaaUZIw== } dependencies: - '@babel/parser': 7.23.0 - '@babel/types': 7.23.0 + "@babel/parser": 7.23.0 + "@babel/types": 7.23.0 dev: true /[email protected]: - resolution: {integrity: sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ== } + engines: { node: ">= 0.6" } dependencies: safe-buffer: 5.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-ROjNchA9LgfNMTTFSIWPzebCwOGFdgkEq45EnvvrmSLvCtAw0HSmrCs7/ty+wAeYUZyNay0YMUNYFTRL72PkBQ==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-ROjNchA9LgfNMTTFSIWPzebCwOGFdgkEq45EnvvrmSLvCtAw0HSmrCs7/ty+wAeYUZyNay0YMUNYFTRL72PkBQ== } + engines: { node: ">=16" } dependencies: compare-func: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-NKXYmMR/Hr1DevQegFB4MwfM5Vv0m4UIxKZTTYuD98lpTknaZlSRrDOG4X7wIXpGkfsYxZTghUN+Qq+T0YQI7w==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-NKXYmMR/Hr1DevQegFB4MwfM5Vv0m4UIxKZTTYuD98lpTknaZlSRrDOG4X7wIXpGkfsYxZTghUN+Qq+T0YQI7w== } + engines: { node: ">=16" } dependencies: compare-func: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-Rvi5pH+LvgsqGwZPZ3Cq/tz4ty7mjijhr3qR4m9IBXNbxGGYgTVVO+duXzz9aArmHxFtwZ+LRkrNIMDQzgoY4A==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-Rvi5pH+LvgsqGwZPZ3Cq/tz4ty7mjijhr3qR4m9IBXNbxGGYgTVVO+duXzz9aArmHxFtwZ+LRkrNIMDQzgoY4A== } + engines: { node: ">=14" } dependencies: add-stream: 1.0.0 conventional-changelog-writer: 6.0.0 @@ -5529,13 +5985,15 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-qy9XbdSLmVnwnvzEisjxdDiLA4OmV3o8db+Zdg4WiFw14fP3B6XNz98X0swPPpkTd/pc1K7+adKgEDM1JCUMiA==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-qy9XbdSLmVnwnvzEisjxdDiLA4OmV3o8db+Zdg4WiFw14fP3B6XNz98X0swPPpkTd/pc1K7+adKgEDM1JCUMiA== } + engines: { node: ">=14" } dev: true /[email protected]: - resolution: {integrity: sha512-8PyWTnn7zBIt9l4hj4UusFs1TyG+9Ulu1zlOAc72L7Sdv9Hsc8E86ot7htY3HXCVhXHB/NO0pVGvZpwsyJvFfw==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-8PyWTnn7zBIt9l4hj4UusFs1TyG+9Ulu1zlOAc72L7Sdv9Hsc8E86ot7htY3HXCVhXHB/NO0pVGvZpwsyJvFfw== } + engines: { node: ">=14" } hasBin: true dependencies: conventional-commits-filter: 3.0.0 @@ -5548,16 +6006,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-1ymej8b5LouPx9Ox0Dw/qAO2dVdfpRFq28e5Y0jJEU8ZrLdy0vOSkkIInwmxErFGhg6SALro60ZrwYFVTUDo4Q==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-1ymej8b5LouPx9Ox0Dw/qAO2dVdfpRFq28e5Y0jJEU8ZrLdy0vOSkkIInwmxErFGhg6SALro60ZrwYFVTUDo4Q== } + engines: { node: ">=14" } dependencies: lodash.ismatch: 4.4.0 modify-values: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-WRv5j1FsVM5FISJkoYMR6tPk07fkKT0UodruX4je86V4owk451yjXAKzKAPOs9l7y59E2viHUS9eQ+dfUA9NSg==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-WRv5j1FsVM5FISJkoYMR6tPk07fkKT0UodruX4je86V4owk451yjXAKzKAPOs9l7y59E2viHUS9eQ+dfUA9NSg== } + engines: { node: ">=14" } hasBin: true dependencies: JSONStream: 1.3.5 @@ -5567,8 +6027,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ZPMl0ZJbw74iS9LuX9YIAiW8pfM5p3yh2o/NbXHbkFuZzY5jvdi5jFycEOkmBW5H5I7nA+D6f3UcsCLP2vvSEA==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-ZPMl0ZJbw74iS9LuX9YIAiW8pfM5p3yh2o/NbXHbkFuZzY5jvdi5jFycEOkmBW5H5I7nA+D6f3UcsCLP2vvSEA== } + engines: { node: ">=16" } hasBin: true dependencies: JSONStream: 1.3.5 @@ -5578,8 +6039,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ft79FF4SlOFvX4PkwFDRnaNiIVX7YbmqGU0RwccUaiGvgp3S0a8ipR2/Qxk31vclDNM+GSdJOVs2KrsUCjblVA==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-Ft79FF4SlOFvX4PkwFDRnaNiIVX7YbmqGU0RwccUaiGvgp3S0a8ipR2/Qxk31vclDNM+GSdJOVs2KrsUCjblVA== } + engines: { node: ">=14" } hasBin: true dependencies: concat-stream: 2.0.0 @@ -5592,24 +6054,29 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==} + resolution: + { integrity: sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A== } dev: true /[email protected]: - resolution: {integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==} + resolution: + { integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== } dev: true /[email protected]: - resolution: {integrity: sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==} + resolution: + { integrity: sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== } dev: true /[email protected]: - resolution: {integrity: sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-fereAvAvxDrQDOXybk3Qu3dPbOoKoysFMWtkY3mv5BsL8//OSZVL5DCLYqgRfY5cWirgRzlC+WSrxp6Bo3eNZg==} + resolution: + { integrity: sha512-fereAvAvxDrQDOXybk3Qu3dPbOoKoysFMWtkY3mv5BsL8//OSZVL5DCLYqgRfY5cWirgRzlC+WSrxp6Bo3eNZg== } hasBin: true dependencies: glob: 7.2.3 @@ -5622,34 +6089,38 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-6pYKNOgD/j/bkC5xS5IIg6bncid3rfrI42oBH1SQJbsmYPKF7rhzcFzYCcxYMmNQQ0rCEB8WqpW7QHndOggaeQ==} + resolution: + { integrity: sha512-6pYKNOgD/j/bkC5xS5IIg6bncid3rfrI42oBH1SQJbsmYPKF7rhzcFzYCcxYMmNQQ0rCEB8WqpW7QHndOggaeQ== } dependencies: browserslist: 4.22.2 dev: true /[email protected]: - resolution: {integrity: sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==} + resolution: + { integrity: sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== } dev: true /[email protected](@types/[email protected])([email protected])([email protected]): - resolution: {integrity: sha512-+8cK7jRAReYkMwMiG+bxhcNKiHJDM6bR9FD/nGBXOWdMLuYawjF5cGrtLilJ+LGd3ZjCXnJjR5DkfWPoIVlqJA==} - engines: {node: '>=v16'} + resolution: + { integrity: sha512-+8cK7jRAReYkMwMiG+bxhcNKiHJDM6bR9FD/nGBXOWdMLuYawjF5cGrtLilJ+LGd3ZjCXnJjR5DkfWPoIVlqJA== } + engines: { node: ">=v16" } peerDependencies: - '@types/node': '' - cosmiconfig: '>=8.2' - typescript: '>=4' + "@types/node": "" + cosmiconfig: ">=8.2" + typescript: ">=4" dependencies: - '@types/node': 18.17.0 + "@types/node": 18.17.0 cosmiconfig: 8.3.6([email protected]) jiti: 1.21.0 typescript: 5.3.2 dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA== } + engines: { node: ">=14" } peerDependencies: - typescript: '>=4.9.5' + typescript: ">=4.9.5" peerDependenciesMeta: typescript: optional: true @@ -5662,20 +6133,23 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==} + resolution: + { integrity: sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ== } dev: true /[email protected]: - resolution: {integrity: sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==} - engines: {node: '>=10.14', npm: '>=6', yarn: '>=1'} + resolution: + { integrity: sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw== } + engines: { node: ">=10.14", npm: ">=6", yarn: ">=1" } hasBin: true dependencies: cross-spawn: 7.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== } + engines: { node: ">= 8" } dependencies: path-key: 3.1.1 shebang-command: 2.0.0 @@ -5683,49 +6157,57 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-TgQBEdP07adhrDfXvI5o6bHGukKBNMzp2Ngckc/6d09zpjD2gc1Hl3Ca1CKgb8FXjHi88+Phv2Uegs2kTL4zjg==} + resolution: + { integrity: sha512-TgQBEdP07adhrDfXvI5o6bHGukKBNMzp2Ngckc/6d09zpjD2gc1Hl3Ca1CKgb8FXjHi88+Phv2Uegs2kTL4zjg== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-N4u2ABATi3Qplzf0hWbVCdjenim8F3ojEXpBDF5hBpjzW182MjNGLqfmQ0SkSPeQ+V86ZXgeH8aXj6kayd4jgg==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-N4u2ABATi3Qplzf0hWbVCdjenim8F3ojEXpBDF5hBpjzW182MjNGLqfmQ0SkSPeQ+V86ZXgeH8aXj6kayd4jgg== } + engines: { node: ">=14" } dependencies: rrweb-cssom: 0.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-2iy1EkLdlBzQGvbweYRFxmFath8+K7+AKB0TlhHWkNuH+TmovaMH/Wp7V7R4u7f4SnX3OgLsU9t1NI9ioDnUpg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-2iy1EkLdlBzQGvbweYRFxmFath8+K7+AKB0TlhHWkNuH+TmovaMH/Wp7V7R4u7f4SnX3OgLsU9t1NI9ioDnUpg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-ZYP5VBHshaDAiVZxjbRVcFJpc+4xGgT0bK3vzy1HLN8jTO975HEbuYzZJcHoQEY5K1a0z8YayJkyVETa08eNTg==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-ZYP5VBHshaDAiVZxjbRVcFJpc+4xGgT0bK3vzy1HLN8jTO975HEbuYzZJcHoQEY5K1a0z8YayJkyVETa08eNTg== } + engines: { node: ">=18" } dependencies: whatwg-mimetype: 4.0.0 whatwg-url: 14.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw==} - engines: {node: '>=0.11'} + resolution: + { integrity: sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw== } + engines: { node: ">=0.11" } dependencies: - '@babel/runtime': 7.21.5 + "@babel/runtime": 7.21.5 dev: true /[email protected]: - resolution: {integrity: sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q==} + resolution: + { integrity: sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q== } dev: true /[email protected]: - resolution: {integrity: sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==} + resolution: + { integrity: sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug== } dev: true /[email protected]: - resolution: {integrity: sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==} + resolution: + { integrity: sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== } peerDependencies: - supports-color: '' + supports-color: "" peerDependenciesMeta: supports-color: optional: true @@ -5734,9 +6216,10 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==} + resolution: + { integrity: sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ== } peerDependencies: - supports-color: '' + supports-color: "" peerDependenciesMeta: supports-color: optional: true @@ -5746,10 +6229,11 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==} - engines: {node: '>=6.0'} + resolution: + { integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== } + engines: { node: ">=6.0" } peerDependencies: - supports-color: '' + supports-color: "" peerDependenciesMeta: supports-color: optional: true @@ -5759,77 +6243,90 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg== } + engines: { node: ">=0.10.0" } dependencies: decamelize: 1.2.0 map-obj: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-9iE1PgSik9HeIIw2JO94IidnE3eBoQrFJ3w7sFuzSX4DpmZ3v5sZpUiV5Swcf6mQEF+Y0ru8Neo+p+nyh2J+hQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-9iE1PgSik9HeIIw2JO94IidnE3eBoQrFJ3w7sFuzSX4DpmZ3v5sZpUiV5Swcf6mQEF+Y0ru8Neo+p+nyh2J+hQ== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA==} + resolution: + { integrity: sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA== } dev: true /[email protected]: - resolution: {integrity: sha512-jOSne2qbyE+/r8G1VU+G/82LBs2Fs4LAsTiLSHOCOMZQl2OKZ6i8i4IyHemTe+/yIXOtTcRQMzPcgyhoFlqPkw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-jOSne2qbyE+/r8G1VU+G/82LBs2Fs4LAsTiLSHOCOMZQl2OKZ6i8i4IyHemTe+/yIXOtTcRQMzPcgyhoFlqPkw== } + engines: { node: ">=8" } dependencies: mimic-response: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ== } + engines: { node: ">=10" } dependencies: mimic-response: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==} + resolution: + { integrity: sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA== } dev: true /[email protected]: - resolution: {integrity: sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw== } + engines: { node: ">=6" } dependencies: type-detect: 4.0.8 dev: true /[email protected]: - resolution: {integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==} + resolution: + { integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ== } dev: true /[email protected]: - resolution: {integrity: sha512-eXTJmRbm2TIt9MgWTsOH1wEuhew6XGZcMeGKCtLedIg/NCsg1iBePXkceTdK4Fii7pzmN9tGsZhKzZ4h7O/fxw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-eXTJmRbm2TIt9MgWTsOH1wEuhew6XGZcMeGKCtLedIg/NCsg1iBePXkceTdK4Fii7pzmN9tGsZhKzZ4h7O/fxw== } + engines: { node: ">=8" } dependencies: strip-bom: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==} + resolution: + { integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A== } dependencies: clone: 1.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ== } + engines: { node: ">= 0.4" } dependencies: get-intrinsic: 1.2.2 gopd: 1.0.1 @@ -5837,186 +6334,220 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-xvqAVKGfT1+UAvPwKTVw/njhdQ8ZhXK4lI0bCIuCMrp2up9nPnaDftrLtmpTazqd1o+UY4zgzU+avtMbDP+ldA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-xvqAVKGfT1+UAvPwKTVw/njhdQ8ZhXK4lI0bCIuCMrp2up9nPnaDftrLtmpTazqd1o+UY4zgzU+avtMbDP+ldA== } + engines: { node: ">= 0.4" } dependencies: has-property-descriptors: 1.0.0 object-keys: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==} - engines: {node: '>=0.4.0'} + resolution: + { integrity: sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ== } + engines: { node: ">=0.4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==} + resolution: + { integrity: sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ== } dev: true /[email protected]: - resolution: {integrity: sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==} + resolution: + { integrity: sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ== } dev: true /[email protected]: - resolution: {integrity: sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==} - engines: {node: '>= 0.8', npm: 1.2.8000 \|\| >= 1.4.16} + resolution: + { integrity: sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg== } + engines: { node: ">= 0.8", npm: 1.2.8000 \|\| >= 1.4.16 } dev: true /[email protected]: - resolution: {integrity: sha512-rlpvsxUtM0PQvy9iZe640/IWwWYyBsTApREbA1pHOpmOUIl9MkP/U4z7vTtg4Oaojvqhxt7sdufnT0EzGaR31g==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-rlpvsxUtM0PQvy9iZe640/IWwWYyBsTApREbA1pHOpmOUIl9MkP/U4z7vTtg4Oaojvqhxt7sdufnT0EzGaR31g== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-463v3ZeIrcWtdgIg6vI6XUncguvr2TnGl4SzDXinkt9mSLpBJKXT3mW6xT3VQdDN11+WVs29pgvivTc4Lp8v+w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-463v3ZeIrcWtdgIg6vI6XUncguvr2TnGl4SzDXinkt9mSLpBJKXT3mW6xT3VQdDN11+WVs29pgvivTc4Lp8v+w== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==} + resolution: + { integrity: sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g== } requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-ofrBgwpPhCD85kMKtE9RYFFq6OC1A89oW2vvgWZNCwxrUpRUILopY7lsYyMDSjc8g6U6aiO0Qubg6r4Wgt5ZnA==} - engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-ofrBgwpPhCD85kMKtE9RYFFq6OC1A89oW2vvgWZNCwxrUpRUILopY7lsYyMDSjc8g6U6aiO0Qubg6r4Wgt5ZnA== } + engines: { node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==} - engines: {node: '>=0.3.1'} + resolution: + { integrity: sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A== } + engines: { node: ">=0.3.1" } dev: true /[email protected]: - resolution: {integrity: sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==} - engines: {node: '>=0.3.1'} + resolution: + { integrity: sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w== } + engines: { node: ">=0.3.1" } dev: true /[email protected]: - resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== } + engines: { node: ">=8" } dependencies: path-type: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw== } + engines: { node: ">=0.10.0" } dependencies: esutils: 2.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==} - engines: {node: '>=6.0.0'} + resolution: + { integrity: sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w== } + engines: { node: ">=6.0.0" } dependencies: esutils: 2.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-LLBi6pEqS6Do3EKQ3J0NqHWV5hhb78Pi8vvESYwyOy2c31ZEZVdtitdzsQsKb7878PEERhzUk0ftqGhG6Mz+pQ==} + resolution: + { integrity: sha512-LLBi6pEqS6Do3EKQ3J0NqHWV5hhb78Pi8vvESYwyOy2c31ZEZVdtitdzsQsKb7878PEERhzUk0ftqGhG6Mz+pQ== } dev: true /[email protected]: - resolution: {integrity: sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==} + resolution: + { integrity: sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w== } dependencies: no-case: 3.0.4 tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q== } + engines: { node: ">=8" } dependencies: is-obj: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-GopVGCpVS1UKH75VKHGuQFqS1Gusej0z4FyQkPdwjil2gNIv+LNsqBlboOzpJFZKVT95GkCyWJbBSdFEFUWI2A==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-GopVGCpVS1UKH75VKHGuQFqS1Gusej0z4FyQkPdwjil2gNIv+LNsqBlboOzpJFZKVT95GkCyWJbBSdFEFUWI2A== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==} + resolution: + { integrity: sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg== } dev: true /[email protected]: - resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==} + resolution: + { integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== } dev: true /[email protected]: - resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==} + resolution: + { integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== } dev: true /[email protected]: - resolution: {integrity: sha512-rC+QVNMJWv+MtPgkt0y+0rVEIdbtxVADApW9JXrUVlzHetgcyczP/E7DJmWJ4fJCZF2cPcBk0laWO9ZHMG3DmQ==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-rC+QVNMJWv+MtPgkt0y+0rVEIdbtxVADApW9JXrUVlzHetgcyczP/E7DJmWJ4fJCZF2cPcBk0laWO9ZHMG3DmQ== } + engines: { node: ">=0.10.0" } hasBin: true dependencies: jake: 10.8.7 dev: true /[email protected]: - resolution: {integrity: sha512-SpwUMDWe9tQu8JX5QCO1+p/hChAi9AE9UpoC3rcHVc+gdCGlbT3SGb5I1klgb952HRIyvt9wZhSz9bNBYz9swA==} + resolution: + { integrity: sha512-SpwUMDWe9tQu8JX5QCO1+p/hChAi9AE9UpoC3rcHVc+gdCGlbT3SGb5I1klgb952HRIyvt9wZhSz9bNBYz9swA== } dev: true /[email protected]: - resolution: {integrity: sha512-eDhnCFBvG0PGFVEpNIEdBvyuGUBsFdlokd+CtuCe2ER3P+17qxaRfWRxMmksCOKgDHb5Wif5UxqOkZSlA4snlw==} - engines: {node: '>= 12.20.55'} + resolution: + { integrity: sha512-eDhnCFBvG0PGFVEpNIEdBvyuGUBsFdlokd+CtuCe2ER3P+17qxaRfWRxMmksCOKgDHb5Wif5UxqOkZSlA4snlw== } + engines: { node: ">= 12.20.55" } hasBin: true requiresBuild: true dependencies: - '@electron/get': 2.0.2 - '@types/node': 18.17.0 + "@electron/get": 2.0.2 + "@types/node": 18.17.0 extract-zip: 2.0.1 transitivePeerDependencies: - supports-color dev: true /[email protected]: - resolution: {integrity: sha512-4OIPYlA6JXqtVn8zpHpGiI7vE6EQOAg16aGnDMIAlZVinnoZ8208tW1hAbjWydgN/4PLTT9q+O1K6AH/vALJGw==} + resolution: + { integrity: sha512-4OIPYlA6JXqtVn8zpHpGiI7vE6EQOAg16aGnDMIAlZVinnoZ8208tW1hAbjWydgN/4PLTT9q+O1K6AH/vALJGw== } dev: true /[email protected]: - resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} + resolution: + { integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== } dev: true /[email protected]: - resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==} + resolution: + { integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg== } dev: true /[email protected]: - resolution: {integrity: sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==} + resolution: + { integrity: sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ== } dev: true /[email protected]: - resolution: {integrity: sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==} + resolution: + { integrity: sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A== } requiresBuild: true dependencies: iconv-lite: 0.6.3 @@ -6024,61 +6555,71 @@ packages: optional: true /[email protected]: - resolution: {integrity: sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==} + resolution: + { integrity: sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q== } dependencies: once: 1.4.0 dev: true /[email protected]: - resolution: {integrity: sha512-LXYT42KJ7lpIKECr2mAXIaMldcNCh/7E0KBKOu4KSfkHmP+mZmSs+8V5gBAqisWBy0OO4W5Oyys0GO1Y8KtdKg==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-LXYT42KJ7lpIKECr2mAXIaMldcNCh/7E0KBKOu4KSfkHmP+mZmSs+8V5gBAqisWBy0OO4W5Oyys0GO1Y8KtdKg== } + engines: { node: ">=10.13.0" } dependencies: graceful-fs: 4.2.11 tapable: 2.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==} - engines: {node: '>=8.6'} + resolution: + { integrity: sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg== } + engines: { node: ">=8.6" } dependencies: ansi-colors: 4.1.3 dev: true /[email protected]: - resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} - engines: {node: '>=0.12'} + resolution: + { integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== } + engines: { node: ">=0.12" } dev: true /[email protected]: - resolution: {integrity: sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-ZtUjZO6l5mwTHvc1L9+1q5p/R3wTopcfqMW8r5t8SJSKqeVI/LtajORwRFEKpEFuekjD0VBjwu1HMxL4UalIRw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-ZtUjZO6l5mwTHvc1L9+1q5p/R3wTopcfqMW8r5t8SJSKqeVI/LtajORwRFEKpEFuekjD0VBjwu1HMxL4UalIRw== } + engines: { node: ">=4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-/o+BXHmB7ocbHEAs6F2EnG0ogybVVUdkRunTT2glZU9XAaGmhqskrvKwqXuDfNjEO0LZKWdejEEpnq8aM0tOaw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-/o+BXHmB7ocbHEAs6F2EnG0ogybVVUdkRunTT2glZU9XAaGmhqskrvKwqXuDfNjEO0LZKWdejEEpnq8aM0tOaw== } + engines: { node: ">=4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==} + resolution: + { integrity: sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA== } dev: true /[email protected]: - resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} + resolution: + { integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== } dependencies: is-arrayish: 0.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-eiiY8HQeYfYH2Con2berK+To6GrK2RxbPawDkGq4UiCQQfZHb6wX9qQqkbpPqaxQFcl8d9QzZqo0tGE0VcrdwA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-eiiY8HQeYfYH2Con2berK+To6GrK2RxbPawDkGq4UiCQQfZHb6wX9qQqkbpPqaxQFcl8d9QzZqo0tGE0VcrdwA== } + engines: { node: ">= 0.4" } dependencies: array-buffer-byte-length: 1.0.0 arraybuffer.prototype.slice: 1.0.2 @@ -6122,12 +6663,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA==} + resolution: + { integrity: sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA== } dev: true /[email protected]: - resolution: {integrity: sha512-g3OMbtlwY3QewlqAiMLI47KywjWZoEytKr8pf6iTC8uJq5bIAH52Z9pnQ8pVL6whrCto53JZDuUIsifGeLorTg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-g3OMbtlwY3QewlqAiMLI47KywjWZoEytKr8pf6iTC8uJq5bIAH52Z9pnQ8pVL6whrCto53JZDuUIsifGeLorTg== } + engines: { node: ">= 0.4" } dependencies: get-intrinsic: 1.2.2 has: 1.0.3 @@ -6135,14 +6678,16 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Jm6GPcCdC30eMLbZ2x8z2WuRwAws3zTBBKuusffYVUrNj/GVSUAZ+xKMaUpfNDR5IbyNA5LJbaecoUVbmUcB1w==} + resolution: + { integrity: sha512-Jm6GPcCdC30eMLbZ2x8z2WuRwAws3zTBBKuusffYVUrNj/GVSUAZ+xKMaUpfNDR5IbyNA5LJbaecoUVbmUcB1w== } dependencies: has: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA== } + engines: { node: ">= 0.4" } dependencies: is-callable: 1.2.7 is-date-object: 1.0.5 @@ -6150,39 +6695,46 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg==} + resolution: + { integrity: sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg== } dev: true /[email protected]: - resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==} + resolution: + { integrity: sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== } dev: true /[email protected]: - resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} - engines: {node: '>=0.8.0'} + resolution: + { integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg== } + engines: { node: ">=0.8.0" } dev: true /[email protected]: - resolution: {integrity: sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== } + engines: { node: ">=10" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw==} + resolution: + { integrity: sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw== } hasBin: true peerDependencies: - eslint: '>=7.0.0' + eslint: ">=7.0.0" dependencies: eslint: 8.55.0 dev: true /[email protected]: - resolution: {integrity: sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==} + resolution: + { integrity: sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g== } dependencies: debug: 3.2.7([email protected]) is-core-module: 2.13.1 @@ -6192,16 +6744,17 @@ packages: dev: true /[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): - resolution: {integrity: sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==} - engines: {node: '>=4'} - peerDependencies: - '@typescript-eslint/parser': '' - eslint: '' - eslint-import-resolver-node: '' - eslint-import-resolver-typescript: '' - eslint-import-resolver-webpack: '' + resolution: + { integrity: sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw== } + engines: { node: ">=4" } + peerDependencies: + "@typescript-eslint/parser": "" + eslint: "" + eslint-import-resolver-node: "" + eslint-import-resolver-typescript: "" + eslint-import-resolver-webpack: "" peerDependenciesMeta: - '@typescript-eslint/parser': + "@typescript-eslint/parser": optional: true eslint: optional: true @@ -6212,7 +6765,7 @@ packages: eslint-import-resolver-webpack: optional: true dependencies: - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) debug: 3.2.7([email protected]) eslint: 8.55.0 eslint-import-resolver-node: 0.3.9 @@ -6221,16 +6774,17 @@ packages: dev: true /[email protected](@typescript-eslint/[email protected])([email protected]): - resolution: {integrity: sha512-QPOO5NO6Odv5lpoTkddtutccQjysJuFxoPS7fAHO+9m9udNHvTCPSAMW9zGAYj8lAIdr40I8yPCdUYrncXtrwg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-QPOO5NO6Odv5lpoTkddtutccQjysJuFxoPS7fAHO+9m9udNHvTCPSAMW9zGAYj8lAIdr40I8yPCdUYrncXtrwg== } + engines: { node: ">=4" } peerDependencies: - '@typescript-eslint/parser': '' + "@typescript-eslint/parser": "" eslint: ^2 \|\| ^3 \|\| ^4 \|\| ^5 \|\| ^6 \|\| ^7.2.0 \|\| ^8 peerDependenciesMeta: - '@typescript-eslint/parser': + "@typescript-eslint/parser": optional: true dependencies: - '@typescript-eslint/parser': 6.13.1([email protected])([email protected]) + "@typescript-eslint/parser": 6.13.1([email protected])([email protected]) array-includes: 3.1.7 array.prototype.findlastindex: 1.2.3 array.prototype.flat: 1.3.2 @@ -6256,12 +6810,13 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-UQuEtbqLNkPf5Nr/6PPRCtr9xypXY+g8y/Q7gPa0YK7eDhh0y2lWprXRnaYbW7ACgIUvpDKy9X2bZqxtGzBG9Q==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-UQuEtbqLNkPf5Nr/6PPRCtr9xypXY+g8y/Q7gPa0YK7eDhh0y2lWprXRnaYbW7ACgIUvpDKy9X2bZqxtGzBG9Q== } + engines: { node: ">=16" } peerDependencies: eslint: ^7.0.0 \|\| ^8.0.0 dependencies: - '@es-joy/jsdoccomment': 0.41.0 + "@es-joy/jsdoccomment": 0.41.0 are-docs-informative: 0.0.2 comment-parser: 1.4.1 debug: 4.3.4([email protected]) @@ -6276,46 +6831,51 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-xRmVi7Zx44lOBuYqG8vzTXuL6IdGOeF9nHX17bjJ8+VE6fsxpdGem0/SBTmAwgYMKYB1WBkqRJVQ+n8GK041pA==} + resolution: + { integrity: sha512-xRmVi7Zx44lOBuYqG8vzTXuL6IdGOeF9nHX17bjJ8+VE6fsxpdGem0/SBTmAwgYMKYB1WBkqRJVQ+n8GK041pA== } dependencies: - '@microsoft/tsdoc': 0.14.2 - '@microsoft/tsdoc-config': 0.16.2 + "@microsoft/tsdoc": 0.14.2 + "@microsoft/tsdoc-config": 0.16.2 dev: true /[email protected]: - resolution: {integrity: sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==} - engines: {node: '>=8.0.0'} + resolution: + { integrity: sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== } + engines: { node: ">=8.0.0" } dependencies: esrecurse: 4.3.0 estraverse: 4.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } dependencies: esrecurse: 4.3.0 estraverse: 5.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-iyUUAM0PCKj5QpwGfmCAG9XXbZCWsqP/eWAWrG/W0umvjuLRBECwSFdt+rCntju0xEH7teIABPwXpahftIaTdA==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-iyUUAM0PCKj5QpwGfmCAG9XXbZCWsqP/eWAWrG/W0umvjuLRBECwSFdt+rCntju0xEH7teIABPwXpahftIaTdA== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } hasBin: true dependencies: - '@eslint-community/eslint-utils': 4.4.0([email protected]) - '@eslint-community/regexpp': 4.6.2 - '@eslint/eslintrc': 2.1.4 - '@eslint/js': 8.55.0 - '@humanwhocodes/config-array': 0.11.13 - '@humanwhocodes/module-importer': 1.0.1 - '@nodelib/fs.walk': 1.2.8 - '@ungap/structured-clone': 1.2.0 + "@eslint-community/eslint-utils": 4.4.0([email protected]) + "@eslint-community/regexpp": 4.6.2 + "@eslint/eslintrc": 2.1.4 + "@eslint/js": 8.55.0 + "@humanwhocodes/config-array": 0.11.13 + "@humanwhocodes/module-importer": 1.0.1 + "@nodelib/fs.walk": 1.2.8 + "@ungap/structured-clone": 1.2.0 ajv: 6.12.6 chalk: 4.1.2 cross-spawn: 7.0.3 @@ -6351,8 +6911,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ== } + engines: { node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0 } dependencies: acorn: 8.10.0 acorn-jsx: 5.3.2([email protected]) @@ -6360,62 +6921,73 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== } + engines: { node: ">=4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==} - engines: {node: '>=0.10'} + resolution: + { integrity: sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg== } + engines: { node: ">=0.10" } dependencies: estraverse: 5.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==} - engines: {node: '>=4.0'} + resolution: + { integrity: sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== } + engines: { node: ">=4.0" } dependencies: estraverse: 5.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==} - engines: {node: '>=4.0'} + resolution: + { integrity: sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== } + engines: { node: ">=4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} - engines: {node: '>=4.0'} + resolution: + { integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== } + engines: { node: ">=4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==} + resolution: + { integrity: sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw== } dev: true /[email protected]: - resolution: {integrity: sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==} - engines: {node: '>=0.8.x'} + resolution: + { integrity: sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== } + engines: { node: ">=0.8.x" } dev: true /[email protected]: - resolution: {integrity: sha512-ov6w/2LCiuyO4RLYGdpFGjkcs0wMTgGE8PrkTHikeUy5iJekXyPIKUjifk5CsE0pt7sMCrMZ3YNqoCj6idQOnQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-ov6w/2LCiuyO4RLYGdpFGjkcs0wMTgGE8PrkTHikeUy5iJekXyPIKUjifk5CsE0pt7sMCrMZ3YNqoCj6idQOnQ== } + engines: { node: ">=10" } dependencies: cross-spawn: 7.0.3 get-stream: 6.0.1 @@ -6429,8 +7001,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== } + engines: { node: ">=10" } dependencies: cross-spawn: 7.0.3 get-stream: 6.0.1 @@ -6444,16 +7017,19 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-yWnriYB4e8G54M5/fAFj7rCIBiKs1HAACaY13kCz6Ku0dezjS9aMcfcdVK2X8Tv2tEV1BPz/wKfQ7WA4S/d8aA==} + resolution: + { integrity: sha512-yWnriYB4e8G54M5/fAFj7rCIBiKs1HAACaY13kCz6Ku0dezjS9aMcfcdVK2X8Tv2tEV1BPz/wKfQ7WA4S/d8aA== } dev: true /[email protected]: - resolution: {integrity: sha512-dX7e/LHVJ6W3DE1MHWi9S1EYzDESENfLrYohG2G++ovZrYOkm4Knwa0mc1cn84xJOR4KEU0WSchhLbd0UklbHw==} + resolution: + { integrity: sha512-dX7e/LHVJ6W3DE1MHWi9S1EYzDESENfLrYohG2G++ovZrYOkm4Knwa0mc1cn84xJOR4KEU0WSchhLbd0UklbHw== } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-mv/6z+EwnWpr+MjGVavMGvM4Tl8S/tHmpl9ZsDfrQeHpYy4Hfr0UYdKEf9OOTe280oIr70yPxLRmQ6MfINfJDw==} - engines: {node: '>= 16'} + resolution: + { integrity: sha512-mv/6z+EwnWpr+MjGVavMGvM4Tl8S/tHmpl9ZsDfrQeHpYy4Hfr0UYdKEf9OOTe280oIr70yPxLRmQ6MfINfJDw== } + engines: { node: ">= 16" } peerDependencies: express: 4 \|\| 5 \|\| ^5.0.0-beta.1 dependencies: @@ -6461,8 +7037,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-5/PsL6iGPdfQ/lKM1UuielYgv3BUoJfz1aUwU9vHZ+J7gyvwdQXFEBIEIaxeGf0GIcreATNyBExtalisDbuMqQ==} - engines: {node: '>= 0.10.0'} + resolution: + { integrity: sha512-5/PsL6iGPdfQ/lKM1UuielYgv3BUoJfz1aUwU9vHZ+J7gyvwdQXFEBIEIaxeGf0GIcreATNyBExtalisDbuMqQ== } + engines: { node: ">= 0.10.0" } dependencies: accepts: 1.3.8 array-flatten: 1.1.1 @@ -6500,8 +7077,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew== } + engines: { node: ">=4" } dependencies: chardet: 0.7.0 iconv-lite: 0.4.24 @@ -6509,91 +7087,105 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg==} - engines: {node: '>= 10.17.0'} + resolution: + { integrity: sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg== } + engines: { node: ">= 10.17.0" } hasBin: true dependencies: debug: 4.3.4([email protected]) get-stream: 5.2.0 yauzl: 2.10.0 optionalDependencies: - '@types/yauzl': 2.10.0 + "@types/yauzl": 2.10.0 transitivePeerDependencies: - supports-color dev: true /[email protected]: - resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} + resolution: + { integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== } dev: true /[email protected]: - resolution: {integrity: sha512-ChDuvbOypPuNjO8yIDf36x7BlZX1smcUMTTcyoIjycexOxd6DFsKsg21qVBzEmr3G7fUKIRy2/psii+CIUt7FA==} - engines: {node: '>=8.6.0'} + resolution: + { integrity: sha512-ChDuvbOypPuNjO8yIDf36x7BlZX1smcUMTTcyoIjycexOxd6DFsKsg21qVBzEmr3G7fUKIRy2/psii+CIUt7FA== } + engines: { node: ">=8.6.0" } dependencies: - '@nodelib/fs.stat': 2.0.5 - '@nodelib/fs.walk': 1.2.8 + "@nodelib/fs.stat": 2.0.5 + "@nodelib/fs.walk": 1.2.8 glob-parent: 5.1.2 merge2: 1.4.1 micromatch: 4.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==} + resolution: + { integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== } dev: true /[email protected]: - resolution: {integrity: sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==} + resolution: + { integrity: sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw== } dev: true /[email protected]: - resolution: {integrity: sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg==} - engines: {node: '>= 4.9.1'} + resolution: + { integrity: sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg== } + engines: { node: ">= 4.9.1" } dev: true /[email protected]: - resolution: {integrity: sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==} + resolution: + { integrity: sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw== } dependencies: reusify: 1.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g==} + resolution: + { integrity: sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g== } dependencies: pend: 1.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw==} + resolution: + { integrity: sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw== } dev: true /[email protected]: - resolution: {integrity: sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== } + engines: { node: ">=8" } dependencies: escape-string-regexp: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==} - engines: {node: ^10.12.0 \|\| >=12.0.0} + resolution: + { integrity: sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg== } + engines: { node: ^10.12.0 \|\| >=12.0.0 } dependencies: flat-cache: 3.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==} + resolution: + { integrity: sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q== } dependencies: minimatch: 5.1.6 dev: true /[email protected]: - resolution: {integrity: sha512-lc1bnsSr4L4Bdif8Xb/qrtokGbq5zlsms/CYH8PP+WtCkGNF65DPiQY8vG3SakEdRn8Dlnm+gW/qWKKjS5sZzQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-lc1bnsSr4L4Bdif8Xb/qrtokGbq5zlsms/CYH8PP+WtCkGNF65DPiQY8vG3SakEdRn8Dlnm+gW/qWKKjS5sZzQ== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-hcFKyUG57yWGAzu1CMt/dPzYZuv+jAJUT85bL8mrXvNe6hWj6yEHEc4EdcgiA6Z3oi1/9wXJdZPXF2dZNgwgOg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-hcFKyUG57yWGAzu1CMt/dPzYZuv+jAJUT85bL8mrXvNe6hWj6yEHEc4EdcgiA6Z3oi1/9wXJdZPXF2dZNgwgOg== } + engines: { node: ">=8" } dependencies: filename-reserved-regex: 2.0.0 strip-outer: 1.0.1 @@ -6601,15 +7193,17 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== } + engines: { node: ">=8" } dependencies: to-regex-range: 5.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg== } + engines: { node: ">= 0.8" } dependencies: debug: 2.6.9 encodeurl: 1.0.2 @@ -6623,8 +7217,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig== } + engines: { node: ">=8" } dependencies: commondir: 1.0.1 make-dir: 3.1.0 @@ -6632,100 +7227,114 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==} - engines: {node: '>=14.16'} + resolution: + { integrity: sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg== } + engines: { node: ">=14.16" } dependencies: common-path-prefix: 3.0.0 pkg-dir: 7.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-NWzkk0jSJtTt08+FBFMvXoeZnOJD+jTtsRmBYbAIzJdX6l7dLgR7CTubCM5/eDdPUBvLCeVasP1brfVR/9/EZQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-NWzkk0jSJtTt08+FBFMvXoeZnOJD+jTtsRmBYbAIzJdX6l7dLgR7CTubCM5/eDdPUBvLCeVasP1brfVR/9/EZQ== } + engines: { node: ">=4" } dependencies: locate-path: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== } + engines: { node: ">=8" } dependencies: locate-path: 5.0.0 path-exists: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng== } + engines: { node: ">=10" } dependencies: locate-path: 6.0.0 path-exists: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dependencies: locate-path: 7.2.0 path-exists: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==} - engines: {node: ^10.12.0 \|\| >=12.0.0} + resolution: + { integrity: sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg== } + engines: { node: ^10.12.0 \|\| >=12.0.0 } dependencies: flatted: 3.2.7 rimraf: 3.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==} + resolution: + { integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==} + resolution: + { integrity: sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ== } dev: true /[email protected]: - resolution: {integrity: sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==} + resolution: + { integrity: sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw== } dev: true /[email protected]: - resolution: {integrity: sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==} - engines: {node: '>=4.0'} + resolution: + { integrity: sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA== } + engines: { node: ">=4.0" } peerDependencies: - debug: '' + debug: "" peerDependenciesMeta: debug: optional: true dev: true /[email protected]: - resolution: {integrity: sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==} + resolution: + { integrity: sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw== } dependencies: is-callable: 1.2.7 dev: true /[email protected]: - resolution: {integrity: sha512-dCIq9FpEcyQyXKCkyzmlPTFNgrCzPudOe+mhvJU5zAtlBnGVy2yKxtfsxK2tQBThwq225jcvBjpw1Gr40uzZCA==} - engines: {node: '>=8.0.0'} + resolution: + { integrity: sha512-dCIq9FpEcyQyXKCkyzmlPTFNgrCzPudOe+mhvJU5zAtlBnGVy2yKxtfsxK2tQBThwq225jcvBjpw1Gr40uzZCA== } + engines: { node: ">=8.0.0" } dependencies: cross-spawn: 7.0.3 signal-exit: 3.0.7 dev: true /[email protected]: - resolution: {integrity: sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg== } + engines: { node: ">=14" } dependencies: cross-spawn: 7.0.3 signal-exit: 4.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww== } + engines: { node: ">= 6" } dependencies: asynckit: 0.4.0 combined-stream: 1.0.8 @@ -6733,26 +7342,31 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-cHEpEQHUg0f8XdtZCc2ZAhrHzKzT0MrFUTcvx+hfxYu7rGMDc5SKoXFh+n4YigxsHXRzc6OrCshdR1bWH6HHyg==} + resolution: + { integrity: sha512-cHEpEQHUg0f8XdtZCc2ZAhrHzKzT0MrFUTcvx+hfxYu7rGMDc5SKoXFh+n4YigxsHXRzc6OrCshdR1bWH6HHyg== } dev: true /[email protected]: - resolution: {integrity: sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==} + resolution: + { integrity: sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow== } dev: true /[email protected]: - resolution: {integrity: sha512-MGIE4HOvQCeUCzmlHs0vXpih4ysz4wg9qiSAu6cd42lVwPbTM1TjV7RusoyQqMmk/95gdQZX72u+YW+c3eEpFQ==} - engines: {node: '>=14.14'} + resolution: + { integrity: sha512-MGIE4HOvQCeUCzmlHs0vXpih4ysz4wg9qiSAu6cd42lVwPbTM1TjV7RusoyQqMmk/95gdQZX72u+YW+c3eEpFQ== } + engines: { node: ">=14.14" } dependencies: graceful-fs: 4.2.11 jsonfile: 6.1.0 @@ -6760,8 +7374,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==} - engines: {node: '>=6 <7 \|\| >=8'} + resolution: + { integrity: sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g== } + engines: { node: ">=6 <7 \|\| >=8" } dependencies: graceful-fs: 4.2.11 jsonfile: 4.0.0 @@ -6769,42 +7384,49 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg== } + engines: { node: ">= 8" } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-2GAfyfoaCDRrM6jaOS3UsBts8yJ55VioXdWcOL7dK9zdAuKT71+WBA4ifnNYqVjYv+4SsPxjK0JT4yIIn4cA/g==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-2GAfyfoaCDRrM6jaOS3UsBts8yJ55VioXdWcOL7dK9zdAuKT71+WBA4ifnNYqVjYv+4SsPxjK0JT4yIIn4cA/g== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: minipass: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} + resolution: + { integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== } dev: true /[email protected]: - resolution: {integrity: sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==} - engines: {node: ^8.16.0 \|\| ^10.6.0 \|\| >=11.0.0} + resolution: + { integrity: sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA== } + engines: { node: ^8.16.0 \|\| ^10.6.0 \|\| >=11.0.0 } os: [darwin] requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==} + resolution: + { integrity: sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A== } dev: true /[email protected]: - resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==} + resolution: + { integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== } dev: true /[email protected]: - resolution: {integrity: sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -6813,12 +7435,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==} + resolution: + { integrity: sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ== } dev: true /[email protected]: - resolution: {integrity: sha512-+5J6MS/5XksCuXq++uFRsnUd7Ovu1XenbeuIuNRJxYWjgQbPuFhT14lAvsWfqfAmnwluf1OwMjz39HjfLPci0Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-+5J6MS/5XksCuXq++uFRsnUd7Ovu1XenbeuIuNRJxYWjgQbPuFhT14lAvsWfqfAmnwluf1OwMjz39HjfLPci0Q== } + engines: { node: ">=10" } dependencies: aproba: 2.0.0 color-support: 1.1.3 @@ -6832,8 +7456,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } dependencies: aproba: 2.0.0 color-support: 1.1.3 @@ -6846,21 +7471,25 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== } + engines: { node: ">=6.9.0" } dev: true /[email protected]: - resolution: {integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==} - engines: {node: 6.* \|\| 8.* \|\| >= 10.} + resolution: + { integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== } + engines: { node: 6. \|\| 8.* \|\| >= 10.* } dev: true /[email protected]: - resolution: {integrity: sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==} + resolution: + { integrity: sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ== } dev: true /[email protected]: - resolution: {integrity: sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw==} + resolution: + { integrity: sha512-2DcsyfABl+gVHEfCOaTrWgyt+tb6MSEGmKq+kI5HwLbIYgjgmMcV8KQ41uaKz1xxUcn9tJtgFbQUEVcEbd0FYw== } dependencies: function-bind: 1.1.2 has: 1.0.3 @@ -6869,7 +7498,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-0gSo4ml/0j98Y3lngkFEot/zhiCeWsbYIlZ+uZOVgzLyLaUw7wxUL+nCTP0XJvJg1AXulJRI3UJi8GsbDuxdGA==} + resolution: + { integrity: sha512-0gSo4ml/0j98Y3lngkFEot/zhiCeWsbYIlZ+uZOVgzLyLaUw7wxUL+nCTP0XJvJg1AXulJRI3UJi8GsbDuxdGA== } dependencies: function-bind: 1.1.2 has-proto: 1.0.1 @@ -6878,54 +7508,62 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==} - engines: {node: '>=8.0.0'} + resolution: + { integrity: sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q== } + engines: { node: ">=8.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-2+QbHjFRfGB74v/pYWjd5OhU3TDIC2Gv/YKUTk/tCvAz0pkn/Mz6P3uByuBimLOcPvN2jYdScl3xGFSrx0jEcA==} - engines: {node: '>=6.9.0'} + resolution: + { integrity: sha512-2+QbHjFRfGB74v/pYWjd5OhU3TDIC2Gv/YKUTk/tCvAz0pkn/Mz6P3uByuBimLOcPvN2jYdScl3xGFSrx0jEcA== } + engines: { node: ">=6.9.0" } hasBin: true dependencies: - '@hutson/parse-repository-url': 3.0.2 + "@hutson/parse-repository-url": 3.0.2 hosted-git-info: 4.1.0 through2: 2.0.5 yargs: 16.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-g/Q1aTSDOxFpchXC4i8ZWvxA1lnPqx/JHqcpIw0/LX9T8x/GBbi6YnlN5nhaKIFkT8oFsscUKgDJYxfwfS6QsQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-g/Q1aTSDOxFpchXC4i8ZWvxA1lnPqx/JHqcpIw0/LX9T8x/GBbi6YnlN5nhaKIFkT8oFsscUKgDJYxfwfS6QsQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA== } + engines: { node: ">=8" } dependencies: pump: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-A1B3Bh1UmL0bidM/YX2NsCOTnGJePL9rO/M+Mw3m9f2gUpfokS0hi5Eah0WSUEWZdZhIZtMjkIYS7mDfOqNHbg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-A1B3Bh1UmL0bidM/YX2NsCOTnGJePL9rO/M+Mw3m9f2gUpfokS0hi5Eah0WSUEWZdZhIZtMjkIYS7mDfOqNHbg== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 get-intrinsic: 1.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-MdXigvqN3I66Y+tAZsQJMzpBWQOI1snD6BYuECmP+GEdryYMMOQvzn4AConk/+qNg/XIuQhB1xNGrl3Rmj1iow==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-MdXigvqN3I66Y+tAZsQJMzpBWQOI1snD6BYuECmP+GEdryYMMOQvzn4AConk/+qNg/XIuQhB1xNGrl3Rmj1iow== } + engines: { node: ">=10" } hasBin: true dependencies: async: 3.2.4 @@ -6938,8 +7576,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-VnctFhw+xfj8Va1xtfEqCUD2XDrbAPSJx+hSrE5K7fGdjZruW7XV+QOrN7LF/RJyvspRiD2I0asWsxFp0ya26A==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-VnctFhw+xfj8Va1xtfEqCUD2XDrbAPSJx+hSrE5K7fGdjZruW7XV+QOrN7LF/RJyvspRiD2I0asWsxFp0ya26A== } + engines: { node: ">=10" } hasBin: true dependencies: dargs: 7.0.0 @@ -6950,8 +7589,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-b5OHmZ3vAgGrDn/X0kS+9qCfNKWe4K/jFnhwzVWWg0/k5eLa3060tZShrRg8Dja5kPc+YjS0Gc6y7cRr44Lpjw==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-b5OHmZ3vAgGrDn/X0kS+9qCfNKWe4K/jFnhwzVWWg0/k5eLa3060tZShrRg8Dja5kPc+YjS0Gc6y7cRr44Lpjw== } + engines: { node: ">=14" } hasBin: true dependencies: dargs: 7.0.0 @@ -6960,16 +7600,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-eU+GGrZgccNJcsDH5LkXR3PB9M958hxc7sbA8DFJjrv9j4L2P/eZfKhM+QD6wyzpiv+b1BpK0XrYCxkovtjSLw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-eU+GGrZgccNJcsDH5LkXR3PB9M958hxc7sbA8DFJjrv9j4L2P/eZfKhM+QD6wyzpiv+b1BpK0XrYCxkovtjSLw== } + engines: { node: ">=4" } dependencies: gitconfiglocal: 1.0.0 pify: 2.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-fZ+tmZ1O5aXW/T5nLzZLbxWAHdQTLLXalOECMNAmhoEQSfqZjtaeMjpsXH4C5qVhrICTkVQeQFujB1lKzIHljA==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-fZ+tmZ1O5aXW/T5nLzZLbxWAHdQTLLXalOECMNAmhoEQSfqZjtaeMjpsXH4C5qVhrICTkVQeQFujB1lKzIHljA== } + engines: { node: ">=14" } hasBin: true dependencies: meow: 8.1.2 @@ -6977,45 +7619,52 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ONdIrbBCFusq1Oy0sC71F5azx8bVkvtZtMJAsv+a6lz5YAmbNnLD6HAB4gptHZVLPR8S2/kVN6Gab7lryq5+lQ==} + resolution: + { integrity: sha512-ONdIrbBCFusq1Oy0sC71F5azx8bVkvtZtMJAsv+a6lz5YAmbNnLD6HAB4gptHZVLPR8S2/kVN6Gab7lryq5+lQ== } dependencies: is-ssh: 1.4.0 parse-url: 8.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-5FvPJP/70WkIprlUZ33bm4UAaFdjcLkJLpWft1BeZKqwR0uhhNGoKwlUaPtVb4LxCSQ++erHapRak9kWGj+FCA==} + resolution: + { integrity: sha512-5FvPJP/70WkIprlUZ33bm4UAaFdjcLkJLpWft1BeZKqwR0uhhNGoKwlUaPtVb4LxCSQ++erHapRak9kWGj+FCA== } dependencies: git-up: 7.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-spLUXeTAVHxDtKsJc8FkFVgFtMdEN9qPGpL23VfSHx4fP4+Ds097IXLvymbnDH8FnmxX5Nr9bPw3A+AQ6mWEaQ==} + resolution: + { integrity: sha512-spLUXeTAVHxDtKsJc8FkFVgFtMdEN9qPGpL23VfSHx4fP4+Ds097IXLvymbnDH8FnmxX5Nr9bPw3A+AQ6mWEaQ== } dependencies: ini: 1.3.8 dev: true /[email protected]: - resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== } + engines: { node: ">= 6" } dependencies: is-glob: 4.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== } + engines: { node: ">=10.13.0" } dependencies: is-glob: 4.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==} + resolution: + { integrity: sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== } dev: true /[email protected]: - resolution: {integrity: sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g== } + engines: { node: ">=16 \|\| 14 >=14.17" } hasBin: true dependencies: foreground-child: 3.1.1 @@ -7026,7 +7675,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A==} + resolution: + { integrity: sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A== } dependencies: fs.realpath: 1.0.0 inflight: 1.0.6 @@ -7037,7 +7687,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==} + resolution: + { integrity: sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q== } dependencies: fs.realpath: 1.0.0 inflight: 1.0.6 @@ -7048,7 +7699,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==} + resolution: + { integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== } dependencies: fs.realpath: 1.0.0 inflight: 1.0.6 @@ -7059,8 +7711,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ== } + engines: { node: ">=12" } dependencies: fs.realpath: 1.0.0 inflight: 1.0.6 @@ -7070,8 +7723,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q== } + engines: { node: ">=16 \|\| 14 >=14.17" } dependencies: fs.realpath: 1.0.0 minimatch: 8.0.4 @@ -7080,8 +7734,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-PT6XReJ+D07JvGoxQMkT6qji/jVNfX/h364XHZOWeRzy64sSFr+xJ5OX7LI3b4MPQzdL4H8Y8M0xzPpsVMwA8Q==} - engines: {node: '>=10.0'} + resolution: + { integrity: sha512-PT6XReJ+D07JvGoxQMkT6qji/jVNfX/h364XHZOWeRzy64sSFr+xJ5OX7LI3b4MPQzdL4H8Y8M0xzPpsVMwA8Q== } + engines: { node: ">=10.0" } requiresBuild: true dependencies: boolean: 3.2.0 @@ -7094,34 +7749,39 @@ packages: optional: true /[email protected]: - resolution: {integrity: sha512-NknMLn7F2J7aflwFOlGdNIuCDpN3VGoSoB+aap3KABFWbHVn1TCgFC+np23J8W2BiZbjfEw3BFBycSMv1AFblg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-NknMLn7F2J7aflwFOlGdNIuCDpN3VGoSoB+aap3KABFWbHVn1TCgFC+np23J8W2BiZbjfEw3BFBycSMv1AFblg== } + engines: { node: ">=4" } dependencies: ini: 1.3.8 dev: true /[email protected]: - resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-Qg5QtVkCy/kv3FUSlu4ukeZDVf9ee0iXLAUYX13gbR17bnejFTzr4iS9bY7kwCf1NztRNm1t91fjOiyx4CSwPQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Qg5QtVkCy/kv3FUSlu4ukeZDVf9ee0iXLAUYX13gbR17bnejFTzr4iS9bY7kwCf1NztRNm1t91fjOiyx4CSwPQ== } + engines: { node: ">=8" } dependencies: type-fest: 0.20.2 dev: true /[email protected]: - resolution: {integrity: sha512-sFdI5LyBiNTHjRd7cGPWapiHWMOXKyuBNX/cWJ3NfzrZQVa8GI/8cofCl74AOVqq9W5kNmguTIzJ/1s2gyI9wA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-sFdI5LyBiNTHjRd7cGPWapiHWMOXKyuBNX/cWJ3NfzrZQVa8GI/8cofCl74AOVqq9W5kNmguTIzJ/1s2gyI9wA== } + engines: { node: ">= 0.4" } dependencies: define-properties: 1.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g== } + engines: { node: ">=10" } dependencies: array-union: 2.1.0 dir-glob: 3.0.1 @@ -7132,8 +7792,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-KVbFv2TQtbzCoxAnfD6JcHZTYCzyliEaaeM/gH8qQdkKr5s0OP9scEgvdcngyk7AVdY6YVW/TJHd+lQ/Df3Daw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-KVbFv2TQtbzCoxAnfD6JcHZTYCzyliEaaeM/gH8qQdkKr5s0OP9scEgvdcngyk7AVdY6YVW/TJHd+lQ/Df3Daw== } + engines: { node: ">=0.10.0" } dependencies: array-union: 1.0.2 glob: 7.2.3 @@ -7143,19 +7804,21 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==} + resolution: + { integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA== } dependencies: get-intrinsic: 1.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-6tfZ91bOr7bOXnK7PRDCGBLa1H4U080YHNaAQ2KsMGlLEzRbk44nsZF2E1IeRc3vtJHPVbKCYgdFbaGO2ljd8g==} - engines: {node: '>=10.19.0'} - dependencies: - '@sindresorhus/is': 4.6.0 - '@szmarczak/http-timer': 4.0.6 - '@types/cacheable-request': 6.0.3 - '@types/responselike': 1.0.0 + resolution: + { integrity: sha512-6tfZ91bOr7bOXnK7PRDCGBLa1H4U080YHNaAQ2KsMGlLEzRbk44nsZF2E1IeRc3vtJHPVbKCYgdFbaGO2ljd8g== } + engines: { node: ">=10.19.0" } + dependencies: + "@sindresorhus/is": 4.6.0 + "@szmarczak/http-timer": 4.0.6 + "@types/cacheable-request": 6.0.3 + "@types/responselike": 1.0.0 cacheable-lookup: 5.0.4 cacheable-request: 7.0.2 decompress-response: 6.0.0 @@ -7166,23 +7829,27 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} + resolution: + { integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== } dev: true /[email protected]: - resolution: {integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==} + resolution: + { integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag== } dev: true /[email protected]: - resolution: {integrity: sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q== } + engines: { node: ">=10" } dependencies: duplexer: 0.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==} - engines: {node: '>=0.4.7'} + resolution: + { integrity: sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA== } + engines: { node: ">=0.4.7" } hasBin: true dependencies: minimist: 1.2.8 @@ -7194,122 +7861,143 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==} + resolution: + { integrity: sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ== } dev: true /[email protected]: - resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==} + resolution: + { integrity: sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ== } dependencies: get-intrinsic: 1.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ== } + engines: { node: ">= 0.4" } dependencies: has-symbols: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==} + resolution: + { integrity: sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ== } dev: true /[email protected]: - resolution: {integrity: sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==} - engines: {node: '>= 0.4.0'} + resolution: + { integrity: sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw== } + engines: { node: ">= 0.4.0" } dependencies: function-bind: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-Hrp5vIK/xr5SkeN2onO32H0MgNZ0f17HRNH39WfL0SYUNOTZ5Lz1TJ8Pajo/87dYGEFlLMm7mIc/k/s6Bvz9HQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Hrp5vIK/xr5SkeN2onO32H0MgNZ0f17HRNH39WfL0SYUNOTZ5Lz1TJ8Pajo/87dYGEFlLMm7mIc/k/s6Bvz9HQ== } + engines: { node: ">=8" } dependencies: is-stream: 2.0.1 type-fest: 0.8.1 dev: true /[email protected]: - resolution: {integrity: sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA== } + engines: { node: ">= 0.4" } dependencies: function-bind: 1.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==} + resolution: + { integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-MsIgYmdBh460ZZ8cJC81q4XJknjG567wzEmv46WOBblDb6TUd3z8/GhgmsM9pn8g2B80tAJ4m5/d3Bi1KrSUBQ==} - engines: {node: '>=16.0.0'} + resolution: + { integrity: sha512-MsIgYmdBh460ZZ8cJC81q4XJknjG567wzEmv46WOBblDb6TUd3z8/GhgmsM9pn8g2B80tAJ4m5/d3Bi1KrSUBQ== } + engines: { node: ">=16.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==} + resolution: + { integrity: sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw== } dev: true /[email protected]: - resolution: {integrity: sha512-aXpmwoOhRBrw6X3j0h5RloK4x1OzsxMPyxqIHyNfSe2pypkVTZFpEiRoSipPEPlMrh0HW/XsjkJ5WgnCirpNUw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-aXpmwoOhRBrw6X3j0h5RloK4x1OzsxMPyxqIHyNfSe2pypkVTZFpEiRoSipPEPlMrh0HW/XsjkJ5WgnCirpNUw== } + engines: { node: ">=10" } dependencies: lru-cache: 6.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA== } + engines: { node: ">=10" } dependencies: lru-cache: 6.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: lru-cache: 7.18.3 dev: true /[email protected]: - resolution: {integrity: sha512-Y22oTqIU4uuPgEemfz7NDJz6OeKf12Lsu+QC+s3BVpda64lTiMYCyGwg5ki4vFxkMwQdeZDl2adZoqUgdFuTgQ==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-Y22oTqIU4uuPgEemfz7NDJz6OeKf12Lsu+QC+s3BVpda64lTiMYCyGwg5ki4vFxkMwQdeZDl2adZoqUgdFuTgQ== } + engines: { node: ">=18" } dependencies: whatwg-encoding: 3.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==} + resolution: + { integrity: sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== } dev: true /[email protected]: - resolution: {integrity: sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==} - engines: {node: ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA== } + engines: { node: ^14.13.1 \|\| >=16.0.0 } hasBin: true dependencies: camel-case: 4.1.2 @@ -7322,12 +8010,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==} + resolution: + { integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ== } dev: true /[email protected]: - resolution: {integrity: sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ== } + engines: { node: ">= 0.8" } dependencies: depd: 2.0.0 inherits: 2.0.4 @@ -7337,10 +8027,11 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w== } + engines: { node: ">= 6" } dependencies: - '@tootallnate/once': 2.0.0 + "@tootallnate/once": 2.0.0 agent-base: 6.0.2 debug: 4.3.4([email protected]) transitivePeerDependencies: @@ -7348,8 +8039,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-+ZT+iBxVUQ1asugqnD6oWoRiS25AkjNfG085dKJGtGxkdwLQrMKU5wJr2bOOFAXzKcTuqq+7fZlTMgG3SRfIYQ==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-+ZT+iBxVUQ1asugqnD6oWoRiS25AkjNfG085dKJGtGxkdwLQrMKU5wJr2bOOFAXzKcTuqq+7fZlTMgG3SRfIYQ== } + engines: { node: ">= 14" } dependencies: agent-base: 7.1.0 debug: 4.3.4([email protected]) @@ -7358,16 +8050,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-V+23sDMr12Wnz7iTcDeJr3O6AIxlnvT/bmaAAAP/Xda35C90p9599p0F1eHR/N1KILWSoWVAiOMFjBBXaXSMxg==} - engines: {node: '>=10.19.0'} + resolution: + { integrity: sha512-V+23sDMr12Wnz7iTcDeJr3O6AIxlnvT/bmaAAAP/Xda35C90p9599p0F1eHR/N1KILWSoWVAiOMFjBBXaXSMxg== } + engines: { node: ">=10.19.0" } dependencies: quick-lru: 5.1.1 resolve-alpn: 1.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA== } + engines: { node: ">= 6" } dependencies: agent-base: 6.0.2 debug: 4.3.4([email protected]) @@ -7376,8 +8070,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-NmLNjm6ucYwtcUmL7JQC1ZQ57LmHP4lT15FQ8D61nak1rO6DH+fz5qNK2Ap5UN4ZapYICE3/0KodcLYSPsPbaA==} - engines: {node: '>= 14'} + resolution: + { integrity: sha512-NmLNjm6ucYwtcUmL7JQC1ZQ57LmHP4lT15FQ8D61nak1rO6DH+fz5qNK2Ap5UN4ZapYICE3/0KodcLYSPsPbaA== } + engines: { node: ">= 14" } dependencies: agent-base: 7.1.0 debug: 4.3.4([email protected]) @@ -7386,78 +8081,91 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==} - engines: {node: '>=10.17.0'} + resolution: + { integrity: sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== } + engines: { node: ">=10.17.0" } dev: true /[email protected]: - resolution: {integrity: sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==} + resolution: + { integrity: sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ== } dependencies: ms: 2.1.3 dev: true /[email protected]: - resolution: {integrity: sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg== } + engines: { node: ">=14" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== } + engines: { node: ">=0.10.0" } dependencies: safer-buffer: 2.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw== } + engines: { node: ">=0.10.0" } dependencies: safer-buffer: 2.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==} + resolution: + { integrity: sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA== } dev: true /[email protected]: - resolution: {integrity: sha512-Ius2VYcGNk7T90CppJqcIkS5ooHUZyIQK+ClZfMfMNFEF9VSE73Fq+906u/CWu92x4gzZMWOwfFYckPObzdEbA==} + resolution: + { integrity: sha512-Ius2VYcGNk7T90CppJqcIkS5ooHUZyIQK+ClZfMfMNFEF9VSE73Fq+906u/CWu92x4gzZMWOwfFYckPObzdEbA== } dev: true /[email protected]: - resolution: {integrity: sha512-yemi4pMf51WKT7khInJqAvsIGzoqYXblnsz0ql8tM+yi1EKYTY1evX4NAbJrLL/Aanr2HyZeluqU+Oi7MGHokw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-yemi4pMf51WKT7khInJqAvsIGzoqYXblnsz0ql8tM+yi1EKYTY1evX4NAbJrLL/Aanr2HyZeluqU+Oi7MGHokw== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } dependencies: minimatch: 5.1.6 dev: true /[email protected]: - resolution: {integrity: sha512-C7FfFoTA+bI10qfeydT8aZbvr91vAEU+2W5BZUlzPec47oNb07SsOfwYrtxuvOYdUApPP/Qlh4DtAO51Ekk2QA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-C7FfFoTA+bI10qfeydT8aZbvr91vAEU+2W5BZUlzPec47oNb07SsOfwYrtxuvOYdUApPP/Qlh4DtAO51Ekk2QA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: minimatch: 9.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==} - engines: {node: '>= 4'} + resolution: + { integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ== } + engines: { node: ">= 4" } dev: true /[email protected]: - resolution: {integrity: sha512-0AOCmOip+xgJwEVTQj1EfiDDOkPmuyllDuTuEX+DDXUgapLAsBIfkg3sxCYyCEA8mQqZrrxPUGjcOQ2JS3WLkg==} + resolution: + { integrity: sha512-0AOCmOip+xgJwEVTQj1EfiDDOkPmuyllDuTuEX+DDXUgapLAsBIfkg3sxCYyCEA8mQqZrrxPUGjcOQ2JS3WLkg== } dev: true /[email protected]: - resolution: {integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw== } + engines: { node: ">=6" } dependencies: parent-module: 1.0.1 resolve-from: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-ASB07uLtnDs1o6EHjKpX34BKYDSqnFerfTOJL2HvMqF70LnxpjkzDB8J44oT9pu4AMPkQwf8jl6szgvNd2tRIg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ASB07uLtnDs1o6EHjKpX34BKYDSqnFerfTOJL2HvMqF70LnxpjkzDB8J44oT9pu4AMPkQwf8jl6szgvNd2tRIg== } + engines: { node: ">=8" } hasBin: true dependencies: pkg-dir: 4.2.0 @@ -7465,33 +8173,39 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==} - engines: {node: '>=0.8.19'} + resolution: + { integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA== } + engines: { node: ">=0.8.19" } dev: true /[email protected]: - resolution: {integrity: sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==} + resolution: + { integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== } dependencies: once: 1.4.0 wrappy: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} + resolution: + { integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== } dev: true /[email protected]: - resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} + resolution: + { integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== } dev: true /[email protected]: - resolution: {integrity: sha512-kBhlSheBfYmq3e0L1ii+VKe3zBTLL5lDCDWR+f9dLmEGSB3MqLlMlsolubSsyI88Bg6EA+BIMlomAnQ1SwgQBw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-kBhlSheBfYmq3e0L1ii+VKe3zBTLL5lDCDWR+f9dLmEGSB3MqLlMlsolubSsyI88Bg6EA+BIMlomAnQ1SwgQBw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: npm-package-arg: 10.1.0 promzard: 1.0.0 @@ -7503,8 +8217,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-QAgPDQMEgrDssk1XiwwHoOGYF9BAbUcc1+j+FhEvaOt8/cKRqyLn0U5qA6F74fGhTMGxf92pOvPBeh29jQJDTQ==} - engines: {node: '>=12.0.0'} + resolution: + { integrity: sha512-QAgPDQMEgrDssk1XiwwHoOGYF9BAbUcc1+j+FhEvaOt8/cKRqyLn0U5qA6F74fGhTMGxf92pOvPBeh29jQJDTQ== } + engines: { node: ">=12.0.0" } dependencies: ansi-escapes: 4.3.2 chalk: 4.1.2 @@ -7524,8 +8239,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Y+R5hJrzs52QCG2laLn4udYVnxsfny9CpOhNhUvk/SSSVyF6T27FzRbF0sroPidSu3X8oEAkOn2K804mjpt6UQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Y+R5hJrzs52QCG2laLn4udYVnxsfny9CpOhNhUvk/SSSVyF6T27FzRbF0sroPidSu3X8oEAkOn2K804mjpt6UQ== } + engines: { node: ">= 0.4" } dependencies: get-intrinsic: 1.2.2 has: 1.0.3 @@ -7533,21 +8249,25 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-6xwYfHbajpoF0xLW+iwLkhwgvLoZDfjYfoFNu8ftMoXINzwuymNLd9u/KmwtdT2GbR+/Cz66otEGEVVUHX9QLQ==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-6xwYfHbajpoF0xLW+iwLkhwgvLoZDfjYfoFNu8ftMoXINzwuymNLd9u/KmwtdT2GbR+/Cz66otEGEVVUHX9QLQ== } + engines: { node: ">=10.13.0" } dev: true /[email protected]: - resolution: {integrity: sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==} + resolution: + { integrity: sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ== } dev: true /[email protected]: - resolution: {integrity: sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==} - engines: {node: '>= 0.10'} + resolution: + { integrity: sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== } + engines: { node: ">= 0.10" } dev: true /[email protected]: - resolution: {integrity: sha512-y+FyyR/w8vfIRq4eQcM1EYgSTnmHXPqaF+IgzgraytCFq5Xh8lllDVmAZolPJiZttZLeFSINPYMaEJ7/vWUa1w==} + resolution: + { integrity: sha512-y+FyyR/w8vfIRq4eQcM1EYgSTnmHXPqaF+IgzgraytCFq5Xh8lllDVmAZolPJiZttZLeFSINPYMaEJ7/vWUa1w== } dependencies: call-bind: 1.0.5 get-intrinsic: 1.2.2 @@ -7555,299 +8275,351 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} + resolution: + { integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== } dev: true /[email protected]: - resolution: {integrity: sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==} + resolution: + { integrity: sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ== } dev: true /[email protected]: - resolution: {integrity: sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==} + resolution: + { integrity: sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg== } dependencies: has-bigints: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw== } + engines: { node: ">=8" } dependencies: binary-extensions: 2.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 has-tostringtag: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A== } + engines: { node: ">=6" } dependencies: builtin-modules: 3.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==} + resolution: + { integrity: sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ== } hasBin: true dependencies: ci-info: 3.8.0 dev: true /[email protected]: - resolution: {integrity: sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==} + resolution: + { integrity: sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ== } dependencies: has: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==} + resolution: + { integrity: sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw== } dependencies: hasown: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ== } + engines: { node: ">= 0.4" } dependencies: has-tostringtag: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ== } + engines: { node: ">=8" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-zMIXX63sxzG3XrkHkrAPvm/OVZVSCPNkwMHU8oTX7/U3AL78I0QXCEICXUM13BIa8TYGZ68PiTKfQz3yaTNr4A==} + resolution: + { integrity: sha512-zMIXX63sxzG3XrkHkrAPvm/OVZVSCPNkwMHU8oTX7/U3AL78I0QXCEICXUM13BIa8TYGZ68PiTKfQz3yaTNr4A== } dependencies: acorn: 7.4.1 object-assign: 4.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== } + engines: { node: ">=0.10.0" } dependencies: is-extglob: 2.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==} + resolution: + { integrity: sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ== } dev: true /[email protected]: - resolution: {integrity: sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ== } + engines: { node: ">= 0.4" } dependencies: has-tostringtag: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} - engines: {node: '>=0.12.0'} + resolution: + { integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== } + engines: { node: ">=0.12.0" } dev: true /[email protected]: - resolution: {integrity: sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-YWnfyRwxL/+SsrWYfOpUtz5b3YD+nyfkHvjbcanzk8zgyO4ASD67uVMRt8k5bM4lLMDnXfriRhOpemw+NfT1eA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-YWnfyRwxL/+SsrWYfOpUtz5b3YD+nyfkHvjbcanzk8zgyO4ASD67uVMRt8k5bM4lLMDnXfriRhOpemw+NfT1eA== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og== } + engines: { node: ">=0.10.0" } dependencies: isobject: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==} + resolution: + { integrity: sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ== } dev: true /[email protected]: - resolution: {integrity: sha512-+lP4/6lKUBfQjZ2pdxThZvLUAafmZb8OAxFb8XXtiQmS35INgr85hdOGoEs124ez1FCnZJt6jau/T+alh58QFQ==} + resolution: + { integrity: sha512-+lP4/6lKUBfQjZ2pdxThZvLUAafmZb8OAxFb8XXtiQmS35INgr85hdOGoEs124ez1FCnZJt6jau/T+alh58QFQ== } dev: true /[email protected]: - resolution: {integrity: sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.2 has-tostringtag: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA==} + resolution: + { integrity: sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA== } dependencies: call-bind: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-x7+VxdxOdlV3CYpjvRLBv5Lo9OJerlYanjwFrPR9fuGPjCiNiCzFgAWpiLAohSbsnH4ZAys3SBh+hq5rJosxUQ==} + resolution: + { integrity: sha512-x7+VxdxOdlV3CYpjvRLBv5Lo9OJerlYanjwFrPR9fuGPjCiNiCzFgAWpiLAohSbsnH4ZAys3SBh+hq5rJosxUQ== } dependencies: protocols: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg== } + engines: { node: ">= 0.4" } dependencies: has-tostringtag: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg== } + engines: { node: ">= 0.4" } dependencies: has-symbols: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-xFuJpne9oFz5qDaodwmmG08e3CawH/2ZV8Qqza1Ko7Sk8POWbkRdwIoAWVhqvq0XeUzANEhKo2n0IXUGBm7A/w==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-xFuJpne9oFz5qDaodwmmG08e3CawH/2ZV8Qqza1Ko7Sk8POWbkRdwIoAWVhqvq0XeUzANEhKo2n0IXUGBm7A/w== } + engines: { node: ">=0.10.0" } dependencies: text-extensions: 1.9.0 dev: true /[email protected]: - resolution: {integrity: sha512-+oDTluR6WEjdXEJMnC2z6A4FRwFoYuvShVVEGsS7ewc0UTi2QtAKMDJuL4BDEVt+5T7MjFo12RP8ghOM75oKJw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-+oDTluR6WEjdXEJMnC2z6A4FRwFoYuvShVVEGsS7ewc0UTi2QtAKMDJuL4BDEVt+5T7MjFo12RP8ghOM75oKJw== } + engines: { node: ">=8" } dependencies: text-extensions: 2.4.0 dev: true /[email protected]: - resolution: {integrity: sha512-Z14TF2JNG8Lss5/HMqt0//T9JeHXttXy5pH/DBU4vi98ozO2btxzq9MwYDZYnKwU8nRsz/+GVFVRDq3DkVuSPg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Z14TF2JNG8Lss5/HMqt0//T9JeHXttXy5pH/DBU4vi98ozO2btxzq9MwYDZYnKwU8nRsz/+GVFVRDq3DkVuSPg== } + engines: { node: ">= 0.4" } dependencies: which-typed-array: 1.1.13 dev: true /[email protected]: - resolution: {integrity: sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==} + resolution: + { integrity: sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA== } dev: true /[email protected]: - resolution: {integrity: sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==} + resolution: + { integrity: sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ== } dependencies: call-bind: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww== } + engines: { node: ">=8" } dependencies: is-docker: 2.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==} + resolution: + { integrity: sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ== } dev: true /[email protected]: - resolution: {integrity: sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==} + resolution: + { integrity: sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ== } dev: true /[email protected]: - resolution: {integrity: sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==} + resolution: + { integrity: sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw== } dev: true /[email protected]: - resolution: {integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==} + resolution: + { integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== } dev: true /[email protected]: - resolution: {integrity: sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-eOeJ5BHCmHYvQK7xt9GkdHuzuCGS1Y6g9Gvnx3Ym33fz/HpLRYxiS0wHNr+m/MBC8B647Xt608vCDEvhl9c6Mw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-eOeJ5BHCmHYvQK7xt9GkdHuzuCGS1Y6g9Gvnx3Ym33fz/HpLRYxiS0wHNr+m/MBC8B647Xt608vCDEvhl9c6Mw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-Pt/uge1Q9s+5VAZ+pCo16TYMWPBIl+oaNIjgLQxcX0itS6ueeaA+pEfThZpH8WxhFgCiEb8sAJY6MdUKgiIWaQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Pt/uge1Q9s+5VAZ+pCo16TYMWPBIl+oaNIjgLQxcX0itS6ueeaA+pEfThZpH8WxhFgCiEb8sAJY6MdUKgiIWaQ== } + engines: { node: ">=8" } dependencies: append-transform: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-BXgQl9kf4WTCPCCpmFGoJkz/+uhvm7h7PFKUYxh7qarQd3ER33vHG//qaE8eN25l07YqZPpHXU9I09l/RD5aGQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-BXgQl9kf4WTCPCCpmFGoJkz/+uhvm7h7PFKUYxh7qarQd3ER33vHG//qaE8eN25l07YqZPpHXU9I09l/RD5aGQ== } + engines: { node: ">=8" } dependencies: - '@babel/core': 7.23.5 - '@istanbuljs/schema': 0.1.3 + "@babel/core": 7.23.5 + "@istanbuljs/schema": 0.1.3 istanbul-lib-coverage: 3.2.0 semver: 6.3.1 transitivePeerDependencies: @@ -7855,8 +8627,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-NkwHbo3E00oybX6NGJi6ar0B29vxyvNwoC7eJ4G4Yq28UfY758Hgn/heV8VRFhevPED4LXfFz0DQ8z/0kw9zMg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-NkwHbo3E00oybX6NGJi6ar0B29vxyvNwoC7eJ4G4Yq28UfY758Hgn/heV8VRFhevPED4LXfFz0DQ8z/0kw9zMg== } + engines: { node: ">=8" } dependencies: archy: 1.0.0 cross-spawn: 7.0.3 @@ -7867,8 +8640,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw== } + engines: { node: ">=8" } dependencies: istanbul-lib-coverage: 3.2.0 make-dir: 3.1.0 @@ -7876,8 +8650,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw== } + engines: { node: ">=10" } dependencies: debug: 4.3.4([email protected]) istanbul-lib-coverage: 3.2.0 @@ -7887,25 +8662,28 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nUsEMa9pBt/NOHqbcbeJEgqIlY/K7rVWUX6Lql2orY5e9roQOthbR3vtY4zzf2orPELg80fnxxk9zUyPlgwD1w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-nUsEMa9pBt/NOHqbcbeJEgqIlY/K7rVWUX6Lql2orY5e9roQOthbR3vtY4zzf2orPELg80fnxxk9zUyPlgwD1w== } + engines: { node: ">=8" } dependencies: html-escaper: 2.0.2 istanbul-lib-report: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ== } + engines: { node: ">=14" } dependencies: - '@isaacs/cliui': 8.0.2 + "@isaacs/cliui": 8.0.2 optionalDependencies: - '@pkgjs/parseargs': 0.11.0 + "@pkgjs/parseargs": 0.11.0 dev: true /[email protected]: - resolution: {integrity: sha512-ZDi3aP+fG/LchyBzUM804VjddnwfSfsdeYkwt8NcbKRvo4rFkjhs456iLFn3k2ZUWvNe4i48WACDbza8fhq2+w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-ZDi3aP+fG/LchyBzUM804VjddnwfSfsdeYkwt8NcbKRvo4rFkjhs456iLFn3k2ZUWvNe4i48WACDbza8fhq2+w== } + engines: { node: ">=10" } hasBin: true dependencies: async: 3.2.4 @@ -7915,12 +8693,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw==} + resolution: + { integrity: sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw== } dev: true /[email protected]: - resolution: {integrity: sha512-ZRm7cd2m9YyZ0N3iMyuo1iUiprxQ/MFpYWXzEEj7hjzL3WnDffKW8192XBDcrAI8j7hnrM1wed3bL/oEnYF/8w==} - engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-ZRm7cd2m9YyZ0N3iMyuo1iUiprxQ/MFpYWXzEEj7hjzL3WnDffKW8192XBDcrAI8j7hnrM1wed3bL/oEnYF/8w== } + engines: { node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0 } dependencies: chalk: 4.1.2 diff-sequences: 29.4.3 @@ -7929,47 +8709,56 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-J5Xez4nRRMjk8emnTpWrlkyb9pfRQQanDrvWHhsR1+VUfbwxi30eVcZFlcdGInRibU4G5LwHXpI7IRHU0CY+gg==} - engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-J5Xez4nRRMjk8emnTpWrlkyb9pfRQQanDrvWHhsR1+VUfbwxi30eVcZFlcdGInRibU4G5LwHXpI7IRHU0CY+gg== } + engines: { node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==} - engines: {node: '>= 10.13.0'} + resolution: + { integrity: sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg== } + engines: { node: ">= 10.13.0" } dependencies: - '@types/node': 20.10.3 + "@types/node": 20.10.3 merge-stream: 2.0.0 supports-color: 8.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==} + resolution: + { integrity: sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==} + resolution: + { integrity: sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA== } dev: true /[email protected]: - resolution: {integrity: sha512-9FzQjJ7MATs1tSpnco1K6ayiYE3figslrXA72G2HQ/n76RzvYlofyi5QM+iX4YRs/pu3yzxlVQSST23+dMDknw==} - engines: {node: '>= 0.6.0'} + resolution: + { integrity: sha512-9FzQjJ7MATs1tSpnco1K6ayiYE3figslrXA72G2HQ/n76RzvYlofyi5QM+iX4YRs/pu3yzxlVQSST23+dMDknw== } + engines: { node: ">= 0.6.0" } dev: true /[email protected]: - resolution: {integrity: sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==} + resolution: + { integrity: sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg== } dev: true /[email protected]: - resolution: {integrity: sha512-rtS5ATOo2Q5k1G+DADISilDA6lv79zIiwFd6CcjuIxGKLFm5C+RLImRscVap9k55i+MOZwgliw+NejvkLuGD5g==} + resolution: + { integrity: sha512-rtS5ATOo2Q5k1G+DADISilDA6lv79zIiwFd6CcjuIxGKLFm5C+RLImRscVap9k55i+MOZwgliw+NejvkLuGD5g== } dev: true /[email protected]: - resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} + resolution: + { integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== } dev: true /[email protected]: - resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} + resolution: + { integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== } hasBin: true dependencies: argparse: 1.0.10 @@ -7977,28 +8766,32 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==} + resolution: + { integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== } hasBin: true dependencies: argparse: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==} - engines: {node: '>=12.0.0'} + resolution: + { integrity: sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ== } + engines: { node: ">=12.0.0" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-t1KMcBkz/pT5JrvcJbpUR2u/w1kO9jXctaaGJ0vZDzwFnIvGWw9IDSRciT83kIs8Bnw4qpOl8bQK08V01YgMPg==} + resolution: + { integrity: sha512-t1KMcBkz/pT5JrvcJbpUR2u/w1kO9jXctaaGJ0vZDzwFnIvGWw9IDSRciT83kIs8Bnw4qpOl8bQK08V01YgMPg== } peerDependencies: - jsdom: '>=10.0.0' + jsdom: ">=10.0.0" dependencies: jsdom: 23.0.1([email protected]) dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-2i27vgvlUsGEBO9+/kJQRbtqtm+191b5zAZrU/UezVmnC2dlDAFLgDYJvAEi94T4kjsRKkezEtLQTgsNEsW2lQ==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-2i27vgvlUsGEBO9+/kJQRbtqtm+191b5zAZrU/UezVmnC2dlDAFLgDYJvAEi94T4kjsRKkezEtLQTgsNEsW2lQ== } + engines: { node: ">=18" } peerDependencies: canvas: ^2.11.2 peerDependenciesMeta: @@ -8034,72 +8827,87 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==} + resolution: + { integrity: sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA== } + engines: { node: ">=4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==} + resolution: + { integrity: sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== } dev: true /[email protected]: - resolution: {integrity: sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==} + resolution: + { integrity: sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw== } dev: true /[email protected]: - resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} + resolution: + { integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== } dev: true /[email protected]: - resolution: {integrity: sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==} + resolution: + { integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== } dev: true /[email protected]: - resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} + resolution: + { integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== } dev: true /[email protected]: - resolution: {integrity: sha512-1QoztHPsMQqhDq0hlXY5ZqcEdUzxQEIxgFkKl4WUp2pgShObl+9ovi4kRh2TfvAfxAoHOJ9vIMEqk3k4iex7tg==} + resolution: + { integrity: sha512-1QoztHPsMQqhDq0hlXY5ZqcEdUzxQEIxgFkKl4WUp2pgShObl+9ovi4kRh2TfvAfxAoHOJ9vIMEqk3k4iex7tg== } dev: true /[email protected]: - resolution: {integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==} + resolution: + { integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw== } dev: true /[email protected]: - resolution: {integrity: sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==} + resolution: + { integrity: sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA== } dev: true /[email protected]: - resolution: {integrity: sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==} + resolution: + { integrity: sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA== } hasBin: true dependencies: minimist: 1.2.8 dev: true /[email protected]: - resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== } + engines: { node: ">=6" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} + resolution: + { integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w== } dev: true /[email protected]: - resolution: {integrity: sha512-9vSMTPKBZzz56WY0SjbV7VQqa1+wUPKmwqtitmVXmTT5ohAMOYlOLgOdRwj0bl81nHP5HsKsYEVLCPiArHNSFw==} + resolution: + { integrity: sha512-9vSMTPKBZzz56WY0SjbV7VQqa1+wUPKmwqtitmVXmTT5ohAMOYlOLgOdRwj0bl81nHP5HsKsYEVLCPiArHNSFw== } dependencies: ace-builds: 1.31.1 ajv: 6.12.6 @@ -8113,13 +8921,15 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==} + resolution: + { integrity: sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg== } optionalDependencies: graceful-fs: 4.2.11 dev: true /[email protected]: - resolution: {integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==} + resolution: + { integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== } dependencies: universalify: 2.0.0 optionalDependencies: @@ -8127,57 +8937,66 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg==} - engines: {'0': node >= 0.2.0} + resolution: + { integrity: sha512-POQXvpdL69+CluYsillJ7SUhKvytYjW9vG/GKpnf+xP8UWgYEM/RaMzHHofbALDiKbbP1W8UEYmgGl39WkPZsg== } + engines: { "0": node >= 0.2.0 } dev: true /[email protected]: - resolution: {integrity: sha512-dFI5+BXlOra3SsJXEODXjHMpDPkZje6q2kCTPS9Ugb3Bdj9aok7HtrSPCXCOMsCbTStdUzhUVNS2xuVyMn2qFg==} + resolution: + { integrity: sha512-dFI5+BXlOra3SsJXEODXjHMpDPkZje6q2kCTPS9Ugb3Bdj9aok7HtrSPCXCOMsCbTStdUzhUVNS2xuVyMn2qFg== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-C9YK3Rf8q6VAPDCCU9fnqo3mAfOH6vUGnMcP4AQAYIEpWtfGLpwOTmZ+igtdK5y+VvI2n3CyYSzy4Qh34eq24A==} + resolution: + { integrity: sha512-C9YK3Rf8q6VAPDCCU9fnqo3mAfOH6vUGnMcP4AQAYIEpWtfGLpwOTmZ+igtdK5y+VvI2n3CyYSzy4Qh34eq24A== } dependencies: is-promise: 2.2.2 promise: 7.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-5MHbFaKn8cNSmVW7BYnijeAVlE4cYA/SVkifVgrh7yotnfhKmjuXpDKjrABLnT0SfHWV21P8ow07OGfRrNDg8g==} + resolution: + { integrity: sha512-5MHbFaKn8cNSmVW7BYnijeAVlE4cYA/SVkifVgrh7yotnfhKmjuXpDKjrABLnT0SfHWV21P8ow07OGfRrNDg8g== } dependencies: json-buffer: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-1zGZ9MF9H22UnkpVeuaGKOjfA2t6WrfdrJmGjy16ykcjnKQDmHVX+KI477rpbGevz/5FD4MC3xf1oxylBgcaQw==} - engines: {node: '>=14.14.0'} + resolution: + { integrity: sha512-1zGZ9MF9H22UnkpVeuaGKOjfA2t6WrfdrJmGjy16ykcjnKQDmHVX+KI477rpbGevz/5FD4MC3xf1oxylBgcaQw== } + engines: { node: ">=14.14.0" } dev: true /[email protected]: - resolution: {integrity: sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==} + resolution: + { integrity: sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A== } dev: true /[email protected]: - resolution: {integrity: sha512-Ddshct9hJrujtR7t2cAIiiiKnQCKiTvR/Ki3KhzpBNVepYtWq+dg+HxArZrezF+sYxI+OCxL00BxDHY4/H4uGg==} - engines: {node: '>=18.0.0'} + resolution: + { integrity: sha512-Ddshct9hJrujtR7t2cAIiiiKnQCKiTvR/Ki3KhzpBNVepYtWq+dg+HxArZrezF+sYxI+OCxL00BxDHY4/H4uGg== } + engines: { node: ">=18.0.0" } hasBin: true dependencies: - '@lerna/create': 8.0.0([email protected]) - '@npmcli/run-script': 6.0.2 - '@nx/devkit': 17.1.3([email protected]) - '@octokit/plugin-enterprise-rest': 6.0.1 - '@octokit/rest': 19.0.11 + "@lerna/create": 8.0.0([email protected]) + "@npmcli/run-script": 6.0.2 + "@nx/devkit": 17.1.3([email protected]) + "@octokit/plugin-enterprise-rest": 6.0.1 + "@octokit/rest": 19.0.11 byte-size: 8.1.1 chalk: 4.1.0 clone-deep: 4.0.1 @@ -8248,8 +9067,8 @@ packages: yargs: 17.7.2 yargs-parser: 21.1.1 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' + - "@swc-node/register" + - "@swc/core" - bluebird - debug - encoding @@ -8257,16 +9076,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ== } + engines: { node: ">= 0.8.0" } dependencies: prelude-ls: 1.2.1 type-check: 0.4.0 dev: true /[email protected]: - resolution: {integrity: sha512-vHBVMw1JFMTgEk15zRsJuSAg7QtGGHpUSEfnbcRL1/gTBag9iEfJbyjpDmdJmwMhvpoLoNBtdAUCdGnaP32hhw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-vHBVMw1JFMTgEk15zRsJuSAg7QtGGHpUSEfnbcRL1/gTBag9iEfJbyjpDmdJmwMhvpoLoNBtdAUCdGnaP32hhw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: npm-package-arg: 10.1.0 npm-registry-fetch: 14.0.5 @@ -8275,8 +9096,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-fHUxw5VJhZCNSls0KLNEG0mCD2PN1i14gH5elGOgiVnU3VgTcRahagYP2LKI1m0tFCJ+XrAm0zVYyF5RCbXzcg==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-fHUxw5VJhZCNSls0KLNEG0mCD2PN1i14gH5elGOgiVnU3VgTcRahagYP2LKI1m0tFCJ+XrAm0zVYyF5RCbXzcg== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: ci-info: 3.8.0 normalize-package-data: 5.0.0 @@ -8291,21 +9113,25 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + resolution: + { integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== } dev: true /[email protected]: - resolution: {integrity: sha512-cNOjgCnLB+FnvWWtyRTzmB3POJ+cXxTA81LoW7u8JdmhfXzriropYwpjShnz1QLLWsQwY7nIxoDmcPTwphDK9w==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-cNOjgCnLB+FnvWWtyRTzmB3POJ+cXxTA81LoW7u8JdmhfXzriropYwpjShnz1QLLWsQwY7nIxoDmcPTwphDK9w== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-5MP0uUeVCec89ZbNOT/i97Mc+q3SxXmiUGhRFOTmhrGPn//uWVQdCvcLJDy64MSBR5MidFdOR7B9viumoavy6g==} + resolution: + { integrity: sha512-5MP0uUeVCec89ZbNOT/i97Mc+q3SxXmiUGhRFOTmhrGPn//uWVQdCvcLJDy64MSBR5MidFdOR7B9viumoavy6g== } dev: true /[email protected]: - resolution: {integrity: sha512-q7Z71n3i4X0R9xthAryBdNGVGAO2R5X+/xXpmKeuPMrteg+W2U8VusTKV3YiJbXZwKsOlFlHe+go6uSNjfxrZw==} - engines: {node: '>=8.0.0'} + resolution: + { integrity: sha512-q7Z71n3i4X0R9xthAryBdNGVGAO2R5X+/xXpmKeuPMrteg+W2U8VusTKV3YiJbXZwKsOlFlHe+go6uSNjfxrZw== } + engines: { node: ">=8.0.0" } hasBin: true dependencies: chokidar: 3.5.3 @@ -8318,8 +9144,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Kx8hMakjX03tiGTLAIdJ+lL0htKnXjEZN6hk/tozf/WOuYGdZBJrZ+rCJRbVCugsjB3jMLn9746NsQIf5VjBMw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-Kx8hMakjX03tiGTLAIdJ+lL0htKnXjEZN6hk/tozf/WOuYGdZBJrZ+rCJRbVCugsjB3jMLn9746NsQIf5VjBMw== } + engines: { node: ">=4" } dependencies: graceful-fs: 4.2.11 parse-json: 4.0.0 @@ -8328,8 +9155,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-gUD/epcRms75Cw8RT1pUdHugZYM5ce64ucs2GEISABwkRsOQr0q2wm/MV2TKThycIe5e0ytRweW2RZxclogCdQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-gUD/epcRms75Cw8RT1pUdHugZYM5ce64ucs2GEISABwkRsOQr0q2wm/MV2TKThycIe5e0ytRweW2RZxclogCdQ== } + engines: { node: ">=8" } dependencies: graceful-fs: 4.2.11 parse-json: 5.2.0 @@ -8338,108 +9166,129 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==} - engines: {node: '>=6.11.5'} + resolution: + { integrity: sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg== } + engines: { node: ">=6.11.5" } dev: true /[email protected]: - resolution: {integrity: sha512-NCI2kiDkyR7VeEKm27Kda/iQHyKJe1Bu0FlTbYp3CqJu+9IFe9bLyAjMxf5ZDDbEg+iMPzB5zYyUTSm8wVTKmA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-NCI2kiDkyR7VeEKm27Kda/iQHyKJe1Bu0FlTbYp3CqJu+9IFe9bLyAjMxf5ZDDbEg+iMPzB5zYyUTSm8wVTKmA== } + engines: { node: ">=4" } dependencies: p-locate: 2.0.0 path-exists: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== } + engines: { node: ">=8" } dependencies: p-locate: 4.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw== } + engines: { node: ">=10" } dependencies: p-locate: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dependencies: p-locate: 6.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA==} + resolution: + { integrity: sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA== } dev: true /[email protected]: - resolution: {integrity: sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==} + resolution: + { integrity: sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow== } dev: true /[email protected]: - resolution: {integrity: sha512-uHaJFihxmJcEX3kT4I23ABqKKalJ/zDrDg0lsFtc1h+3uw49SIJ5beyhx5ExVRti3AvKoOJngIj7xz3oylPdWQ==} + resolution: + { integrity: sha512-uHaJFihxmJcEX3kT4I23ABqKKalJ/zDrDg0lsFtc1h+3uw49SIJ5beyhx5ExVRti3AvKoOJngIj7xz3oylPdWQ== } dev: true /[email protected]: - resolution: {integrity: sha512-AirXNj15uRIMMPihnkInB4i3NHeb4iBtNg9WRWuK2o31S+ePwwNmDPaTL3o7dTJ+VXNZim7rFs4rxN4YU1oUJw==} + resolution: + { integrity: sha512-AirXNj15uRIMMPihnkInB4i3NHeb4iBtNg9WRWuK2o31S+ePwwNmDPaTL3o7dTJ+VXNZim7rFs4rxN4YU1oUJw== } dev: true /[email protected]: - resolution: {integrity: sha512-fPMfXjGQEV9Xsq/8MTSgUf255gawYRbjwMyDbcvDhXgV7enSZA0hynz6vMPnpAb5iONEzBHBPsT+0zes5Z301g==} + resolution: + { integrity: sha512-fPMfXjGQEV9Xsq/8MTSgUf255gawYRbjwMyDbcvDhXgV7enSZA0hynz6vMPnpAb5iONEzBHBPsT+0zes5Z301g== } dev: true /[email protected]: - resolution: {integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA==} + resolution: + { integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA== } dev: true /[email protected]: - resolution: {integrity: sha512-N8XRTIMMqqDgSy4VLKPnJ/+hpGZN+PHQiJnSenYqPaVV/NCqEogTnAdZLQiGKhxX+JCs8waWq2t1XHWKOmlY8g==} + resolution: + { integrity: sha512-N8XRTIMMqqDgSy4VLKPnJ/+hpGZN+PHQiJnSenYqPaVV/NCqEogTnAdZLQiGKhxX+JCs8waWq2t1XHWKOmlY8g== } dev: true /[email protected]: - resolution: {integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==} + resolution: + { integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ== } dev: true /[email protected]: - resolution: {integrity: sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==} + resolution: + { integrity: sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ== } dev: true /[email protected]: - resolution: {integrity: sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==} + resolution: + { integrity: sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw== } dev: true /[email protected]: - resolution: {integrity: sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg==} + resolution: + { integrity: sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg== } dev: true /[email protected]: - resolution: {integrity: sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==} + resolution: + { integrity: sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ== } dev: true /[email protected]: - resolution: {integrity: sha512-sReKOYJIJf74dhJONhU4e0/shzi1trVbSWDOhKYE5XV2O+H7Sb2Dihwuc7xWxVl+DgFPyTqIN3zMfT9cq5iWDg==} + resolution: + { integrity: sha512-sReKOYJIJf74dhJONhU4e0/shzi1trVbSWDOhKYE5XV2O+H7Sb2Dihwuc7xWxVl+DgFPyTqIN3zMfT9cq5iWDg== } dev: true /[email protected]: - resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} + resolution: + { integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== } dev: true /[email protected]: - resolution: {integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg== } + engines: { node: ">=10" } dependencies: chalk: 4.1.2 is-unicode-supported: 0.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-9FyqAm9o9NKKfiAKfZoYo9bGXXuwMkxQiQttkT4YjjVtQVIQtK6LmVtlxmCaFswo6N4AfEkHqZTV0taDtPotNg==} + resolution: + { integrity: sha512-9FyqAm9o9NKKfiAKfZoYo9bGXXuwMkxQiQttkT4YjjVtQVIQtK6LmVtlxmCaFswo6N4AfEkHqZTV0taDtPotNg== } dependencies: - '@colors/colors': 1.5.0 - '@types/triple-beam': 1.3.2 + "@colors/colors": 1.5.0 + "@types/triple-beam": 1.3.2 fecha: 4.2.3 ms: 2.1.3 safe-stable-stringify: 2.4.3 @@ -8447,84 +9296,98 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-k2Gmn8iV6qdME3ztZC2spubmQISimFOPLuQKiPaLcVdRz0IpdxrNClVepMlyTJlhodm/zG/VfbkWERm3kUIh+Q==} - engines: {npm: '>=6.13.4'} + resolution: + { integrity: sha512-k2Gmn8iV6qdME3ztZC2spubmQISimFOPLuQKiPaLcVdRz0IpdxrNClVepMlyTJlhodm/zG/VfbkWERm3kUIh+Q== } + engines: { npm: ">=6.13.4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-RaPMZKiMy8/JruncMU5Bt6na1eftNoo++R4Y+N2FrxkDVTrGvcyzFTsaGif4QTeKESheMGegbhw6iUAq+5A8zA==} + resolution: + { integrity: sha512-RaPMZKiMy8/JruncMU5Bt6na1eftNoo++R4Y+N2FrxkDVTrGvcyzFTsaGif4QTeKESheMGegbhw6iUAq+5A8zA== } dependencies: get-func-name: 2.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==} + resolution: + { integrity: sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg== } dependencies: tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-svTf/fzsKHffP42sujkO/Rjs37BCIsQVRCeNYIm9WN8rgT7ffoUnRtZCqU+6BqcSBdv8gwJeTz8knJpgACeQMw==} - engines: {node: 14 \|\| >=16.14} + resolution: + { integrity: sha512-svTf/fzsKHffP42sujkO/Rjs37BCIsQVRCeNYIm9WN8rgT7ffoUnRtZCqU+6BqcSBdv8gwJeTz8knJpgACeQMw== } + engines: { node: 14 \|\| >=16.14 } dev: true /[email protected]: - resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} + resolution: + { integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== } dependencies: yallist: 3.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA== } + engines: { node: ">=10" } dependencies: yallist: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + resolution: + { integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== } dev: true /[email protected]: - resolution: {integrity: sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA== } + engines: { node: ">=6" } dependencies: pify: 4.0.1 semver: 5.7.2 dev: true /[email protected]: - resolution: {integrity: sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw== } + engines: { node: ">=8" } dependencies: semver: 6.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw== } + engines: { node: ">=10" } dependencies: semver: 7.5.4 dev: true /[email protected]: - resolution: {integrity: sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==} + resolution: + { integrity: sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw== } dev: true /[email protected]: - resolution: {integrity: sha512-rLWS7GCSTcEujjVBs2YqG7Y4643u8ucvCJeSRqiLYhesrDuzeuFIk37xREzAsfQaqzl8b9rNCE4m6J8tvX4Q8w==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-rLWS7GCSTcEujjVBs2YqG7Y4643u8ucvCJeSRqiLYhesrDuzeuFIk37xREzAsfQaqzl8b9rNCE4m6J8tvX4Q8w== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: agentkeepalive: 4.3.0 cacache: 17.1.3 @@ -8546,24 +9409,28 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==} - engines: {node: '>= 12'} + resolution: + { integrity: sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A== } + engines: { node: ">= 12" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-OkeDaAZ/bQCxeFAozM55PKcKU0yJMPGifLwV4Qgjitu+5MoAfSQN4lsLJeXZ1b8w0x+/Emda6MZgXS1jvsapng==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-OkeDaAZ/bQCxeFAozM55PKcKU0yJMPGifLwV4Qgjitu+5MoAfSQN4lsLJeXZ1b8w0x+/Emda6MZgXS1jvsapng== } + engines: { node: ">=10" } requiresBuild: true dependencies: escape-string-regexp: 4.0.0 @@ -8571,20 +9438,23 @@ packages: optional: true /[email protected]: - resolution: {integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-BhXM0Au22RwUneMPwSCnyhTOizdWoIEPU9sp0Aqa1PnDMR5Wv2FGXYDjuzJEIX+Eo2Rb8xuYe5jrnm5QowQFkw==} - engines: {node: '>=16.10'} + resolution: + { integrity: sha512-BhXM0Au22RwUneMPwSCnyhTOizdWoIEPU9sp0Aqa1PnDMR5Wv2FGXYDjuzJEIX+Eo2Rb8xuYe5jrnm5QowQFkw== } + engines: { node: ">=16.10" } dev: true /[email protected]: - resolution: {integrity: sha512-r85E3NdZ+mpYk1C6RjPFEMSE+s1iZMuHtsHAqY0DT3jZczl0diWUZ8g6oU7h0M9cD2EL+PzaYghhCLzR0ZNn5Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-r85E3NdZ+mpYk1C6RjPFEMSE+s1iZMuHtsHAqY0DT3jZczl0diWUZ8g6oU7h0M9cD2EL+PzaYghhCLzR0ZNn5Q== } + engines: { node: ">=10" } dependencies: - '@types/minimist': 1.2.2 + "@types/minimist": 1.2.2 camelcase-keys: 6.2.2 decamelize-keys: 1.1.1 hard-rejection: 2.1.0 @@ -8598,80 +9468,94 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==} + resolution: + { integrity: sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w== } dev: true /[email protected]: - resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} + resolution: + { integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== } dev: true /[email protected]: - resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== } + engines: { node: ">= 8" } dev: true /[email protected]: - resolution: {integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==} - engines: {node: '>=8.6'} + resolution: + { integrity: sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== } + engines: { node: ">=8.6" } dependencies: braces: 3.0.2 picomatch: 2.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== } + engines: { node: ">= 0.6" } dependencies: mime-db: 1.52.0 dev: true /[email protected]: - resolution: {integrity: sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg== } + engines: { node: ">=4" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-wXqjST+SLt7R009ySCglWBCFpjUygmCIfD790/kVbiGmUgfYGuB14PiTd5DwVxSV4NcYHjzMkoj5LjQZwTQLEA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-wXqjST+SLt7R009ySCglWBCFpjUygmCIfD790/kVbiGmUgfYGuB14PiTd5DwVxSV4NcYHjzMkoj5LjQZwTQLEA== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-/7aNrZ7kMe43o0NQUftL/H9QBi15FYEUo7tnw0Nrcc+XsmNS6nP4cIL4iqrNzSzv1rUaHLBxpmYbETKT9dKZiQ==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-/7aNrZ7kMe43o0NQUftL/H9QBi15FYEUo7tnw0Nrcc+XsmNS6nP4cIL4iqrNzSzv1rUaHLBxpmYbETKT9dKZiQ== } + engines: { node: ">=16" } hasBin: true dependencies: - '@putout/minify': 2.6.1 + "@putout/minify": 2.6.1 clean-css: 5.3.2 css-b64-images: 0.2.5 debug: 4.3.4([email protected]) @@ -8686,48 +9570,55 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-tUpxzX0VAzJHjLu0xUfFv1gwVp9ba3IOuRAVH2EGuRW8a5emA2FlACLqiT/lDVtS1W+TGNwqz3sWaNyLgDJWuw==} + resolution: + { integrity: sha512-tUpxzX0VAzJHjLu0xUfFv1gwVp9ba3IOuRAVH2EGuRW8a5emA2FlACLqiT/lDVtS1W+TGNwqz3sWaNyLgDJWuw== } dependencies: brace-expansion: 1.1.11 dev: true /[email protected]: - resolution: {integrity: sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==} + resolution: + { integrity: sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== } dependencies: brace-expansion: 1.1.11 dev: true /[email protected]: - resolution: {integrity: sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g== } + engines: { node: ">=10" } dependencies: brace-expansion: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== } + engines: { node: ">=10" } dependencies: brace-expansion: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA== } + engines: { node: ">=16 \|\| 14 >=14.17" } dependencies: brace-expansion: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg== } + engines: { node: ">=16 \|\| 14 >=14.17" } dependencies: brace-expansion: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A== } + engines: { node: ">= 6" } dependencies: arrify: 1.0.1 is-plain-obj: 1.1.0 @@ -8735,19 +9626,22 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} + resolution: + { integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== } dev: true /[email protected]: - resolution: {integrity: sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA== } + engines: { node: ">= 8" } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-n5ITsTkDqYkYJZjcRWzZt9qnZKCT7nKCosJhHoj7S7zD+BP4jVbWs+odsniw5TA3E0sLomhTKOKjF86wf11PuQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-n5ITsTkDqYkYJZjcRWzZt9qnZKCT7nKCosJhHoj7S7zD+BP4jVbWs+odsniw5TA3E0sLomhTKOKjF86wf11PuQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: minipass: 5.0.0 minipass-sized: 1.0.3 @@ -8757,76 +9651,88 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw== } + engines: { node: ">= 8" } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg==} + resolution: + { integrity: sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg== } dependencies: jsonparse: 1.3.1 minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A== } + engines: { node: ">=8" } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g== } + engines: { node: ">=8" } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw== } + engines: { node: ">=8" } dependencies: yallist: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-fNzuVyifolSLFL4NzpF+wEF4qrgqaaKX0haXPQEdQ7NKAN+WecoKMHV09YcuL/DHxrUsYQOK3MiuDf7Ip2OXfQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-fNzuVyifolSLFL4NzpF+wEF4qrgqaaKX0haXPQEdQ7NKAN+WecoKMHV09YcuL/DHxrUsYQOK3MiuDf7Ip2OXfQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-MzWSV5nYVT7mVyWCwn2o7JH13w2TBRmmSqSRCKzTw+lmft9X4z+3wjvs06Tzijo5z4W/kahUCDpRXTF+ZrmF/w==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-MzWSV5nYVT7mVyWCwn2o7JH13w2TBRmmSqSRCKzTw+lmft9X4z+3wjvs06Tzijo5z4W/kahUCDpRXTF+ZrmF/w== } + engines: { node: ">=16 \|\| 14 >=14.17" } dev: true /[email protected]: - resolution: {integrity: sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg== } + engines: { node: ">= 8" } dependencies: minipass: 3.3.6 yallist: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== } + engines: { node: ">=10" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-Mk9qDrvU44UUL0EBhbAA1phfQZ7aMZPjwtL7wkpiBzGh8dETGqfsh50mWoX9EkjDlkONlErWXArHCKfoxVg0Bw==} + resolution: + { integrity: sha512-Mk9qDrvU44UUL0EBhbAA1phfQZ7aMZPjwtL7wkpiBzGh8dETGqfsh50mWoX9EkjDlkONlErWXArHCKfoxVg0Bw== } dev: true /[email protected]: - resolution: {integrity: sha512-IDY7fl/BecMwFHzoqF2sg/SHHANeBoMMXFlS9r0OXKDssYE1M5O43wUY/9BVPeIvfH2zmEbBfseqN9gBQZzXkg==} - engines: {node: '>= 14.0.0'} + resolution: + { integrity: sha512-IDY7fl/BecMwFHzoqF2sg/SHHANeBoMMXFlS9r0OXKDssYE1M5O43wUY/9BVPeIvfH2zmEbBfseqN9gBQZzXkg== } + engines: { node: ">= 14.0.0" } hasBin: true dependencies: ansi-colors: 4.1.1 @@ -8853,32 +9759,38 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-hzzEagAgDyoU1Q6yg5uI+AorQgdvMCur3FcKf7NhMKWsaYg+RnbTyHRa/9IlLF9rf455MOCtcqqrQQ83pPP7Uw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-hzzEagAgDyoU1Q6yg5uI+AorQgdvMCur3FcKf7NhMKWsaYg+RnbTyHRa/9IlLF9rf455MOCtcqqrQQ83pPP7Uw== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==} + resolution: + { integrity: sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A== } dev: true /[email protected]: - resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==} + resolution: + { integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== } dev: true /[email protected]: - resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} + resolution: + { integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== } dev: true /[email protected]: - resolution: {integrity: sha512-ypMKuglUrZUD99Tk2bUQ+xNQj43lPEfAeX2o9cTteAmShXy2VHDJpuwu1o0xqoKCt9jLVAvwyFKdLTPXKAfJyA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-ypMKuglUrZUD99Tk2bUQ+xNQj43lPEfAeX2o9cTteAmShXy2VHDJpuwu1o0xqoKCt9jLVAvwyFKdLTPXKAfJyA== } + engines: { node: ">=10" } dependencies: - '@types/minimatch': 3.0.5 + "@types/minimatch": 3.0.5 array-differ: 3.0.0 array-union: 2.1.0 arrify: 2.0.1 @@ -8886,47 +9798,56 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==} + resolution: + { integrity: sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA== } dev: true /[email protected]: - resolution: {integrity: sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==} + resolution: + { integrity: sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ== } dev: true /[email protected]: - resolution: {integrity: sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w==} - engines: {node: ^10 \|\| ^12 \|\| ^13.7 \|\| ^14 \|\| >=15.0.1} + resolution: + { integrity: sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w== } + engines: { node: ^10 \|\| ^12 \|\| ^13.7 \|\| ^14 \|\| >=15.0.1 } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==} + resolution: + { integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw== } dev: true /[email protected]: - resolution: {integrity: sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} + resolution: + { integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== } dev: true /[email protected]: - resolution: {integrity: sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==} + resolution: + { integrity: sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg== } dependencies: lower-case: 2.0.2 tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g==} - engines: {node: 4.x \|\| >=6.0.0} + resolution: + { integrity: sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g== } + engines: { node: 4.x \|\| >=6.0.0 } peerDependencies: encoding: ^0.1.0 peerDependenciesMeta: @@ -8937,8 +9858,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==} - engines: {node: 4.x \|\| >=6.0.0} + resolution: + { integrity: sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ== } + engines: { node: 4.x \|\| >=6.0.0 } peerDependencies: encoding: ^0.1.0 peerDependenciesMeta: @@ -8949,8 +9871,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-dMXsYP6gc9rRbejLXmTbVRYjAHw7ppswsKyMxuxJxxOHzluIO1rGp9TOQgjFJ+2MCqcOcQTOPB/8Xwhr+7s4Eg==} - engines: {node: ^12.13 \|\| ^14.13 \|\| >=16} + resolution: + { integrity: sha512-dMXsYP6gc9rRbejLXmTbVRYjAHw7ppswsKyMxuxJxxOHzluIO1rGp9TOQgjFJ+2MCqcOcQTOPB/8Xwhr+7s4Eg== } + engines: { node: ^12.13 \|\| ^14.13 \|\| >=16 } hasBin: true dependencies: env-paths: 2.2.1 @@ -8969,23 +9892,27 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-QNABxbrPa3qEIfrE6GOJ7BYIuignnJw7iQ2YPbc3Nla1HzRJjXzZOiikfF8m7eAMfichLt3M4VgLOetqgDmgGQ==} + resolution: + { integrity: sha512-QNABxbrPa3qEIfrE6GOJ7BYIuignnJw7iQ2YPbc3Nla1HzRJjXzZOiikfF8m7eAMfichLt3M4VgLOetqgDmgGQ== } dev: true /[email protected]: - resolution: {integrity: sha512-RM5oyBy45cLEoHqCeh+MNuFAxO0vTFBLskvQbOKnEE7YTTSN4tbN8QWDIPQ6L+WvKsB/qLEGpYe2ZZ9d4W9OIQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-RM5oyBy45cLEoHqCeh+MNuFAxO0vTFBLskvQbOKnEE7YTTSN4tbN8QWDIPQ6L+WvKsB/qLEGpYe2ZZ9d4W9OIQ== } + engines: { node: ">=8" } dependencies: process-on-spawn: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw==} + resolution: + { integrity: sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw== } dev: true /[email protected]: - resolution: {integrity: sha512-g9AZ7HmkhQkqXkRc20w+ZfQ73cHLbE8hnPbtaFbFtCumZsjyMhKk9LajQ07U5Ux28lvFjZ5X7HvWR1xzU8jHVw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-g9AZ7HmkhQkqXkRc20w+ZfQ73cHLbE8hnPbtaFbFtCumZsjyMhKk9LajQ07U5Ux28lvFjZ5X7HvWR1xzU8jHVw== } + engines: { node: ">=10" } hasBin: true dependencies: chokidar: 3.5.3 @@ -9001,37 +9928,42 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-lNDU9VJaOPxUmXcLb+HQFeUgQQPtMI24Gt6hgfuMHRJgMRHMF/qZ4HJD3GDru4sSw9IQl2jPjAYnQrdIeLbwow==} + resolution: + { integrity: sha512-lNDU9VJaOPxUmXcLb+HQFeUgQQPtMI24Gt6hgfuMHRJgMRHMF/qZ4HJD3GDru4sSw9IQl2jPjAYnQrdIeLbwow== } dependencies: inherits: 2.0.4 readable-stream: 1.0.34 dev: true /[email protected]: - resolution: {integrity: sha512-NWmpvLSqUrgrAC9HCuxEvb+PSloHpqVu+FqcO4eeF2h5qYRhA7ev6KvelyQAKtegUbC6RypJnlEOhd8vloNKYg==} + resolution: + { integrity: sha512-NWmpvLSqUrgrAC9HCuxEvb+PSloHpqVu+FqcO4eeF2h5qYRhA7ev6KvelyQAKtegUbC6RypJnlEOhd8vloNKYg== } hasBin: true dependencies: abbrev: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ== } + engines: { node: ">=6" } hasBin: true dependencies: abbrev: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-ZwLpbTgdhuZUnZzjd7nb1ZV+4DoiC6/sfiVKok72ym/4Tlf+DFdlHYmT2JPmcNNWV6Pi3SDf1kT+A4r9RTuT9g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-ZwLpbTgdhuZUnZzjd7nb1ZV+4DoiC6/sfiVKok72ym/4Tlf+DFdlHYmT2JPmcNNWV6Pi3SDf1kT+A4r9RTuT9g== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } hasBin: true dependencies: abbrev: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==} + resolution: + { integrity: sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA== } dependencies: hosted-git-info: 2.8.9 resolve: 1.22.8 @@ -9040,8 +9972,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA== } + engines: { node: ">=10" } dependencies: hosted-git-info: 4.1.0 is-core-module: 2.13.1 @@ -9050,8 +9983,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-h9iPVIfrVZ9wVYQnxFgtw1ugSvGEMOlyPWWtm8BMJhnwyEL/FLbYbTY3V3PpjI/BUK67n9PEWDu6eHzu1fB15Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-h9iPVIfrVZ9wVYQnxFgtw1ugSvGEMOlyPWWtm8BMJhnwyEL/FLbYbTY3V3PpjI/BUK67n9PEWDu6eHzu1fB15Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: hosted-git-info: 6.1.1 is-core-module: 2.13.1 @@ -9060,47 +9994,55 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-x5DHup0SuyQcmL3s7Rx/YQ8sbw/Hzg0rj48eN0dV7hf5cmQq5PXIeioroH3raV1QC1yh3uTYuMThvEQF3iKgGQ==} + resolution: + { integrity: sha512-x5DHup0SuyQcmL3s7Rx/YQ8sbw/Hzg0rj48eN0dV7hf5cmQq5PXIeioroH3raV1QC1yh3uTYuMThvEQF3iKgGQ== } dependencies: npm-normalize-package-bin: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-Vq0eyEQy+elFpzsKjMss9kxqb9tG3YHg4dsyWuUENuzvSUWe1TCnW/vV9FkhvBk/brEDoDiVd+M1Btosa6ImdQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-Vq0eyEQy+elFpzsKjMss9kxqb9tG3YHg4dsyWuUENuzvSUWe1TCnW/vV9FkhvBk/brEDoDiVd+M1Btosa6ImdQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: npm-normalize-package-bin: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-dH3GmQL4vsPtld59cOn8uY0iOqRmqKvV+DLGwNXV/Q7MDgD2QfOADWd/mFXcIE5LVhYYGjA3baz6W9JneqnuCw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-dH3GmQL4vsPtld59cOn8uY0iOqRmqKvV+DLGwNXV/Q7MDgD2QfOADWd/mFXcIE5LVhYYGjA3baz6W9JneqnuCw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: semver: 7.5.4 dev: true /[email protected]: - resolution: {integrity: sha512-EPfafl6JL5/rU+ot6P3gRSCpPDW5VmIzX959Ob1+ySFUuuYHWHekXpwdUZcKP5C+DS4GEtdJluwBjnsNDl+fSA==} + resolution: + { integrity: sha512-EPfafl6JL5/rU+ot6P3gRSCpPDW5VmIzX959Ob1+ySFUuuYHWHekXpwdUZcKP5C+DS4GEtdJluwBjnsNDl+fSA== } dev: true /[email protected]: - resolution: {integrity: sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-uFyyCEmgBfZTtrKk/5xDfHp6+MdrqGotX/VoOyEEl3mBwiEE5FlBaePanazJSVMPT7vKepcjYBY2ztg9A3yPIA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-uFyyCEmgBfZTtrKk/5xDfHp6+MdrqGotX/VoOyEEl3mBwiEE5FlBaePanazJSVMPT7vKepcjYBY2ztg9A3yPIA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: hosted-git-info: 6.1.1 proc-log: 3.0.0 @@ -9109,8 +10051,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-CsP95FhWQDwNqiYS+Q0mZ7FAEDytDZAkNxQqea6IaAFJTAY9Lhhqyl0irU/6PMc7BGfUmnsbHcqxJD7XuVM/rg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-CsP95FhWQDwNqiYS+Q0mZ7FAEDytDZAkNxQqea6IaAFJTAY9Lhhqyl0irU/6PMc7BGfUmnsbHcqxJD7XuVM/rg== } + engines: { node: ">=10" } dependencies: hosted-git-info: 3.0.8 semver: 7.5.4 @@ -9118,8 +10061,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-UfpSvQ5YKwctmodvPPkK6Fwk603aoVsf8AEbmVKAEECrfvL8SSe1A2YIwrJ6xmTHAITKPwwZsWo7WwEbNk0kxw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-UfpSvQ5YKwctmodvPPkK6Fwk603aoVsf8AEbmVKAEECrfvL8SSe1A2YIwrJ6xmTHAITKPwwZsWo7WwEbNk0kxw== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } hasBin: true dependencies: glob: 8.1.0 @@ -9129,15 +10073,17 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-d6RGEuRrNS5/N84iglPivjaJPxhDbZmlbTwTDX2IbcRHG5bZCdtysYMhwiPvcF4GisXHGn7xsxv+GQ7T/02M5Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-d6RGEuRrNS5/N84iglPivjaJPxhDbZmlbTwTDX2IbcRHG5bZCdtysYMhwiPvcF4GisXHGn7xsxv+GQ7T/02M5Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: ignore-walk: 6.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-mRtvlBjTsJvfCCdmPtiu2bdlx8d/KXtF7yNXNWe7G0Z36qWA9Ny5zXsI2PfBZEv7SXgoxTmNaTzGSbbzDZChoA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-mRtvlBjTsJvfCCdmPtiu2bdlx8d/KXtF7yNXNWe7G0Z36qWA9Ny5zXsI2PfBZEv7SXgoxTmNaTzGSbbzDZChoA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: npm-install-checks: 6.1.1 npm-normalize-package-bin: 3.0.1 @@ -9146,8 +10092,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-kIDMIo4aBm6xg7jOttupWZamsZRkAqMqwqqbVXnUqstY5+tapvv6bkH/qMR76jdgV+YljEUCyWx3hRYMrJiAgA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-kIDMIo4aBm6xg7jOttupWZamsZRkAqMqwqqbVXnUqstY5+tapvv6bkH/qMR76jdgV+YljEUCyWx3hRYMrJiAgA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: make-fetch-happen: 11.1.1 minipass: 5.0.0 @@ -9161,14 +10108,16 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== } + engines: { node: ">=8" } dependencies: path-key: 3.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-AqZtDUWOMKs1G/8lwylVjrdYgqA4d9nu8hc+0gzRxlDb1I10+FHBGMXs6aiQHFdCUUlqH99MUMuLfzWDNDtfxw==} + resolution: + { integrity: sha512-AqZtDUWOMKs1G/8lwylVjrdYgqA4d9nu8hc+0gzRxlDb1I10+FHBGMXs6aiQHFdCUUlqH99MUMuLfzWDNDtfxw== } dependencies: are-we-there-yet: 2.0.0 console-control-strings: 1.1.0 @@ -9177,8 +10126,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } dependencies: are-we-there-yet: 3.0.1 console-control-strings: 1.1.0 @@ -9187,14 +10137,16 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ub5E4+FBPKwAZx0UwIQOjYWGHTEq5sPqHQNRN8Z9e4A7u3Tj1weLJsL59yH9vmvqEtBHaOmT6cYQKIZOxp35FQ==} + resolution: + { integrity: sha512-ub5E4+FBPKwAZx0UwIQOjYWGHTEq5sPqHQNRN8Z9e4A7u3Tj1weLJsL59yH9vmvqEtBHaOmT6cYQKIZOxp35FQ== } dev: true /[email protected]: - resolution: {integrity: sha512-1t1Ii9gojl8r/8hFGaZ/ZyYR0Cb0hzvXLCsaFuvg+EJEFdvua3P4cfNya/0bdRrm+7Eb/ITUOskbvYq4TSlyGg==} + resolution: + { integrity: sha512-1t1Ii9gojl8r/8hFGaZ/ZyYR0Cb0hzvXLCsaFuvg+EJEFdvua3P4cfNya/0bdRrm+7Eb/ITUOskbvYq4TSlyGg== } hasBin: true dependencies: - '@nrwl/nx-cloud': 16.5.2 + "@nrwl/nx-cloud": 16.5.2 axios: 1.1.3 chalk: 4.1.2 dotenv: 10.0.0 @@ -9209,22 +10161,23 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-6LYoTt01nS1d/dvvYtRs+pEAMQmUVsd2fr/a8+X1cDjWrb8wsf1O3DwlBTqKOXOazpS3eOr0Ukc9N1svbu7uXA==} + resolution: + { integrity: sha512-6LYoTt01nS1d/dvvYtRs+pEAMQmUVsd2fr/a8+X1cDjWrb8wsf1O3DwlBTqKOXOazpS3eOr0Ukc9N1svbu7uXA== } hasBin: true requiresBuild: true peerDependencies: - '@swc-node/register': ^1.6.7 - '@swc/core': ^1.3.85 + "@swc-node/register": ^1.6.7 + "@swc/core": ^1.3.85 peerDependenciesMeta: - '@swc-node/register': + "@swc-node/register": optional: true - '@swc/core': + "@swc/core": optional: true dependencies: - '@nrwl/tao': 17.1.3 - '@yarnpkg/lockfile': 1.1.0 - '@yarnpkg/parsers': 3.0.0-rc.46 - '@zkochan/js-yaml': 0.0.6 + "@nrwl/tao": 17.1.3 + "@yarnpkg/lockfile": 1.1.0 + "@yarnpkg/parsers": 3.0.0-rc.46 + "@zkochan/js-yaml": 0.0.6 axios: 1.5.1 chalk: 4.1.2 cli-cursor: 3.1.0 @@ -9257,27 +10210,28 @@ packages: yargs: 17.7.2 yargs-parser: 21.1.1 optionalDependencies: - '@nx/nx-darwin-arm64': 17.1.3 - '@nx/nx-darwin-x64': 17.1.3 - '@nx/nx-freebsd-x64': 17.1.3 - '@nx/nx-linux-arm-gnueabihf': 17.1.3 - '@nx/nx-linux-arm64-gnu': 17.1.3 - '@nx/nx-linux-arm64-musl': 17.1.3 - '@nx/nx-linux-x64-gnu': 17.1.3 - '@nx/nx-linux-x64-musl': 17.1.3 - '@nx/nx-win32-arm64-msvc': 17.1.3 - '@nx/nx-win32-x64-msvc': 17.1.3 + "@nx/nx-darwin-arm64": 17.1.3 + "@nx/nx-darwin-x64": 17.1.3 + "@nx/nx-freebsd-x64": 17.1.3 + "@nx/nx-linux-arm-gnueabihf": 17.1.3 + "@nx/nx-linux-arm64-gnu": 17.1.3 + "@nx/nx-linux-arm64-musl": 17.1.3 + "@nx/nx-linux-x64-gnu": 17.1.3 + "@nx/nx-linux-x64-musl": 17.1.3 + "@nx/nx-win32-arm64-msvc": 17.1.3 + "@nx/nx-win32-x64-msvc": 17.1.3 transitivePeerDependencies: - debug dev: true /[email protected]: - resolution: {integrity: sha512-jMW04n9SxKdKi1ZMGhvUTHBN0EICCRkHemEoE5jm6mTYcqcdas0ATzgUgejlQUHMvpnOZqGB5Xxsv9KxJW1j8A==} - engines: {node: '>=8.9'} + resolution: + { integrity: sha512-jMW04n9SxKdKi1ZMGhvUTHBN0EICCRkHemEoE5jm6mTYcqcdas0ATzgUgejlQUHMvpnOZqGB5Xxsv9KxJW1j8A== } + engines: { node: ">=8.9" } hasBin: true dependencies: - '@istanbuljs/load-nyc-config': 1.1.0 - '@istanbuljs/schema': 0.1.3 + "@istanbuljs/load-nyc-config": 1.1.0 + "@istanbuljs/schema": 0.1.3 caching-transform: 4.0.0 convert-source-map: 1.9.0 decamelize: 1.2.0 @@ -9308,26 +10262,31 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==} + resolution: + { integrity: sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g== } dev: true /[email protected]: - resolution: {integrity: sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==} + resolution: + { integrity: sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ== } dev: true /[email protected]: - resolution: {integrity: sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-1mxKf0e58bvyjSCtKYY4sRe9itRk3PJpquJOjeIkz885CczcI4IvJJDLPS72oowuSh+pBxUFROpX+TU++hxhZQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-1mxKf0e58bvyjSCtKYY4sRe9itRk3PJpquJOjeIkz885CczcI4IvJJDLPS72oowuSh+pBxUFROpX+TU++hxhZQ== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -9336,8 +10295,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-UPbPHML6sL8PI/mOqPwsH4G6iyXcCGzLin8KvEPenOZN5lpCNBZZQ+V62vdjB1mQHrmqGQt5/OJzemUA+KJmEA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-UPbPHML6sL8PI/mOqPwsH4G6iyXcCGzLin8KvEPenOZN5lpCNBZZQ+V62vdjB1mQHrmqGQt5/OJzemUA+KJmEA== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -9345,7 +10305,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-HqaQtqLnp/8Bn4GL16cj+CUYbnpe1bh0TtEaWvybszDG4tgxCJuRpV8VGuvNaI1fAnI4lUJzDG55MXcOH4JZcQ==} + resolution: + { integrity: sha512-HqaQtqLnp/8Bn4GL16cj+CUYbnpe1bh0TtEaWvybszDG4tgxCJuRpV8VGuvNaI1fAnI4lUJzDG55MXcOH4JZcQ== } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -9354,8 +10315,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-aU6xnDFYT3x17e/f0IiiwlGPTy2jzMySGfUB4fq6z7CV8l85CWHDk5ErhyhpfDHhrOMwGFhSQkhMGHaIotA6Ng==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-aU6xnDFYT3x17e/f0IiiwlGPTy2jzMySGfUB4fq6z7CV8l85CWHDk5ErhyhpfDHhrOMwGFhSQkhMGHaIotA6Ng== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -9363,34 +10325,39 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== } + engines: { node: ">= 0.8" } dependencies: ee-first: 1.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} + resolution: + { integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== } dependencies: wrappy: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==} + resolution: + { integrity: sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g== } dependencies: fn.name: 1.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== } + engines: { node: ">=6" } dependencies: mimic-fn: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ== } + engines: { node: ">=12" } dependencies: define-lazy-prop: 2.0.0 is-docker: 2.2.1 @@ -9398,15 +10365,17 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==} + resolution: + { integrity: sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg== } + engines: { node: ">= 0.8.0" } dependencies: - '@aashutoshrathi/word-wrap': 1.2.6 + "@aashutoshrathi/word-wrap": 1.2.6 deep-is: 0.1.4 fast-levenshtein: 2.0.6 levn: 0.4.1 @@ -9415,12 +10384,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-k41FwbcLnlgnFh69f4qdUfvDQ+5vaSDnVPFI/y5XuhKRq97EnVVneO9F1ESVCdiVu4fCS2L8usX3mU331hB7pg==} + resolution: + { integrity: sha512-k41FwbcLnlgnFh69f4qdUfvDQ+5vaSDnVPFI/y5XuhKRq97EnVVneO9F1ESVCdiVu4fCS2L8usX3mU331hB7pg== } dev: true /[email protected]: - resolution: {integrity: sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ== } + engines: { node: ">=10" } dependencies: bl: 4.1.0 chalk: 4.1.2 @@ -9434,140 +10405,162 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-BZOr3nRQHOntUjTrH8+Lh54smKHoHyur8We1V8DSMVrl5A2malOOwuJRnKRDjSnkoeBh4at6BwEnb5I7Jl31wg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-BZOr3nRQHOntUjTrH8+Lh54smKHoHyur8We1V8DSMVrl5A2malOOwuJRnKRDjSnkoeBh4at6BwEnb5I7Jl31wg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q== } + engines: { node: ">=4" } dependencies: p-try: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== } + engines: { node: ">=6" } dependencies: p-try: 2.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ== } + engines: { node: ">=10" } dependencies: yocto-queue: 0.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dependencies: yocto-queue: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-nQja7m7gSKuewoVRen45CtVfODR3crN3goVQ0DDZ9N3yHxgpkuBhZqsaiotSQRrADUrne346peY7kT3TSACykg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-nQja7m7gSKuewoVRen45CtVfODR3crN3goVQ0DDZ9N3yHxgpkuBhZqsaiotSQRrADUrne346peY7kT3TSACykg== } + engines: { node: ">=4" } dependencies: p-limit: 1.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== } + engines: { node: ">=8" } dependencies: p-limit: 2.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw== } + engines: { node: ">=10" } dependencies: p-limit: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dependencies: p-limit: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-RpYIIK1zXSNEOdwxcfe7FdvGcs7+y5n8rifMhMNWvaxRNMPINJHF5GDeuVxWqnfrcHPSCnp7Oo5yNXHId9Av2Q==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-RpYIIK1zXSNEOdwxcfe7FdvGcs7+y5n8rifMhMNWvaxRNMPINJHF5GDeuVxWqnfrcHPSCnp7Oo5yNXHId9Av2Q== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-d3qXVTF/s+W+CdJ5A29wywV2n8CQQYahlgz2bFiA+4eVNJbHJodPZ+/gXwPGh0bOqA+j8S+6+ckmvLGPk1QpxQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-d3qXVTF/s+W+CdJ5A29wywV2n8CQQYahlgz2bFiA+4eVNJbHJodPZ+/gXwPGh0bOqA+j8S+6+ckmvLGPk1QpxQ== } + engines: { node: ">=8" } dependencies: aggregate-error: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== } + engines: { node: ">=10" } dependencies: aggregate-error: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-08pj8ATpzMR0Y80x50yJHn37NF6vjrqHutASaX5LiH5npS9XPvrUmscd9MF5R4fuYRHOxQR1FfMIlF7AzwoPqw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-08pj8ATpzMR0Y80x50yJHn37NF6vjrqHutASaX5LiH5npS9XPvrUmscd9MF5R4fuYRHOxQR1FfMIlF7AzwoPqw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ== } + engines: { node: ">=8" } dependencies: eventemitter3: 4.0.7 p-timeout: 3.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-2USApvnsutq8uoxZBGbbWM0JIYLiEMJ9RlaN7fAzVNb9OZN0SHjjTTfIcb667XynS5Y1VhwDJVDa72TnPzAYWw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-2USApvnsutq8uoxZBGbbWM0JIYLiEMJ9RlaN7fAzVNb9OZN0SHjjTTfIcb667XynS5Y1VhwDJVDa72TnPzAYWw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg== } + engines: { node: ">=8" } dependencies: p-finally: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-U1etNYuMJoIz3ZXSrrySFjsXQTWOx2/jdi86L+2pRvph/qMKL6sbcCYdH23fqsbm8TH2Gn0OybpT4eSFlCVHww==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-U1etNYuMJoIz3ZXSrrySFjsXQTWOx2/jdi86L+2pRvph/qMKL6sbcCYdH23fqsbm8TH2Gn0OybpT4eSFlCVHww== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-RRTnDb2TBG/epPRI2yYXsimO0v3BXC8Yd3ogr1545IaqKK17VGhbWVeGGN+XfCm/08OK8635nH31c8bATkHuSw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-RRTnDb2TBG/epPRI2yYXsimO0v3BXC8Yd3ogr1545IaqKK17VGhbWVeGGN+XfCm/08OK8635nH31c8bATkHuSw== } + engines: { node: ">=8" } dependencies: p-reduce: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-whdkPIooSu/bASggZ96BWVvZTRMOFxnyUG5PnTSGKoJE2gd5mbVNmR2Nj20QFzxYYgAXpoqC+AiXzl+UMRh7zQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-whdkPIooSu/bASggZ96BWVvZTRMOFxnyUG5PnTSGKoJE2gd5mbVNmR2Nj20QFzxYYgAXpoqC+AiXzl+UMRh7zQ== } + engines: { node: ">=8" } dependencies: graceful-fs: 4.2.11 hasha: 5.2.2 @@ -9576,14 +10569,15 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-rJVZeIwHTUta23sIZgEIM62WYwbmGbThdbnkt81ravBplQv+HjyroqnLRNH2+sLJHcGZmLRmhPwACqhfTcOmnA==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-rJVZeIwHTUta23sIZgEIM62WYwbmGbThdbnkt81ravBplQv+HjyroqnLRNH2+sLJHcGZmLRmhPwACqhfTcOmnA== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } hasBin: true dependencies: - '@npmcli/git': 4.1.0 - '@npmcli/installed-package-contents': 2.0.2 - '@npmcli/promise-spawn': 6.0.2 - '@npmcli/run-script': 6.0.2 + "@npmcli/git": 4.1.0 + "@npmcli/installed-package-contents": 2.0.2 + "@npmcli/promise-spawn": 6.0.2 + "@npmcli/run-script": 6.0.2 cacache: 17.1.3 fs-minipass: 3.0.2 minipass: 5.0.0 @@ -9604,312 +10598,365 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==} + resolution: + { integrity: sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A== } dependencies: dot-case: 3.0.4 tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== } + engines: { node: ">=6" } dependencies: callsites: 3.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-aOIos8bujGN93/8Ox/jPLh7RwVnPEysynVFE+fQZyg6jKELEHwzgKdLRFHUgXJL6kylijVSBC4BvN9OmsB48Rw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-aOIos8bujGN93/8Ox/jPLh7RwVnPEysynVFE+fQZyg6jKELEHwzgKdLRFHUgXJL6kylijVSBC4BvN9OmsB48Rw== } + engines: { node: ">=4" } dependencies: error-ex: 1.3.2 json-parse-better-errors: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== } + engines: { node: ">=8" } dependencies: - '@babel/code-frame': 7.22.13 + "@babel/code-frame": 7.22.13 error-ex: 1.3.2 json-parse-even-better-errors: 2.3.1 lines-and-columns: 1.2.4 dev: true /[email protected]: - resolution: {integrity: sha512-Euf9GG8WT9CdqwuWJGdf3RkUcTBArppHABkO7Lm8IzRQp0e2r/kkFnmhu4TSK30Wcu5rVAZLmfPKSBBi9tWFog==} + resolution: + { integrity: sha512-Euf9GG8WT9CdqwuWJGdf3RkUcTBArppHABkO7Lm8IzRQp0e2r/kkFnmhu4TSK30Wcu5rVAZLmfPKSBBi9tWFog== } dependencies: protocols: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-xDvOoLU5XRrcOZvnI6b8zA6n9O9ejNk/GExuz1yBuWUGn9KA97GI6HTs6u02wKara1CeVmZhH+0TZFdWScR89w==} + resolution: + { integrity: sha512-xDvOoLU5XRrcOZvnI6b8zA6n9O9ejNk/GExuz1yBuWUGn9KA97GI6HTs6u02wKara1CeVmZhH+0TZFdWScR89w== } dependencies: parse-path: 7.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw==} + resolution: + { integrity: sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw== } dependencies: entities: 4.5.0 dev: true /[email protected]: - resolution: {integrity: sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==} + resolution: + { integrity: sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g== } dependencies: no-case: 3.0.4 tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-i73IctDr3F2W+bsOWDyyVm/lqsXO47aY9nsFZUjTT/aljSbkxHxxCoyZ9UUrM8jK0JVod+An+rl48RCsvWM+9g==} + resolution: + { integrity: sha512-i73IctDr3F2W+bsOWDyyVm/lqsXO47aY9nsFZUjTT/aljSbkxHxxCoyZ9UUrM8jK0JVod+An+rl48RCsvWM+9g== } dev: true /[email protected]: - resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==} - engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} + resolution: + { integrity: sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ== } + engines: { node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} + resolution: + { integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== } dev: true /[email protected]: - resolution: {integrity: sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==} - engines: {node: '>=16 \|\| 14 >=14.17'} + resolution: + { integrity: sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ== } + engines: { node: ">=16 \|\| 14 >=14.17" } dependencies: lru-cache: 10.0.0 minipass: 6.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==} + resolution: + { integrity: sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ== } dev: true /[email protected]: - resolution: {integrity: sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg== } + engines: { node: ">=4" } dependencies: pify: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==} + resolution: + { integrity: sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ== } dev: true /[email protected]: - resolution: {integrity: sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==} + resolution: + { integrity: sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg== } dev: true /[email protected]: - resolution: {integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==} + resolution: + { integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ== } dev: true /[email protected]: - resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==} - engines: {node: '>=8.6'} + resolution: + { integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== } + engines: { node: ">=8.6" } dev: true /[email protected]: - resolution: {integrity: sha512-FoR3TDfuLlqUvcEeK5ifpKSVVns6B4BQvc8SDF6THVMuadya6LLtji0QgUDSStw0ZR2J7I6UGi5V2V23rnPWTw==} + resolution: + { integrity: sha512-FoR3TDfuLlqUvcEeK5ifpKSVVns6B4BQvc8SDF6THVMuadya6LLtji0QgUDSStw0ZR2J7I6UGi5V2V23rnPWTw== } dev: true /[email protected]: - resolution: {integrity: sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-C3FsVNH1udSEX48gGX1xfvwTWfsYWj5U+8/uK15BGzIGrKoUpghX8hWZwa/OFnakBiiVNmBvemTJR5mcy7iPcg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-C3FsVNH1udSEX48gGX1xfvwTWfsYWj5U+8/uK15BGzIGrKoUpghX8hWZwa/OFnakBiiVNmBvemTJR5mcy7iPcg== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-eW/gHNMlxdSP6dmG6uJip6FXN0EQBwm2clYYd8Wul42Cwu/DK8HEftzsapcNdYe2MfLiIwZqsDk2RDEsTE79hA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-eW/gHNMlxdSP6dmG6uJip6FXN0EQBwm2clYYd8Wul42Cwu/DK8HEftzsapcNdYe2MfLiIwZqsDk2RDEsTE79hA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-0Gni6D4UcLTbv9c57DfxDGdr41XfgUjqWZu492f0cIGr16zDU06BWP/RAEvOuo7CQ0CNjHaLlM59YJJFm3NWlw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-0Gni6D4UcLTbv9c57DfxDGdr41XfgUjqWZu492f0cIGr16zDU06BWP/RAEvOuo7CQ0CNjHaLlM59YJJFm3NWlw== } + engines: { node: ">=0.10.0" } dependencies: pinkie: 2.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-MnUuEycAemtSaeFSjXKW/aroV7akBbY+Sv+RkyqFjgAe73F+MR0TBWKBRDkmfWq/HiFmdavfZ1G7h4SPZXaCSg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-MnUuEycAemtSaeFSjXKW/aroV7akBbY+Sv+RkyqFjgAe73F+MR0TBWKBRDkmfWq/HiFmdavfZ1G7h4SPZXaCSg== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== } + engines: { node: ">=8" } dependencies: find-up: 4.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==} - engines: {node: '>=14.16'} + resolution: + { integrity: sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA== } + engines: { node: ">=14.16" } dependencies: find-up: 6.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== } + engines: { node: ">= 0.8.0" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-xRwqy/6eMU7234W3/XFjviTn00X2JlXyiUUdpFk4R0HbLJ0QJDA1i5fLZnVQrcSrWzidrHvs1SauEpFsBDxWAQ==} + resolution: + { integrity: sha512-xRwqy/6eMU7234W3/XFjviTn00X2JlXyiUUdpFk4R0HbLJ0QJDA1i5fLZnVQrcSrWzidrHvs1SauEpFsBDxWAQ== } peerDependencies: prettier: ^3.0.0 dependencies: - '@augment-vir/common': 22.0.0 + "@augment-vir/common": 22.0.0 prettier: 3.1.0 proxy-vir: 0.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-TQLvXjq5IAibjh8EpBIkNKxO749UEWABoiIZehEPiY4GNpVdhaFKqSTu+QrlU6D2dPAfubRmtJTi4K4YkQ5eXw==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-TQLvXjq5IAibjh8EpBIkNKxO749UEWABoiIZehEPiY4GNpVdhaFKqSTu+QrlU6D2dPAfubRmtJTi4K4YkQ5eXw== } + engines: { node: ">=14" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-XH+D4n7Ey0iSR6PdAnBs99cWMZdGsdKrR33iUHQNr79w1szKTCIZDVdXuccAsHVwDBp0XeWPfNEoaxP9EZgRmQ==} - engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-XH+D4n7Ey0iSR6PdAnBs99cWMZdGsdKrR33iUHQNr79w1szKTCIZDVdXuccAsHVwDBp0XeWPfNEoaxP9EZgRmQ== } + engines: { node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0 } dependencies: - '@jest/schemas': 29.6.0 + "@jest/schemas": 29.6.0 ansi-styles: 5.2.0 react-is: 18.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-++Vn7NS4Xf9NacaU9Xq3URUuqZETPsf8L4j5/ckhaRYsfPeRyzGw+iDjFhV/Jr3uNmTvvddEJFWh5R1gRgUH8A==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-++Vn7NS4Xf9NacaU9Xq3URUuqZETPsf8L4j5/ckhaRYsfPeRyzGw+iDjFhV/Jr3uNmTvvddEJFWh5R1gRgUH8A== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==} + resolution: + { integrity: sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== } dev: true /[email protected]: - resolution: {integrity: sha512-1WsPDsUSMmZH5LeMLegqkPDrsGgsWwk1Exipy2hvB0o/F0ASzbpIctSCcZIK1ykJvtTJULEH+20WOFjMvGnCTg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-1WsPDsUSMmZH5LeMLegqkPDrsGgsWwk1Exipy2hvB0o/F0ASzbpIctSCcZIK1ykJvtTJULEH+20WOFjMvGnCTg== } + engines: { node: ">=8" } dependencies: fromentries: 1.3.2 dev: true /[email protected]: - resolution: {integrity: sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==} - engines: {node: '>=0.4.0'} + resolution: + { integrity: sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== } + engines: { node: ">=0.4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==} + resolution: + { integrity: sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g== } peerDependencies: - bluebird: '' + bluebird: "" peerDependenciesMeta: bluebird: optional: true dev: true /[email protected]: - resolution: {integrity: sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g== } + engines: { node: ">=10" } dependencies: err-code: 2.0.3 retry: 0.12.0 dev: true /[email protected]: - resolution: {integrity: sha512-nolQXZ/4L+bP/UGlkfaIujX9BKxGwmQ9OT4mOt5yvy8iK1h3wqTEJCijzGANTCCl9nWjY41juyAn2K3Q1hLLTg==} + resolution: + { integrity: sha512-nolQXZ/4L+bP/UGlkfaIujX9BKxGwmQ9OT4mOt5yvy8iK1h3wqTEJCijzGANTCCl9nWjY41juyAn2K3Q1hLLTg== } dependencies: asap: 2.0.6 dev: true /[email protected]: - resolution: {integrity: sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== } + engines: { node: ">= 6" } dependencies: kleur: 3.0.3 sisteransi: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-KQVDEubSUHGSt5xLakaToDFrSoZhStB8dXLzk2xvwR67gJktrHFvpR63oZgHyK19WKbHFLXJqCPXdVR3aBP8Ig==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-KQVDEubSUHGSt5xLakaToDFrSoZhStB8dXLzk2xvwR67gJktrHFvpR63oZgHyK19WKbHFLXJqCPXdVR3aBP8Ig== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: read: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-/XJ368cyBJ7fzLMwLKv1e4vLxOju2MNAIokcr7meSaNcVbWz/CPcW22cP04mwxOErdA5mwjA8Q6w/cdAQxVn7Q==} + resolution: + { integrity: sha512-/XJ368cyBJ7fzLMwLKv1e4vLxOju2MNAIokcr7meSaNcVbWz/CPcW22cP04mwxOErdA5mwjA8Q6w/cdAQxVn7Q== } dev: true /[email protected]: - resolution: {integrity: sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==} - engines: {node: '>= 0.10'} + resolution: + { integrity: sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg== } + engines: { node: ">= 0.10" } dependencies: forwarded: 0.2.0 ipaddr.js: 1.9.1 dev: true /[email protected]: - resolution: {integrity: sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==} + resolution: + { integrity: sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg== } dev: true /[email protected]: - resolution: {integrity: sha512-4yP9ol7cFb1lUwYyj0B1+M+EpQz7tAu7PTgHCqOQenn0abXOJ3epfS3d2e+9zTgpBfYFzutL5tD2hyFz/smXyw==} + resolution: + { integrity: sha512-4yP9ol7cFb1lUwYyj0B1+M+EpQz7tAu7PTgHCqOQenn0abXOJ3epfS3d2e+9zTgpBfYFzutL5tD2hyFz/smXyw== } dependencies: - '@augment-vir/common': 22.0.0 + "@augment-vir/common": 22.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==} + resolution: + { integrity: sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag== } dev: true /[email protected]: - resolution: {integrity: sha512-77DZwxQmxKnu3aR542U+X8FypNzbfJ+C5XQDk3uWjWxn6151aIMGthWYRXTqT1E5oJvg+ljaa2OJi+VfvCOQ8w==} + resolution: + { integrity: sha512-77DZwxQmxKnu3aR542U+X8FypNzbfJ+C5XQDk3uWjWxn6151aIMGthWYRXTqT1E5oJvg+ljaa2OJi+VfvCOQ8w== } dev: true /[email protected]: - resolution: {integrity: sha512-azINV9dUtzPMFQktvTXciNAfAuVh/L/JCl0vtPCwvOA21uZrC08K/UnmrL+SXGEVc1FwzjW62+xw5S/uaLj6cA==} + resolution: + { integrity: sha512-azINV9dUtzPMFQktvTXciNAfAuVh/L/JCl0vtPCwvOA21uZrC08K/UnmrL+SXGEVc1FwzjW62+xw5S/uaLj6cA== } dependencies: constantinople: 4.0.1 js-stringify: 1.0.2 @@ -9917,7 +10964,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-nJMhW16MbiGRiyR4miDTQMRWDgKplnHyeLvioEJYbk1RsPI3FuA3saEP8uwnTb2nTJEKBU90NFVWJBk4OU5qyg==} + resolution: + { integrity: sha512-nJMhW16MbiGRiyR4miDTQMRWDgKplnHyeLvioEJYbk1RsPI3FuA3saEP8uwnTb2nTJEKBU90NFVWJBk4OU5qyg== } dependencies: constantinople: 4.0.1 doctypes: 1.1.0 @@ -9930,11 +10978,13 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-sjiUsi9M4RAGHktC1drQfCr5C5eriu24Lfbt4s+7SykztEOwVZtbFk1RRq0tzLxcMxMYTBR+zMQaG07J/btayQ==} + resolution: + { integrity: sha512-sjiUsi9M4RAGHktC1drQfCr5C5eriu24Lfbt4s+7SykztEOwVZtbFk1RRq0tzLxcMxMYTBR+zMQaG07J/btayQ== } dev: true /[email protected]: - resolution: {integrity: sha512-yeNFtq5Yxmfz0f9z2rMXGw/8/4i1cCFecw/Q7+D0V2DdtII5UvqE12VaZ2AY7ri6o5RNXiweGH79OCq+2RQU4A==} + resolution: + { integrity: sha512-yeNFtq5Yxmfz0f9z2rMXGw/8/4i1cCFecw/Q7+D0V2DdtII5UvqE12VaZ2AY7ri6o5RNXiweGH79OCq+2RQU4A== } dependencies: constantinople: 4.0.1 jstransformer: 1.0.0 @@ -9944,7 +10994,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-0I6C62+keXlZPZkOJeVam9aBLVP2EnbeDw3An+k0/QlqdwH6rv8284nko14Na7c0TtqtogfWXcRoFE4O4Ff20w==} + resolution: + { integrity: sha512-0I6C62+keXlZPZkOJeVam9aBLVP2EnbeDw3An+k0/QlqdwH6rv8284nko14Na7c0TtqtogfWXcRoFE4O4Ff20w== } dependencies: character-parser: 2.2.0 is-expression: 4.0.0 @@ -9952,42 +11003,49 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-gjD1yzp0yxbQqnzBAdlhbgoJL5qIFJw78juN1NpTLt/mfPJ5VgC4BvkoD3G23qKzJtIIXBbcCt6FioLSFLOHdw==} + resolution: + { integrity: sha512-gjD1yzp0yxbQqnzBAdlhbgoJL5qIFJw78juN1NpTLt/mfPJ5VgC4BvkoD3G23qKzJtIIXBbcCt6FioLSFLOHdw== } dependencies: pug-error: 2.0.0 pug-walk: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-OCjTEnhLWZBvS4zni/WUMjH2YSUosnsmjGBB1An7CsKQarYSWQ0GCVyd4eQPMFJqZ8w9xgs01QdiZXKVjk92EQ==} + resolution: + { integrity: sha512-OCjTEnhLWZBvS4zni/WUMjH2YSUosnsmjGBB1An7CsKQarYSWQ0GCVyd4eQPMFJqZ8w9xgs01QdiZXKVjk92EQ== } dependencies: object-assign: 4.1.1 pug-walk: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-ukiYM/9cH6Cml+AOl5kETtM9NR3WulyVP2y4HOU45DyMim1IeP/OOiyEWRr6qk5I5klpsBnbuHpwKmTx6WURnw==} + resolution: + { integrity: sha512-ukiYM/9cH6Cml+AOl5kETtM9NR3WulyVP2y4HOU45DyMim1IeP/OOiyEWRr6qk5I5klpsBnbuHpwKmTx6WURnw== } dependencies: pug-error: 2.0.0 token-stream: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-L50zbvrQ35TkpHwv0G6aLSuueDRwc/97XdY8kL3tOT0FmhgG7UypU3VztfV/LATAvmUfYi4wNxSajhSAeNN+Kg==} + resolution: + { integrity: sha512-L50zbvrQ35TkpHwv0G6aLSuueDRwc/97XdY8kL3tOT0FmhgG7UypU3VztfV/LATAvmUfYi4wNxSajhSAeNN+Kg== } dev: true /[email protected]: - resolution: {integrity: sha512-zo8DsDpH7eTkPHCXFeAk1xZXJbyoTfdPlNR0bK7rpOMuhBYb0f5qUVCO1xlsitYd3w5FQTK7zpNVKb3rZoUrrQ==} + resolution: + { integrity: sha512-zo8DsDpH7eTkPHCXFeAk1xZXJbyoTfdPlNR0bK7rpOMuhBYb0f5qUVCO1xlsitYd3w5FQTK7zpNVKb3rZoUrrQ== } dependencies: pug-error: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-yYELe9Q5q9IQhuvqsZNwA5hfPkMJ8u92bQLIMcsMxf/VADjNtEYptU+inlufAFYcWdHlwNfZOEnOOQrZrcyJCQ==} + resolution: + { integrity: sha512-yYELe9Q5q9IQhuvqsZNwA5hfPkMJ8u92bQLIMcsMxf/VADjNtEYptU+inlufAFYcWdHlwNfZOEnOOQrZrcyJCQ== } dev: true /[email protected]: - resolution: {integrity: sha512-bp0I/hiK1D1vChHh6EfDxtndHji55XP/ZJKwsRqrz6lRia6ZC2OZbdAymlxdVFwd1L70ebrVJw4/eZ79skrIaw==} + resolution: + { integrity: sha512-bp0I/hiK1D1vChHh6EfDxtndHji55XP/ZJKwsRqrz6lRia6ZC2OZbdAymlxdVFwd1L70ebrVJw4/eZ79skrIaw== } dependencies: pug-code-gen: 3.0.2 pug-filters: 4.0.0 @@ -10000,61 +11058,72 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==} + resolution: + { integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== } dependencies: end-of-stream: 1.4.4 once: 1.4.0 dev: true /[email protected]: - resolution: {integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==} - engines: {node: '>=0.6'} + resolution: + { integrity: sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q== } + engines: { node: ">=0.6" } dependencies: side-channel: 1.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ==} + resolution: + { integrity: sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ== } dev: true /[email protected]: - resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} + resolution: + { integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== } dev: true /[email protected]: - resolution: {integrity: sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==} + resolution: + { integrity: sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ== } dependencies: safe-buffer: 5.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== } + engines: { node: ">= 0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-qqJBtEyVgS0ZmPGdCFPWJ3FreoqvG4MVQln/kCgF7Olq95IbOp0/BWyMwbdtn4VTvkM8Y7khCQ2Xgk/tcrCXig==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-qqJBtEyVgS0ZmPGdCFPWJ3FreoqvG4MVQln/kCgF7Olq95IbOp0/BWyMwbdtn4VTvkM8Y7khCQ2Xgk/tcrCXig== } + engines: { node: ">= 0.8" } dependencies: bytes: 3.1.2 http-errors: 2.0.0 @@ -10063,25 +11132,29 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w==} + resolution: + { integrity: sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w== } dev: true /[email protected]: - resolution: {integrity: sha512-yILWifhaSEEytfXI76kB9xEEiG1AiozaCJZ83A87ytjRiN+jVibXjedjCRNjoZviinhG+4UkalO3mWTd8u5O0Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-yILWifhaSEEytfXI76kB9xEEiG1AiozaCJZ83A87ytjRiN+jVibXjedjCRNjoZviinhG+4UkalO3mWTd8u5O0Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dev: true /[email protected]: - resolution: {integrity: sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: json-parse-even-better-errors: 3.0.0 npm-normalize-package-bin: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: glob: 10.3.10 json-parse-even-better-errors: 3.0.0 @@ -10090,16 +11163,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-YFzFrVvpC6frF1sz8psoHDBGF7fLPc+llq/8NB43oagqWkx8ar5zYtsTORtOjw9W2RHLpWP+zTWwBvf1bCmcSw==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-YFzFrVvpC6frF1sz8psoHDBGF7fLPc+llq/8NB43oagqWkx8ar5zYtsTORtOjw9W2RHLpWP+zTWwBvf1bCmcSw== } + engines: { node: ">=4" } dependencies: find-up: 2.1.0 read-pkg: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg== } + engines: { node: ">=8" } dependencies: find-up: 4.1.0 read-pkg: 5.2.0 @@ -10107,8 +11182,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-BLq/cCO9two+lBgiTYNqD6GdtK8s4NpaWrl6/rCO9w0TUS8oJl7cmToOZfRYllKTISY6nt1U7jQ53brmKqY6BA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-BLq/cCO9two+lBgiTYNqD6GdtK8s4NpaWrl6/rCO9w0TUS8oJl7cmToOZfRYllKTISY6nt1U7jQ53brmKqY6BA== } + engines: { node: ">=4" } dependencies: load-json-file: 4.0.0 normalize-package-data: 2.5.0 @@ -10116,24 +11192,27 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg== } + engines: { node: ">=8" } dependencies: - '@types/normalize-package-data': 2.4.1 + "@types/normalize-package-data": 2.4.1 normalize-package-data: 2.5.0 parse-json: 5.2.0 type-fest: 0.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-bvxi1QLJHcaywCAEsAk4DG3nVoqiY2Csps3qzWalhj5hFqRn1d/OixkFXtLO1PrgHUcAP0FNaSY/5GYNfENFFQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-bvxi1QLJHcaywCAEsAk4DG3nVoqiY2Csps3qzWalhj5hFqRn1d/OixkFXtLO1PrgHUcAP0FNaSY/5GYNfENFFQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: mute-stream: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-ok1qVCJuRkNmvebYikljxJA/UEsKwLl2nI1OmaqAu4/UE+h0wKCHok4XkL/gvi39OacXvw59RJUOFUkDib2rHg==} + resolution: + { integrity: sha512-ok1qVCJuRkNmvebYikljxJA/UEsKwLl2nI1OmaqAu4/UE+h0wKCHok4XkL/gvi39OacXvw59RJUOFUkDib2rHg== } dependencies: core-util-is: 1.0.3 inherits: 2.0.4 @@ -10142,7 +11221,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==} + resolution: + { integrity: sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA== } dependencies: core-util-is: 1.0.3 inherits: 2.0.4 @@ -10154,8 +11234,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==} - engines: {node: '>= 6'} + resolution: + { integrity: sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== } + engines: { node: ">= 6" } dependencies: inherits: 2.0.4 string_decoder: 1.3.0 @@ -10163,59 +11244,68 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} - engines: {node: '>=8.10.0'} + resolution: + { integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA== } + engines: { node: ">=8.10.0" } dependencies: picomatch: 2.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-PdeC9tsmLWBiL8vMhJvocq+OezQ3HhsH2HrN7YkhfYcTjQSa/iraB15A7Qvt7Xpr0Yd2rDNt6GbFwVQDg3HcAw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-PdeC9tsmLWBiL8vMhJvocq+OezQ3HhsH2HrN7YkhfYcTjQSa/iraB15A7Qvt7Xpr0Yd2rDNt6GbFwVQDg3HcAw== } + engines: { node: ">=10" } dependencies: jju: 1.4.0 try-catch: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-/vxpCXddiX8NGfGO/mTafwjq4aFa/71pvamip0++IQk3zG8cbCj0fifNPrjjF1XMXUne91jL9OoxmdykoEtifQ==} - engines: {node: '>= 10.13.0'} + resolution: + { integrity: sha512-/vxpCXddiX8NGfGO/mTafwjq4aFa/71pvamip0++IQk3zG8cbCj0fifNPrjjF1XMXUne91jL9OoxmdykoEtifQ== } + engines: { node: ">= 10.13.0" } dependencies: resolve: 1.22.3 dev: true /[email protected]: - resolution: {integrity: sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg== } + engines: { node: ">=8" } dependencies: indent-string: 4.0.0 strip-indent: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-d1VudCLoIGitcU/hEg2QqvyGZQmdC0Lf8BqdOMXGFSvJP4bNV1+XqbPQeHHLD51Jh4QJJ225dlIFvY4Ly6MXmQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-d1VudCLoIGitcU/hEg2QqvyGZQmdC0Lf8BqdOMXGFSvJP4bNV1+XqbPQeHHLD51Jh4QJJ225dlIFvY4Ly6MXmQ== } + engines: { node: ">=4" } dependencies: regenerate: 1.4.2 dev: true /[email protected]: - resolution: {integrity: sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==} + resolution: + { integrity: sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A== } dev: true /[email protected]: - resolution: {integrity: sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==} + resolution: + { integrity: sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg== } dev: true /[email protected]: - resolution: {integrity: sha512-hfMp2BoF0qOk3uc5V20ALGDS2ddjQaLrdl7xrGXvAIow7qeWRM2VA2HuCHkUKk9slq3VwEwLNK3DFBqDfPGYtg==} + resolution: + { integrity: sha512-hfMp2BoF0qOk3uc5V20ALGDS2ddjQaLrdl7xrGXvAIow7qeWRM2VA2HuCHkUKk9slq3VwEwLNK3DFBqDfPGYtg== } dependencies: - '@babel/runtime': 7.21.5 + "@babel/runtime": 7.21.5 dev: true /[email protected]: - resolution: {integrity: sha512-sy6TXMN+hnP/wMy+ISxg3krXx7BAtWVO4UouuCN/ziM9UEne0euamVNafDfvC83bRNr95y0V5iijeDQFUNpvrg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-sy6TXMN+hnP/wMy+ISxg3krXx7BAtWVO4UouuCN/ziM9UEne0euamVNafDfvC83bRNr95y0V5iijeDQFUNpvrg== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -10223,10 +11313,11 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ== } + engines: { node: ">=4" } dependencies: - '@babel/regjsgen': 0.8.0 + "@babel/regjsgen": 0.8.0 regenerate: 1.4.2 regenerate-unicode-properties: 10.1.0 regjsparser: 0.9.1 @@ -10235,79 +11326,93 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ==} + resolution: + { integrity: sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ== } hasBin: true dependencies: jsesc: 0.5.0 dev: true /[email protected]: - resolution: {integrity: sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==} - engines: {node: '>= 0.10'} + resolution: + { integrity: sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog== } + engines: { node: ">= 0.10" } dev: true /[email protected]: - resolution: {integrity: sha512-gUAyHVHPPC5wdqX/LG4LWtRYtgjxyX78oanFNTMMyFEfOqdC54s3eE82imuWKbOeqYht2CrNf64Qb8vgmmtZGA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-gUAyHVHPPC5wdqX/LG4LWtRYtgjxyX78oanFNTMMyFEfOqdC54s3eE82imuWKbOeqYht2CrNf64Qb8vgmmtZGA== } + engines: { node: ">=4" } dependencies: es6-error: 4.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==} + resolution: + { integrity: sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg== } dev: true /[email protected]: - resolution: {integrity: sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==} + resolution: + { integrity: sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ== } dev: true /[email protected]: - resolution: {integrity: sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==} + resolution: + { integrity: sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g== } dev: true /[email protected]: - resolution: {integrity: sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg== } + engines: { node: ">=8" } dependencies: resolve-from: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-zFa12V4OLtT5XUX/Q4VLvTfBf+Ok0SPc1FNGM/z9ctUdiU618qwKpWnd0CHs3+RqROfyEg/DhuHbMWYqcgljEw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-zFa12V4OLtT5XUX/Q4VLvTfBf+Ok0SPc1FNGM/z9ctUdiU618qwKpWnd0CHs3+RqROfyEg/DhuHbMWYqcgljEw== } + engines: { node: ">=8" } dependencies: global-dirs: 0.1.1 dev: true /[email protected]: - resolution: {integrity: sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==} + resolution: + { integrity: sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg== } dependencies: is-core-module: 2.13.0 path-parse: 1.0.7 dev: true /[email protected]: - resolution: {integrity: sha512-P8ur/gp/AmbEzjr729bZnLjXK5Z+4P0zhIJgBgzqRih7hL7BOukHGtSTA3ACMY467GRFz3duQsi0bDZdR7DKdw==} + resolution: + { integrity: sha512-P8ur/gp/AmbEzjr729bZnLjXK5Z+4P0zhIJgBgzqRih7hL7BOukHGtSTA3ACMY467GRFz3duQsi0bDZdR7DKdw== } hasBin: true dependencies: is-core-module: 2.13.0 @@ -10316,7 +11421,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==} + resolution: + { integrity: sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw== } hasBin: true dependencies: is-core-module: 2.13.1 @@ -10325,55 +11431,63 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-4gl03wn3hj1HP3yzgdI7d3lCkF95F21Pz4BPGvKHinyQzALR5CapwC8yIi0Rh58DEMQ/SguC03wFj2k0M/mHhw==} + resolution: + { integrity: sha512-4gl03wn3hj1HP3yzgdI7d3lCkF95F21Pz4BPGvKHinyQzALR5CapwC8yIi0Rh58DEMQ/SguC03wFj2k0M/mHhw== } dependencies: lowercase-keys: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA== } + engines: { node: ">=8" } dependencies: onetime: 5.1.2 signal-exit: 3.0.7 dev: true /[email protected]: - resolution: {integrity: sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==} - engines: {node: '>= 4'} + resolution: + { integrity: sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow== } + engines: { node: ">= 4" } dev: true /[email protected]: - resolution: {integrity: sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==} - engines: {iojs: '>=1.0.0', node: '>=0.10.0'} + resolution: + { integrity: sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== } + engines: { iojs: ">=1.0.0", node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} + resolution: + { integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== } hasBin: true dependencies: glob: 7.2.3 dev: true /[email protected]: - resolution: {integrity: sha512-Gk8NlF062+T9CqNGn6h4tls3k6T1+/nXdOcSZVikNVtlRdYpA7wRJJMoXmuvOnLW844rPjdQ7JgXCYM6PPC/og==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-Gk8NlF062+T9CqNGn6h4tls3k6T1+/nXdOcSZVikNVtlRdYpA7wRJJMoXmuvOnLW844rPjdQ7JgXCYM6PPC/og== } + engines: { node: ">=14" } hasBin: true dependencies: glob: 9.3.5 dev: true /[email protected]: - resolution: {integrity: sha512-CqDakW+hMe/Bz202FPEymy68P+G50RfMQK+Qo5YUqc9SPipvbGjCGKd0RSKEelbsfQuw3g5NZDSrlZZAJurH1A==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-CqDakW+hMe/Bz202FPEymy68P+G50RfMQK+Qo5YUqc9SPipvbGjCGKd0RSKEelbsfQuw3g5NZDSrlZZAJurH1A== } + engines: { node: ">=14" } hasBin: true dependencies: glob: 10.3.10 dev: true /[email protected]: - resolution: {integrity: sha512-CHhPh+UNHD2GTXNYhPWLnU8ONHdI+5DI+4EYIAOaiD63rHeYlZvyh8P+in5999TTSFgUYuKUAjzRI4mdh/p+2A==} - engines: {node: '>=8.0'} + resolution: + { integrity: sha512-CHhPh+UNHD2GTXNYhPWLnU8ONHdI+5DI+4EYIAOaiD63rHeYlZvyh8P+in5999TTSFgUYuKUAjzRI4mdh/p+2A== } + engines: { node: ">=8.0" } requiresBuild: true dependencies: boolean: 3.2.0 @@ -10386,37 +11500,43 @@ packages: optional: true /[email protected]: - resolution: {integrity: sha512-APM0Gt1KoXBz0iIkkdB/kfvGOwC4UuJFeG/c+yV7wSc7q96cG/kJ0HiYCnzivD9SB53cLV1MlHFNfOuPaadYSw==} + resolution: + { integrity: sha512-APM0Gt1KoXBz0iIkkdB/kfvGOwC4UuJFeG/c+yV7wSc7q96cG/kJ0HiYCnzivD9SB53cLV1MlHFNfOuPaadYSw== } dev: true /[email protected]: - resolution: {integrity: sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==} - engines: {node: '>=0.12.0'} + resolution: + { integrity: sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ== } + engines: { node: ">=0.12.0" } dev: true /[email protected]: - resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} + resolution: + { integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== } dependencies: queue-microtask: 1.2.3 dev: true /[email protected]: - resolution: {integrity: sha512-nJrck8ekwrfilGPgGREZlNDR8US7Q+aVMWAWGKxyeeEf0X8TrPM9x5aGvHiPPsGszteUfZrABepByxgHCSWbag==} + resolution: + { integrity: sha512-nJrck8ekwrfilGPgGREZlNDR8US7Q+aVMWAWGKxyeeEf0X8TrPM9x5aGvHiPPsGszteUfZrABepByxgHCSWbag== } dependencies: - '@augment-vir/common': 22.0.0 + "@augment-vir/common": 22.0.0 expect-type: 0.15.0 type-fest: 4.8.1 dev: true /[email protected]: - resolution: {integrity: sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==} + resolution: + { integrity: sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg== } dependencies: tslib: 2.6.0 dev: true /[email protected]: - resolution: {integrity: sha512-6XbUAseYE2KtOuGueyeobCySj9L4+66Tn6KQMOPQJrAJEowYKW/YR/MGJZl7FdydUdaFu4LYyDZjxf4/Nmo23Q==} - engines: {node: '>=0.4'} + resolution: + { integrity: sha512-6XbUAseYE2KtOuGueyeobCySj9L4+66Tn6KQMOPQJrAJEowYKW/YR/MGJZl7FdydUdaFu4LYyDZjxf4/Nmo23Q== } + engines: { node: ">=0.4" } dependencies: call-bind: 1.0.5 get-intrinsic: 1.2.2 @@ -10425,15 +11545,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==} + resolution: + { integrity: sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== } dev: true /[email protected]: - resolution: {integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==} + resolution: + { integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== } dev: true /[email protected]: - resolution: {integrity: sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA==} + resolution: + { integrity: sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA== } dependencies: call-bind: 1.0.5 get-intrinsic: 1.2.2 @@ -10441,17 +11564,20 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-e2bDA2WJT0wxseVd4lsDP4+3ONX6HpMXQa1ZhFQ7SU+GjvORCmShbCMltrtIDfkYhVHrOcPtj+KhmDBdPdZD1g==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-e2bDA2WJT0wxseVd4lsDP4+3ONX6HpMXQa1ZhFQ7SU+GjvORCmShbCMltrtIDfkYhVHrOcPtj+KhmDBdPdZD1g== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==} + resolution: + { integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== } dev: true /[email protected]: - resolution: {integrity: sha512-qg2+UCJibLr2LCVOt3OlPhr/dqVHWOa9XtZf2OjbLs/T4VPSJ00udtgJxH3neXZm+QqX8B+3cU7RaLqp1iVfcQ==} - engines: {node: '>=14.0.0'} + resolution: + { integrity: sha512-qg2+UCJibLr2LCVOt3OlPhr/dqVHWOa9XtZf2OjbLs/T4VPSJ00udtgJxH3neXZm+QqX8B+3cU7RaLqp1iVfcQ== } + engines: { node: ">=14.0.0" } hasBin: true dependencies: chokidar: 3.5.3 @@ -10460,70 +11586,80 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA==} + resolution: + { integrity: sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA== } dev: true /[email protected]: - resolution: {integrity: sha512-xAg7SOnEhrm5zI3puOOKyy1OMcMlIJZYNJY7xLBwSze0UjhPLnWfj2GF2EpT0jmzaJKIWKHLsaSSajf35bcYnA==} - engines: {node: '>=v12.22.7'} + resolution: + { integrity: sha512-xAg7SOnEhrm5zI3puOOKyy1OMcMlIJZYNJY7xLBwSze0UjhPLnWfj2GF2EpT0jmzaJKIWKHLsaSSajf35bcYnA== } + engines: { node: ">=v12.22.7" } dependencies: xmlchars: 2.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==} - engines: {node: '>= 10.13.0'} + resolution: + { integrity: sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg== } + engines: { node: ">= 10.13.0" } dependencies: - '@types/json-schema': 7.0.12 + "@types/json-schema": 7.0.12 ajv: 6.12.6 ajv-keywords: 3.5.2([email protected]) dev: true /[email protected]: - resolution: {integrity: sha512-L0jRsrPpjdckP3oPug3/VxNKt2trR8TcabrM6FOAAlvC/9Phcmm+cuAgTlxBqdBR1WJx7Naj9WHw+aOmheSVbw==} - engines: {node: '>= 12.13.0'} + resolution: + { integrity: sha512-L0jRsrPpjdckP3oPug3/VxNKt2trR8TcabrM6FOAAlvC/9Phcmm+cuAgTlxBqdBR1WJx7Naj9WHw+aOmheSVbw== } + engines: { node: ">= 12.13.0" } dependencies: - '@types/json-schema': 7.0.12 + "@types/json-schema": 7.0.12 ajv: 8.12.0 ajv-formats: 2.1.1([email protected]) ajv-keywords: 5.1.0([email protected]) dev: true /[email protected]: - resolution: {integrity: sha512-YM3/ITh2MJ5MtzaM429anh+x2jiLVjqILF4m4oyQB18W7Ggea7BfqdH/wGMK7dDiMghv/6WG7znWMwUDzJiXow==} + resolution: + { integrity: sha512-YM3/ITh2MJ5MtzaM429anh+x2jiLVjqILF4m4oyQB18W7Ggea7BfqdH/wGMK7dDiMghv/6WG7znWMwUDzJiXow== } requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==} + resolution: + { integrity: sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==} + resolution: + { integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ== } + engines: { node: ">=10" } hasBin: true dependencies: lru-cache: 6.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA== } + engines: { node: ">=10" } hasBin: true dependencies: lru-cache: 6.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg== } + engines: { node: ">= 0.8.0" } dependencies: debug: 2.6.9 depd: 2.0.0 @@ -10543,8 +11679,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-aaJjxNiOK6ByZIv/vYLxaQE/SoqKYkoNF1DE5DD5fiv2qpq5l8QQrxTAkkDZFxK3DkSbmxNdhrGq/MN40LYYAA==} - engines: {node: '>=14.18'} + resolution: + { integrity: sha512-aaJjxNiOK6ByZIv/vYLxaQE/SoqKYkoNF1DE5DD5fiv2qpq5l8QQrxTAkkDZFxK3DkSbmxNdhrGq/MN40LYYAA== } + engines: { node: ">=14.18" } dependencies: abort-controller: 3.0.0 node-fetch: 2.6.12 @@ -10553,8 +11690,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-8I8TjW5KMOKsZQTvoxjuSIa7foAwPWGOts+6o7sgjz41/qMD9VQHEDxi6PBvK2l0MXUmqZyNpUK+T2tQaaElvw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-8I8TjW5KMOKsZQTvoxjuSIa7foAwPWGOts+6o7sgjz41/qMD9VQHEDxi6PBvK2l0MXUmqZyNpUK+T2tQaaElvw== } + engines: { node: ">=10" } requiresBuild: true dependencies: type-fest: 0.13.1 @@ -10562,20 +11700,23 @@ packages: optional: true /[email protected]: - resolution: {integrity: sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag==} + resolution: + { integrity: sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag== } dependencies: randombytes: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-owoXEFjWRllis8/M1Q+Cw5k8ZH40e3zhp/ovX+Xr/vi1qj6QesbyXXViFbpNvWvPNAD62SutwEXavefrLJWj7w==} + resolution: + { integrity: sha512-owoXEFjWRllis8/M1Q+Cw5k8ZH40e3zhp/ovX+Xr/vi1qj6QesbyXXViFbpNvWvPNAD62SutwEXavefrLJWj7w== } dependencies: randombytes: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g== } + engines: { node: ">= 0.8.0" } dependencies: encodeurl: 1.0.2 escape-html: 1.0.3 @@ -10586,12 +11727,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw==} + resolution: + { integrity: sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw== } dev: true /[email protected]: - resolution: {integrity: sha512-VoaqjbBJKiWtg4yRcKBQ7g7wnGnLV3M8oLvVWwOk2PdYY6PEFegR1vezXR0tw6fZGF9csVakIRjrJiy2veSBFQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-VoaqjbBJKiWtg4yRcKBQ7g7wnGnLV3M8oLvVWwOk2PdYY6PEFegR1vezXR0tw6fZGF9csVakIRjrJiy2veSBFQ== } + engines: { node: ">= 0.4" } dependencies: define-data-property: 1.1.1 get-intrinsic: 1.2.2 @@ -10600,8 +11743,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-tMNCiqYVkXIZgc2Hnoy2IvC/f8ezc5koaRFkCjrpWzGpCd3qbZXPzVy9MAZzK1ch/X0jvSkojys3oqJN0qCmdA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-tMNCiqYVkXIZgc2Hnoy2IvC/f8ezc5koaRFkCjrpWzGpCd3qbZXPzVy9MAZzK1ch/X0jvSkojys3oqJN0qCmdA== } + engines: { node: ">= 0.4" } dependencies: define-data-property: 1.1.1 functions-have-names: 1.2.3 @@ -10609,34 +11753,40 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==} + resolution: + { integrity: sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== } dev: true /[email protected]: - resolution: {integrity: sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA== } + engines: { node: ">=8" } dependencies: kind-of: 6.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== } + engines: { node: ">=8" } dependencies: shebang-regex: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==} + resolution: + { integrity: sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA== } dev: true /[email protected]: - resolution: {integrity: sha512-U3S/a+b0KS+UkTyMjoNojvTgrBHjgp7L6ovhFVZsXmBGnVdQ4K4U9oK0z63w538S91ATngv1vXigHCSWOwnr+g==} + resolution: + { integrity: sha512-U3S/a+b0KS+UkTyMjoNojvTgrBHjgp7L6ovhFVZsXmBGnVdQ4K4U9oK0z63w538S91ATngv1vXigHCSWOwnr+g== } dependencies: ansi-sequence-parser: 1.1.0 jsonc-parser: 3.2.0 @@ -10645,7 +11795,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==} + resolution: + { integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw== } dependencies: call-bind: 1.0.2 get-intrinsic: 1.2.1 @@ -10653,32 +11804,37 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} + resolution: + { integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== } dev: true /[email protected]: - resolution: {integrity: sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==} - engines: {node: '>=14'} + resolution: + { integrity: sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q== } + engines: { node: ">=14" } dev: true /[email protected]: - resolution: {integrity: sha512-KP7QULhWdlu3hlp+jw2EvgWKlOGOY9McLj/jrchLjHNlNPK0KWIwF919cbmOp6QiKXLmPijR2qH/5KYWlbtG9Q==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-KP7QULhWdlu3hlp+jw2EvgWKlOGOY9McLj/jrchLjHNlNPK0KWIwF919cbmOp6QiKXLmPijR2qH/5KYWlbtG9Q== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } hasBin: true dependencies: - '@sigstore/protobuf-specs': 0.1.0 - '@sigstore/tuf': 1.0.2 + "@sigstore/protobuf-specs": 0.1.0 + "@sigstore/tuf": 1.0.2 make-fetch-happen: 11.1.1 transitivePeerDependencies: - supports-color dev: true /[email protected]: - resolution: {integrity: sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==} + resolution: + { integrity: sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q== } dev: true /[email protected]: - resolution: {integrity: sha512-CQ5LTKGfCpvE1K0n2us+kuMPbk/q0EKl82s4aheV9oXjFEz6W/Y7oQFVJuU6QG77hRT4Ghb5RURteF5vnWjupA==} + resolution: + { integrity: sha512-CQ5LTKGfCpvE1K0n2us+kuMPbk/q0EKl82s4aheV9oXjFEz6W/Y7oQFVJuU6QG77hRT4Ghb5RURteF5vnWjupA== } dependencies: decompress-response: 4.2.1 once: 1.4.0 @@ -10686,52 +11842,60 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==} + resolution: + { integrity: sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg== } dependencies: is-arrayish: 0.3.2 dev: true /[email protected]: - resolution: {integrity: sha512-a2B9Y0KlNXl9u/vsW6sTIu9vGEpfKu2wRV6l1H3XEas/0gUIzGzBoP/IouTcUQbm9JWZLH3COxyn03TYlFax6w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-a2B9Y0KlNXl9u/vsW6sTIu9vGEpfKu2wRV6l1H3XEas/0gUIzGzBoP/IouTcUQbm9JWZLH3COxyn03TYlFax6w== } + engines: { node: ">=10" } dependencies: semver: 7.5.4 dev: true /[email protected]: - resolution: {integrity: sha512-85Bm7pKsqiiQ8rmYCaPDdlXZjJvuW6/k/FY8MTtLFMgU7f8S00CgTHfRtWB6KwSb6ek4p9YyG2enG1+yJbl+CA==} - engines: {node: '>=12.2'} + resolution: + { integrity: sha512-85Bm7pKsqiiQ8rmYCaPDdlXZjJvuW6/k/FY8MTtLFMgU7f8S00CgTHfRtWB6KwSb6ek4p9YyG2enG1+yJbl+CA== } + engines: { node: ">=12.2" } dependencies: readjson: 2.2.2 try-to-catch: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-O9jm9BsID1P+0HOi81VpXPoDxYP374pkOLzACAoyUQ/3OUVndNpsz6wMnY2z+yOxzbllCKZrM+9QrWsv4THnyA==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-O9jm9BsID1P+0HOi81VpXPoDxYP374pkOLzACAoyUQ/3OUVndNpsz6wMnY2z+yOxzbllCKZrM+9QrWsv4THnyA== } + engines: { node: ">= 10" } dependencies: - '@polka/url': 1.0.0-next.21 + "@polka/url": 1.0.0-next.21 mrmime: 1.0.1 totalist: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==} + resolution: + { integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== } dev: true /[email protected]: - resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==} - engines: {node: '>= 6.0.0', npm: '>= 3.0.0'} + resolution: + { integrity: sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg== } + engines: { node: ">= 6.0.0", npm: ">= 3.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-Fgl0YPZ902wEsAyiQ+idGd1A7rSFx/ayC1CQVMw5P+EQx2V0SgpGtf6OKFhVjPflPUl9YMmEOnmfjCdMUsygww==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-Fgl0YPZ902wEsAyiQ+idGd1A7rSFx/ayC1CQVMw5P+EQx2V0SgpGtf6OKFhVjPflPUl9YMmEOnmfjCdMUsygww== } + engines: { node: ">= 10" } dependencies: agent-base: 6.0.2 debug: 4.3.4([email protected]) @@ -10741,49 +11905,57 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ==} - engines: {node: '>= 10.13.0', npm: '>= 3.0.0'} + resolution: + { integrity: sha512-7maUZy1N7uo6+WVEX6psASxtNlKaNVMlGQKkG/63nEDdLOWNbiUMoLK7X4uYoLhQstau72mLgfEWcXcwsaHbYQ== } + engines: { node: ">= 10.13.0", npm: ">= 3.0.0" } dependencies: ip: 2.0.0 smart-buffer: 4.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-/dPCrG1s3ePpWm6yBbxZq5Be1dXGLyLn9Z791chDC3NFrpkVbWGzkBwPN1knaciexFXgRJ7hzdnwZ4stHSDmjg==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-/dPCrG1s3ePpWm6yBbxZq5Be1dXGLyLn9Z791chDC3NFrpkVbWGzkBwPN1knaciexFXgRJ7hzdnwZ4stHSDmjg== } + engines: { node: ">=4" } dependencies: is-plain-obj: 1.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==} + resolution: + { integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w== } dependencies: buffer-from: 1.1.2 source-map: 0.6.1 dev: true /[email protected]: - resolution: {integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA== } + engines: { node: ">= 8" } dev: true /[email protected]: - resolution: {integrity: sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ==} + resolution: + { integrity: sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ== } dev: true /[email protected]: - resolution: {integrity: sha512-EeajNjfN9zMnULLwhZZQU3GWBoFNkbngTUPfaawT4RkMiviTxcX0qfhVbGey39mfctfDHkWtuecgQ8NJcyQWHg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-EeajNjfN9zMnULLwhZZQU3GWBoFNkbngTUPfaawT4RkMiviTxcX0qfhVbGey39mfctfDHkWtuecgQ8NJcyQWHg== } + engines: { node: ">=8" } dependencies: foreground-child: 2.0.0 is-windows: 1.0.2 @@ -10794,84 +11966,99 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==} + resolution: + { integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA== } dependencies: spdx-expression-parse: 3.0.1 spdx-license-ids: 3.0.13 dev: true /[email protected]: - resolution: {integrity: sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==} + resolution: + { integrity: sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A== } dev: true /[email protected]: - resolution: {integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==} + resolution: + { integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q== } dependencies: spdx-exceptions: 2.3.0 spdx-license-ids: 3.0.13 dev: true /[email protected]: - resolution: {integrity: sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w==} + resolution: + { integrity: sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w== } dev: true /[email protected]: - resolution: {integrity: sha512-9NThjpgZnifTkJpzTZ7Eue85S49QwpNhZTq6GRJwObb6jnLFNGB7Qm73V5HewTROPyxD0C29xqmaI68bQtV+hg==} + resolution: + { integrity: sha512-9NThjpgZnifTkJpzTZ7Eue85S49QwpNhZTq6GRJwObb6jnLFNGB7Qm73V5HewTROPyxD0C29xqmaI68bQtV+hg== } dependencies: readable-stream: 3.6.2 dev: true /[email protected]: - resolution: {integrity: sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg==} - engines: {node: '>= 10.x'} + resolution: + { integrity: sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg== } + engines: { node: ">= 10.x" } dev: true /[email protected]: - resolution: {integrity: sha512-mTyOoPbrivtXnwnIxZRFYRrPNtEFKlpB2fvjSnCQUiAA6qAZzqwna5envK4uk6OIeP17CsdF3rSBGYVBsU0Tkg==} + resolution: + { integrity: sha512-mTyOoPbrivtXnwnIxZRFYRrPNtEFKlpB2fvjSnCQUiAA6qAZzqwna5envK4uk6OIeP17CsdF3rSBGYVBsU0Tkg== } dependencies: through: 2.3.8 dev: true /[email protected]: - resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==} + resolution: + { integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g== } dev: true /[email protected]: - resolution: {integrity: sha512-VE0SOVEHCk7Qc8ulkWw3ntAzXuqf7S2lvwQaDLRnUeIEaKNQJzV6BwmLKhOqT61aGhfUMrXeaBk+oDGCzvhcug==} + resolution: + { integrity: sha512-VE0SOVEHCk7Qc8ulkWw3ntAzXuqf7S2lvwQaDLRnUeIEaKNQJzV6BwmLKhOqT61aGhfUMrXeaBk+oDGCzvhcug== } requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-12+IR2CB2C28MMAw0Ncqwj5QbTcs0nGIhgJzYWzDkb21vWmfNI83KS4f3Ci6GI98WreIfG7o9UXp3C0qbpA8nQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-12+IR2CB2C28MMAw0Ncqwj5QbTcs0nGIhgJzYWzDkb21vWmfNI83KS4f3Ci6GI98WreIfG7o9UXp3C0qbpA8nQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: minipass: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-o57Wcn66jMQvfHG1FlYbWeZWW/dHZhJXjpIcTfXldXEk5nz5lStPo3mK0OJQfGR3RbZUlbISexbljkJzuEj/8Q==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0} + resolution: + { integrity: sha512-o57Wcn66jMQvfHG1FlYbWeZWW/dHZhJXjpIcTfXldXEk5nz5lStPo3mK0OJQfGR3RbZUlbISexbljkJzuEj/8Q== } + engines: { node: ^12.13.0 \|\| ^14.15.0 \|\| >=16.0.0 } dependencies: minipass: 3.3.6 dev: true /[email protected]: - resolution: {integrity: sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg==} + resolution: + { integrity: sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg== } dev: true /[email protected]: - resolution: {integrity: sha512-mokWb6xGU0elmDlUT6Y5E4zsUs/Enlq5fpyE7pfffpJg9Lg83GlL7B9zHEPA0eDvDC3Ko0ZZ50cjIN8yYJRPoQ==} + resolution: + { integrity: sha512-mokWb6xGU0elmDlUT6Y5E4zsUs/Enlq5fpyE7pfffpJg9Lg83GlL7B9zHEPA0eDvDC3Ko0ZZ50cjIN8yYJRPoQ== } dev: true /[email protected]: - resolution: {integrity: sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== } + engines: { node: ">=8" } dependencies: emoji-regex: 8.0.0 is-fullwidth-code-point: 3.0.0 @@ -10879,8 +12066,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA== } + engines: { node: ">=12" } dependencies: eastasianwidth: 0.2.0 emoji-regex: 9.2.2 @@ -10888,8 +12076,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-lfjY4HcixfQXOfaqCvcBuOIapyaroTXhbkfJN3gcB1OtyupngWK4sEET9Knd0cXd28kTUqu/kHoV4HKSJdnjiQ==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-lfjY4HcixfQXOfaqCvcBuOIapyaroTXhbkfJN3gcB1OtyupngWK4sEET9Knd0cXd28kTUqu/kHoV4HKSJdnjiQ== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -10897,7 +12086,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ni79DqeB72ZFq1uH/L6zJ+DKZTkOtPIHovb3YZHQViE+HDouuU4mBrLOLDn5Dde3RF8qw5qVETEjhu9locMLvA==} + resolution: + { integrity: sha512-Ni79DqeB72ZFq1uH/L6zJ+DKZTkOtPIHovb3YZHQViE+HDouuU4mBrLOLDn5Dde3RF8qw5qVETEjhu9locMLvA== } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -10905,7 +12095,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-NGhtDFu3jCEm7B4Fy0DpLewdJQOZcQ0rGbwQ/+stjnrp2i+rlKeCvos9hOIeCmqwratM47OBxY7uFZzjxHXmrg==} + resolution: + { integrity: sha512-NGhtDFu3jCEm7B4Fy0DpLewdJQOZcQ0rGbwQ/+stjnrp2i+rlKeCvos9hOIeCmqwratM47OBxY7uFZzjxHXmrg== } dependencies: call-bind: 1.0.5 define-properties: 1.2.0 @@ -10913,72 +12104,84 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ==} + resolution: + { integrity: sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ== } dev: true /[email protected]: - resolution: {integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==} + resolution: + { integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== } dependencies: safe-buffer: 5.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==} + resolution: + { integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== } dependencies: safe-buffer: 5.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== } + engines: { node: ">=8" } dependencies: ansi-regex: 5.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ== } + engines: { node: ">=12" } dependencies: ansi-regex: 6.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ== } + engines: { node: ">=8" } dependencies: min-indent: 1.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-k55yxKHwaXnpYGsOzg4Vl8+tDrWylxDEpknGjhTiZB8dFRU5rTo9CAzeycivxV3s+zlTKwrs6WxMxR95n26kwg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-k55yxKHwaXnpYGsOzg4Vl8+tDrWylxDEpknGjhTiZB8dFRU5rTo9CAzeycivxV3s+zlTKwrs6WxMxR95n26kwg== } + engines: { node: ">=0.10.0" } dependencies: escape-string-regexp: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-B3Hgul+z0L9a236FAUC9iZsL+nVHgoCJnqCbN588DjYxvGXaXaaFbfmQ/JhvKjZwsOukuR72XbHv71Qkug0HxA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-B3Hgul+z0L9a236FAUC9iZsL+nVHgoCJnqCbN588DjYxvGXaXaaFbfmQ/JhvKjZwsOukuR72XbHv71Qkug0HxA== } + engines: { node: ">=4" } hasBin: true dependencies: duplexer: 0.1.2 @@ -10987,10 +12190,11 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-v3YCf31atbwJQIMtPNX8hcQ+okD4NQaTuKGUWfII8eaqn+3otrbttGL1zSMZAAtiPsBztQnujVBugg/cXFUpyg==} + resolution: + { integrity: sha512-v3YCf31atbwJQIMtPNX8hcQ+okD4NQaTuKGUWfII8eaqn+3otrbttGL1zSMZAAtiPsBztQnujVBugg/cXFUpyg== } hasBin: true dependencies: - '@adobe/css-tools': 4.3.1 + "@adobe/css-tools": 4.3.1 debug: 4.3.4([email protected]) glob: 7.2.3 sax: 1.3.0 @@ -11000,8 +12204,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-MvjXzkz/BOfyVDkG0oFOtBxHX2u3gKbMHIF/dXblZsgD3BWOFLmHovIpZY7BykJdAjcqRCBi1WYBNdEC9yI7vg==} - engines: {node: '>= 8.0'} + resolution: + { integrity: sha512-MvjXzkz/BOfyVDkG0oFOtBxHX2u3gKbMHIF/dXblZsgD3BWOFLmHovIpZY7BykJdAjcqRCBi1WYBNdEC9yI7vg== } + engines: { node: ">= 8.0" } dependencies: debug: 4.3.4([email protected]) transitivePeerDependencies: @@ -11009,43 +12214,50 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== } + engines: { node: ">=4" } dependencies: has-flag: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== } + engines: { node: ">=8" } dependencies: has-flag: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== } + engines: { node: ">=10" } dependencies: has-flag: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== } + engines: { node: ">= 0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==} + resolution: + { integrity: sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw== } dev: true /[email protected]: - resolution: {integrity: sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ== } + engines: { node: ">=6" } dependencies: bl: 4.1.0 end-of-stream: 1.4.4 @@ -11055,8 +12267,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-an/KZQzQUkZCkuoAA64hM92X0Urb6VpRhAFllDzz44U2mcD5scmT3zBc4VgVpkugF580+DQn8eAFSyoQt0tznA==} - engines: {node: '>= 10'} + resolution: + { integrity: sha512-an/KZQzQUkZCkuoAA64hM92X0Urb6VpRhAFllDzz44U2mcD5scmT3zBc4VgVpkugF580+DQn8eAFSyoQt0tznA== } + engines: { node: ">= 10" } dependencies: chownr: 2.0.0 fs-minipass: 2.1.0 @@ -11067,8 +12280,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-/zKt9UyngnxIT/EAGYuxaMYgOIJiP81ab9ZfkILq4oNLPFX50qyYmu7jRj9qeXoxmJHjGlbH0+cm2uy1WCs10A==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-/zKt9UyngnxIT/EAGYuxaMYgOIJiP81ab9ZfkILq4oNLPFX50qyYmu7jRj9qeXoxmJHjGlbH0+cm2uy1WCs10A== } + engines: { node: ">=10" } dependencies: chownr: 2.0.0 fs-minipass: 2.1.0 @@ -11079,27 +12293,29 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-xZFXEGbG7SNC3itwBzI3RYjq/cEhBkx2hJuKGIUOcEULmkQExXiHat2z/qkISYsuR+IKumhEfKKbV5qXmhICFQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-xZFXEGbG7SNC3itwBzI3RYjq/cEhBkx2hJuKGIUOcEULmkQExXiHat2z/qkISYsuR+IKumhEfKKbV5qXmhICFQ== } + engines: { node: ">=4" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-ZuXsqE07EcggTWQjXUj+Aot/OMcD0bMKGgF63f7UxYcu5/AJF53aIpK1YoP5xR9l6s/Hy2b+t1AM0bLNPRuhwA==} - engines: {node: '>= 10.13.0'} + resolution: + { integrity: sha512-ZuXsqE07EcggTWQjXUj+Aot/OMcD0bMKGgF63f7UxYcu5/AJF53aIpK1YoP5xR9l6s/Hy2b+t1AM0bLNPRuhwA== } + engines: { node: ">= 10.13.0" } peerDependencies: - '@swc/core': '' - esbuild: '' - uglify-js: '' + "@swc/core": "" + esbuild: "" + uglify-js: "" webpack: ^5.1.0 peerDependenciesMeta: - '@swc/core': + "@swc/core": optional: true esbuild: optional: true uglify-js: optional: true dependencies: - '@jridgewell/trace-mapping': 0.3.18 + "@jridgewell/trace-mapping": 0.3.18 jest-worker: 27.5.1 schema-utils: 3.3.0 serialize-javascript: 6.0.1 @@ -11108,110 +12324,128 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Ah19JS86ypbJzTzvUCX7KOsEIhDaRONungA4aYBjEP3JZRf4ocuDzTg4QWZnPn9DEMiMYGJPiSOy7aykoCc70w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Ah19JS86ypbJzTzvUCX7KOsEIhDaRONungA4aYBjEP3JZRf4ocuDzTg4QWZnPn9DEMiMYGJPiSOy7aykoCc70w== } + engines: { node: ">=10" } hasBin: true dependencies: - '@jridgewell/source-map': 0.3.5 + "@jridgewell/source-map": 0.3.5 acorn: 8.10.0 commander: 2.20.3 source-map-support: 0.5.21 dev: true /[email protected]: - resolution: {integrity: sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w== } + engines: { node: ">=8" } dependencies: - '@istanbuljs/schema': 0.1.3 + "@istanbuljs/schema": 0.1.3 glob: 7.2.3 minimatch: 3.1.2 dev: true /[email protected]: - resolution: {integrity: sha512-wiBrwC1EhBelW12Zy26JeOUkQ5mRu+5o8rpsJk5+2t+Y5vE7e842qtZDQ2g1NpX/29HdyFeJ4nSIhI47ENSxlQ==} - engines: {node: '>=0.10'} + resolution: + { integrity: sha512-wiBrwC1EhBelW12Zy26JeOUkQ5mRu+5o8rpsJk5+2t+Y5vE7e842qtZDQ2g1NpX/29HdyFeJ4nSIhI47ENSxlQ== } + engines: { node: ">=0.10" } dev: true /[email protected]: - resolution: {integrity: sha512-te/NtwBwfiNRLf9Ijqx3T0nlqZiQ2XrrtBvu+cLL8ZRrGkO0NHTug8MYFKyoSrv/sHTaSKfilUkizV6XhxMJ3g==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-te/NtwBwfiNRLf9Ijqx3T0nlqZiQ2XrrtBvu+cLL8ZRrGkO0NHTug8MYFKyoSrv/sHTaSKfilUkizV6XhxMJ3g== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==} + resolution: + { integrity: sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg== } dev: true /[email protected]: - resolution: {integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==} + resolution: + { integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw== } dev: true /[email protected]: - resolution: {integrity: sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==} + resolution: + { integrity: sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ== } dependencies: readable-stream: 2.3.8 xtend: 4.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-iOqSav00cVxEEICeD7TjLB1sueEL+81Wpzp2bY17uZjZN0pWZPuo4suZ/61VujxmqSGFfgOcNuTZ85QJwNZQpw==} + resolution: + { integrity: sha512-iOqSav00cVxEEICeD7TjLB1sueEL+81Wpzp2bY17uZjZN0pWZPuo4suZ/61VujxmqSGFfgOcNuTZ85QJwNZQpw== } dependencies: readable-stream: 3.6.2 dev: true /[email protected]: - resolution: {integrity: sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==} + resolution: + { integrity: sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg== } dev: true /[email protected]: - resolution: {integrity: sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==} - engines: {node: '>=0.6.0'} + resolution: + { integrity: sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw== } + engines: { node: ">=0.6.0" } dependencies: os-tmpdir: 1.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==} - engines: {node: '>=8.17.0'} + resolution: + { integrity: sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ== } + engines: { node: ">=8.17.0" } dependencies: rimraf: 3.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==} - engines: {node: '>=8.0'} + resolution: + { integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== } + engines: { node: ">=8.0" } dependencies: is-number: 7.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==} - engines: {node: '>=0.6'} + resolution: + { integrity: sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== } + engines: { node: ">=0.6" } dev: true /[email protected]: - resolution: {integrity: sha512-VSsyNPPW74RpHwR8Fc21uubwHY7wMDeJLys2IX5zJNih+OnAnaifKHo+1LHT7DAdloQ7apeaaWg8l7qnf/TnEg==} + resolution: + { integrity: sha512-VSsyNPPW74RpHwR8Fc21uubwHY7wMDeJLys2IX5zJNih+OnAnaifKHo+1LHT7DAdloQ7apeaaWg8l7qnf/TnEg== } dev: true /[email protected]: - resolution: {integrity: sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-WBx8Uy5TLtOSRtIq+M03/sKDrXCLHxwDcquSP2c43Le03/9serjQBIztjRz6FkJez9D/hleyAXTBGLwwZUw9lA==} + resolution: + { integrity: sha512-WBx8Uy5TLtOSRtIq+M03/sKDrXCLHxwDcquSP2c43Le03/9serjQBIztjRz6FkJez9D/hleyAXTBGLwwZUw9lA== } hasBin: true dependencies: nopt: 1.0.10 dev: true /[email protected]: - resolution: {integrity: sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw== } + engines: { node: ">=6" } dependencies: psl: 1.9.0 punycode: 2.3.1 @@ -11220,63 +12454,73 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==} + resolution: + { integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw== } dev: true /[email protected]: - resolution: {integrity: sha512-tk2G5R2KRwBd+ZN0zaEXpmzdKyOYksXwywulIX95MBODjSzMIuQnQ3m8JxgbhnL1LeVo7lqQKsYa1O3Htl7K5g==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-tk2G5R2KRwBd+ZN0zaEXpmzdKyOYksXwywulIX95MBODjSzMIuQnQ3m8JxgbhnL1LeVo7lqQKsYa1O3Htl7K5g== } + engines: { node: ">=18" } dependencies: punycode: 2.3.1 dev: true /[email protected]: - resolution: {integrity: sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==} + resolution: + { integrity: sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-pkonvlKk8/ZuR0D5tLW8ljt5I8kmxp2XKymhepUeOdCEfKpZaktSArkLHZt76OB1ZvO9bssUsDty4SWhLvZpLg==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-pkonvlKk8/ZuR0D5tLW8ljt5I8kmxp2XKymhepUeOdCEfKpZaktSArkLHZt76OB1ZvO9bssUsDty4SWhLvZpLg== } + engines: { node: ">=0.10.0" } dependencies: escape-string-regexp: 1.0.5 dev: true /[email protected]: - resolution: {integrity: sha512-rD6Q7Grj07i2PW1sQmz4KXviI+9E02EWBnAU9DafQbUueb7Esh786jop+be92KFxvxPGHuC0mR7YVcE6rScMBg==} - engines: {node: '>= 16.0.0'} + resolution: + { integrity: sha512-rD6Q7Grj07i2PW1sQmz4KXviI+9E02EWBnAU9DafQbUueb7Esh786jop+be92KFxvxPGHuC0mR7YVcE6rScMBg== } + engines: { node: ">= 16.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-91yfXw1rr/P6oLpHSyHDOHm0vloVvUoo9FVdw8YwY05QjJQG9OT0LUxe2VRAzmHG+0CUOmI3nhxDUMLxDN/NEQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-91yfXw1rr/P6oLpHSyHDOHm0vloVvUoo9FVdw8YwY05QjJQG9OT0LUxe2VRAzmHG+0CUOmI3nhxDUMLxDN/NEQ== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-hOY83V84Hx/1sCzDSaJA+Xz2IIQOHRvjxzt+F0OjbQGPZ6yLPLArMA0gw/484MlfUkQbCpKYMLX3VDCAjWKfzQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-hOY83V84Hx/1sCzDSaJA+Xz2IIQOHRvjxzt+F0OjbQGPZ6yLPLArMA0gw/484MlfUkQbCpKYMLX3VDCAjWKfzQ== } + engines: { node: ">=6" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-lC/RGlPmwdrIBFTX59wwNzqh7aR2otPNPR/5brHZm/XKFYKsfqxihXUe9pU3JI+3vGkl+vyCoNNnPhJn3aLK1A==} - engines: {node: '>=16.13.0'} + resolution: + { integrity: sha512-lC/RGlPmwdrIBFTX59wwNzqh7aR2otPNPR/5brHZm/XKFYKsfqxihXUe9pU3JI+3vGkl+vyCoNNnPhJn3aLK1A== } + engines: { node: ">=16.13.0" } peerDependencies: - typescript: '>=4.2.0' + typescript: ">=4.2.0" dependencies: typescript: 5.3.2 dev: true /[email protected]: - resolution: {integrity: sha512-wnhPMtskk9KvsTuU8AYx0TNdm1YrLVUEontT22+jL12JIPqPXdaoxPgsYBhlqDXsR9R9Nm2bJgH5r4IrTMbTSg==} - engines: {node: '>=10.0.0'} + resolution: + { integrity: sha512-wnhPMtskk9KvsTuU8AYx0TNdm1YrLVUEontT22+jL12JIPqPXdaoxPgsYBhlqDXsR9R9Nm2bJgH5r4IrTMbTSg== } + engines: { node: ">=10.0.0" } hasBin: true dependencies: - '@types/json-schema': 7.0.12 + "@types/json-schema": 7.0.12 commander: 11.1.0 glob: 8.1.0 json5: 2.2.3 @@ -11286,25 +12530,26 @@ packages: dev: true /[email protected](@types/[email protected])([email protected]): - resolution: {integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==} + resolution: + { integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw== } hasBin: true peerDependencies: - '@swc/core': '>=1.2.50' - '@swc/wasm': '>=1.2.50' - '@types/node': '' - typescript: '>=2.7' + "@swc/core": ">=1.2.50" + "@swc/wasm": ">=1.2.50" + "@types/node": "" + typescript: ">=2.7" peerDependenciesMeta: - '@swc/core': + "@swc/core": optional: true - '@swc/wasm': + "@swc/wasm": optional: true dependencies: - '@cspotcode/source-map-support': 0.8.1 - '@tsconfig/node10': 1.0.9 - '@tsconfig/node12': 1.0.11 - '@tsconfig/node14': 1.0.3 - '@tsconfig/node16': 1.0.4 - '@types/node': 16.18.38 + "@cspotcode/source-map-support": 0.8.1 + "@tsconfig/node10": 1.0.9 + "@tsconfig/node12": 1.0.11 + "@tsconfig/node14": 1.0.3 + "@tsconfig/node16": 1.0.4 + "@types/node": 16.18.38 acorn: 8.10.0 acorn-walk: 8.2.0 arg: 4.1.3 @@ -11317,25 +12562,26 @@ packages: dev: true /[email protected](@types/[email protected])([email protected]): - resolution: {integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==} + resolution: + { integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw== } hasBin: true peerDependencies: - '@swc/core': '>=1.2.50' - '@swc/wasm': '>=1.2.50' - '@types/node': '' - typescript: '>=2.7' + "@swc/core": ">=1.2.50" + "@swc/wasm": ">=1.2.50" + "@types/node": "" + typescript: ">=2.7" peerDependenciesMeta: - '@swc/core': + "@swc/core": optional: true - '@swc/wasm': + "@swc/wasm": optional: true dependencies: - '@cspotcode/source-map-support': 0.8.1 - '@tsconfig/node10': 1.0.9 - '@tsconfig/node12': 1.0.11 - '@tsconfig/node14': 1.0.3 - '@tsconfig/node16': 1.0.4 - '@types/node': 20.10.3 + "@cspotcode/source-map-support": 0.8.1 + "@tsconfig/node10": 1.0.9 + "@tsconfig/node12": 1.0.11 + "@tsconfig/node14": 1.0.3 + "@tsconfig/node16": 1.0.4 + "@types/node": 20.10.3 acorn: 8.10.0 acorn-walk: 8.2.0 arg: 4.1.3 @@ -11348,17 +12594,19 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-o/9iXgCYc5L/JxCHPe3Hvh8Q/2xm5Z+p18PESBU6Ff33695QnCHBEjcytY2q19ua7Mbl/DavtBOLq+oG0RCL+g==} + resolution: + { integrity: sha512-o/9iXgCYc5L/JxCHPe3Hvh8Q/2xm5Z+p18PESBU6Ff33695QnCHBEjcytY2q19ua7Mbl/DavtBOLq+oG0RCL+g== } dependencies: - '@types/json5': 0.0.29 + "@types/json5": 0.0.29 json5: 1.0.2 minimist: 1.2.8 strip-bom: 3.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-NoZ4roiN7LnbKn9QqE1amc9DJfzvZXxF4xDavcOWt1BPkdx+m+0gJuPM+S0vCe7zTJMYUP0R8pO2XMr+Y8oLIg==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-NoZ4roiN7LnbKn9QqE1amc9DJfzvZXxF4xDavcOWt1BPkdx+m+0gJuPM+S0vCe7zTJMYUP0R8pO2XMr+Y8oLIg== } + engines: { node: ">=6" } dependencies: json5: 2.2.3 minimist: 1.2.8 @@ -11366,14 +12614,16 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==} + resolution: + { integrity: sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA== } dev: true /[email protected]: - resolution: {integrity: sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: - '@tufjs/models': 1.0.4 + "@tufjs/models": 1.0.4 debug: 4.3.4([email protected]) make-fetch-happen: 11.1.1 transitivePeerDependencies: @@ -11381,70 +12631,82 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==} - engines: {node: '>= 0.8.0'} + resolution: + { integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew== } + engines: { node: ">= 0.8.0" } dependencies: prelude-ls: 1.2.1 dev: true /[email protected]: - resolution: {integrity: sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-34R7HTnG0XIJcBSn5XhDd7nNFPRcXYRZrBB2O2jdKqYODldSzBAqzsWoZYYvduky73toYS/ESqxPvkDf/F0XMg==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-34R7HTnG0XIJcBSn5XhDd7nNFPRcXYRZrBB2O2jdKqYODldSzBAqzsWoZYYvduky73toYS/ESqxPvkDf/F0XMg== } + engines: { node: ">=10" } requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-IwzA/LSfD2vC1/YDYMv/zHP4rDF1usCwllsDpbolT3D4fUepIO7f9K70jjmUewU/LmGUKJcwcVtDCpnKk4BPMw==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-IwzA/LSfD2vC1/YDYMv/zHP4rDF1usCwllsDpbolT3D4fUepIO7f9K70jjmUewU/LmGUKJcwcVtDCpnKk4BPMw== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-ShaaYnjf+0etG8W/FumARKMjjIToy/haCaTjN2dvcewOSoNqCQzdgG7m2JVOlM5qndGTHjkvsrWZs+k/2Z7E0Q==} - engines: {node: '>=16'} + resolution: + { integrity: sha512-ShaaYnjf+0etG8W/FumARKMjjIToy/haCaTjN2dvcewOSoNqCQzdgG7m2JVOlM5qndGTHjkvsrWZs+k/2Z7E0Q== } + engines: { node: ">=16" } dev: true /[email protected]: - resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==} - engines: {node: '>= 0.6'} + resolution: + { integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g== } + engines: { node: ">= 0.6" } dependencies: media-typer: 0.3.0 mime-types: 2.1.35 dev: true /[email protected]: - resolution: {integrity: sha512-Y8KTSIglk9OZEr8zywiIHG/kmQ7KWyjseXs1CbSo8vC42w7hg2HgYTxSWwP0+is7bWDc1H+Fo026CpHFwm8tkw==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Y8KTSIglk9OZEr8zywiIHG/kmQ7KWyjseXs1CbSo8vC42w7hg2HgYTxSWwP0+is7bWDc1H+Fo026CpHFwm8tkw== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 get-intrinsic: 1.2.2 @@ -11452,8 +12714,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-Or/+kvLxNpeQ9DtSydonMxCx+9ZXOswtwJn17SNLvhptaXYDJvkFFP5zbfU/uLmvnBJlI4yrnXRxpdWH/M5tNA==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-Or/+kvLxNpeQ9DtSydonMxCx+9ZXOswtwJn17SNLvhptaXYDJvkFFP5zbfU/uLmvnBJlI4yrnXRxpdWH/M5tNA== } + engines: { node: ">= 0.4" } dependencies: call-bind: 1.0.5 for-each: 0.3.3 @@ -11462,8 +12725,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-RD97prjEt9EL8YgAgpOkf3O4IF9lhJFr9g0htQkm0rchFp/Vx7LW5Q8fSXXub7BXAODyUQohRMyOc3faCPd0hg==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-RD97prjEt9EL8YgAgpOkf3O4IF9lhJFr9g0htQkm0rchFp/Vx7LW5Q8fSXXub7BXAODyUQohRMyOc3faCPd0hg== } + engines: { node: ">= 0.4" } dependencies: available-typed-arrays: 1.0.5 call-bind: 1.0.5 @@ -11473,7 +12737,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-KjZypGq+I/H7HI5HlOoGHkWUUGq+Q0TPhQurLbyrVrvnKTBgzLhIJ7j6J/XTQOi0d1RjyZ0wdas8bKs2p0x3Ng==} + resolution: + { integrity: sha512-KjZypGq+I/H7HI5HlOoGHkWUUGq+Q0TPhQurLbyrVrvnKTBgzLhIJ7j6J/XTQOi0d1RjyZ0wdas8bKs2p0x3Ng== } dependencies: call-bind: 1.0.5 for-each: 0.3.3 @@ -11481,17 +12746,20 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==} + resolution: + { integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q== } dependencies: is-typedarray: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} + resolution: + { integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-PzWe1iqnul+9DOZh3/OCcndjTstoxHET4XIXEMif1l/LbxpHdIBQ+h5HlcS6D2nW8HoiZqxMYjvWIqtaqPmRAQ==} + resolution: + { integrity: sha512-PzWe1iqnul+9DOZh3/OCcndjTstoxHET4XIXEMif1l/LbxpHdIBQ+h5HlcS6D2nW8HoiZqxMYjvWIqtaqPmRAQ== } peerDependencies: typedoc: ^0.25.4 dependencies: @@ -11500,7 +12768,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-BvJj8ZvgCZzS2sLO7yIkRg9EWLPdll+xLyQekjMAtypHITOXSwCO9E9Ir77R2fctsVC9BVJiToGAYcsMtyuPdw==} + resolution: + { integrity: sha512-BvJj8ZvgCZzS2sLO7yIkRg9EWLPdll+xLyQekjMAtypHITOXSwCO9E9Ir77R2fctsVC9BVJiToGAYcsMtyuPdw== } peerDependencies: typedoc: ^0.25.4 dependencies: @@ -11509,8 +12778,9 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-/hq9nwSNBz2p7+VYfljT/zFSmaxN8tlfcIp6CCAaQN6VIxXCciYFIqR+pcckRhjmfHIeSJ5uy2OpCt5F683npA==} - engines: {node: '>= 16'} + resolution: + { integrity: sha512-/hq9nwSNBz2p7+VYfljT/zFSmaxN8tlfcIp6CCAaQN6VIxXCciYFIqR+pcckRhjmfHIeSJ5uy2OpCt5F683npA== } + engines: { node: ">= 16" } peerDependencies: typedoc: ^0.22.12 \|\| 0.23.x \|\| 0.24.x \|\| 0.25.x dependencies: @@ -11518,7 +12788,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-URyCIHw6+Lwil0ywy6lVb2TckfDVGjAWnRnTAiiSZaRaglI6vaaP1EhhwEipOIlHaJSnHZfdwpWe1t4mffTIpA==} + resolution: + { integrity: sha512-URyCIHw6+Lwil0ywy6lVb2TckfDVGjAWnRnTAiiSZaRaglI6vaaP1EhhwEipOIlHaJSnHZfdwpWe1t4mffTIpA== } peerDependencies: typedoc: ^0.25.4 dependencies: @@ -11527,7 +12798,8 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-+1DhqZCEu7Vu5APnrqpPwl31D+hXpt1fV0Le9ycCRL1eLVdatdl6KVt4SEVwPxnEpKwgOn2dNX6I9+0F1aO2aA==} + resolution: + { integrity: sha512-+1DhqZCEu7Vu5APnrqpPwl31D+hXpt1fV0Le9ycCRL1eLVdatdl6KVt4SEVwPxnEpKwgOn2dNX6I9+0F1aO2aA== } peerDependencies: typedoc: 0.24.x \|\| 0.25.x dependencies: @@ -11535,8 +12807,9 @@ packages: dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==} - engines: {node: '>= 16'} + resolution: + { integrity: sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA== } + engines: { node: ">= 16" } hasBin: true peerDependencies: typescript: 4.6.x \|\| 4.7.x \|\| 4.8.x \|\| 4.9.x \|\| 5.0.x \|\| 5.1.x \|\| 5.2.x \|\| 5.3.x @@ -11549,11 +12822,12 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-qRO6pCgyjKJ230QYdOxDRpdQrBeeino4v5p2rYmSD72Jf4rD3O+cJcROv46sQukm46CLWoeusqvBgKpynEv25g==} + resolution: + { integrity: sha512-qRO6pCgyjKJ230QYdOxDRpdQrBeeino4v5p2rYmSD72Jf4rD3O+cJcROv46sQukm46CLWoeusqvBgKpynEv25g== } hasBin: true dependencies: - '@types/json-schema': 7.0.12 - '@types/node': 16.18.38 + "@types/json-schema": 7.0.12 + "@types/node": 16.18.38 glob: 7.2.3 path-equal: 1.2.5 safe-stable-stringify: 2.4.3 @@ -11561,32 +12835,36 @@ packages: typescript: 5.1.6 yargs: 17.7.2 transitivePeerDependencies: - - '@swc/core' - - '@swc/wasm' + - "@swc/core" + - "@swc/wasm" dev: true /[email protected]: - resolution: {integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==} - engines: {node: '>=14.17'} + resolution: + { integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA== } + engines: { node: ">=14.17" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-6l+RyNy7oAHDfxC4FzSJcz9vnjTKxrLpDG5M2Vu4SHRVNg6xzqZp6LYSR9zjqQTu8DU/f5xwxUdADOkbrIX2gQ==} - engines: {node: '>=14.17'} + resolution: + { integrity: sha512-6l+RyNy7oAHDfxC4FzSJcz9vnjTKxrLpDG5M2Vu4SHRVNg6xzqZp6LYSR9zjqQTu8DU/f5xwxUdADOkbrIX2gQ== } + engines: { node: ">=14.17" } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==} - engines: {node: '>=0.8.0'} + resolution: + { integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g== } + engines: { node: ">=0.8.0" } hasBin: true requiresBuild: true dev: true optional: true /[email protected]: - resolution: {integrity: sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==} + resolution: + { integrity: sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw== } dependencies: call-bind: 1.0.5 has-bigints: 1.0.2 @@ -11595,89 +12873,105 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==} + resolution: + { integrity: sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA== } dev: true /[email protected]: - resolution: {integrity: sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==} + resolution: + { integrity: sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA== } dev: true /[email protected]: - resolution: {integrity: sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q== } + engines: { node: ">=4" } dependencies: unicode-canonical-property-names-ecmascript: 2.0.0 unicode-property-aliases-ecmascript: 2.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w== } + engines: { node: ">=4" } dev: true /[email protected]: - resolution: {integrity: sha512-afXhuC55wkAmZ0P18QsVE6kp8JaxrEokN2HGIoIVv2ijHQd419H0+6EigAFcIzXeMIkcIkNBpB3L/DXB3cTS/g==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-afXhuC55wkAmZ0P18QsVE6kp8JaxrEokN2HGIoIVv2ijHQd419H0+6EigAFcIzXeMIkcIkNBpB3L/DXB3cTS/g== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: unique-slug: 4.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-WrcA6AyEfqDX5bWige/4NQfPZMtASNVxdmWR76WESYQVAACSgWcR6e9i0mofqqBxYFtL4oAxPIptY73/0YE1DQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-WrcA6AyEfqDX5bWige/4NQfPZMtASNVxdmWR76WESYQVAACSgWcR6e9i0mofqqBxYFtL4oAxPIptY73/0YE1DQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: imurmurhash: 0.1.4 dev: true /[email protected]: - resolution: {integrity: sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w==} + resolution: + { integrity: sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w== } dev: true /[email protected]: - resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==} - engines: {node: '>= 4.0.0'} + resolution: + { integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg== } + engines: { node: ">= 4.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==} - engines: {node: '>= 4.0.0'} + resolution: + { integrity: sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg== } + engines: { node: ">= 4.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==} - engines: {node: '>= 10.0.0'} + resolution: + { integrity: sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ== } + engines: { node: ">= 10.0.0" } dev: true /[email protected]: - resolution: {integrity: sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw== } + engines: { node: ">=8" } dev: true /[email protected]: - resolution: {integrity: sha512-1uEe95xksV1O0CYKXo8vQvN1JEbtJp7lb7C5U9HMsIp6IVwntkH/oNUzyVNQSd4S1sYk2FpSSW44FqMc8qee5w==} - engines: {node: '>=4'} + resolution: + { integrity: sha512-1uEe95xksV1O0CYKXo8vQvN1JEbtJp7lb7C5U9HMsIp6IVwntkH/oNUzyVNQSd4S1sYk2FpSSW44FqMc8qee5w== } + engines: { node: ">=4" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg==} + resolution: + { integrity: sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg== } hasBin: true peerDependencies: - browserslist: '>= 4.21.0' + browserslist: ">= 4.21.0" dependencies: browserslist: 4.22.2 escalade: 3.1.1 @@ -11685,125 +12979,147 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} + resolution: + { integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== } dependencies: punycode: 2.3.0 dev: true /[email protected]: - resolution: {integrity: sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==} + resolution: + { integrity: sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ== } dependencies: querystringify: 2.2.0 requires-port: 1.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} + resolution: + { integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== } dev: true /[email protected]: - resolution: {integrity: sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==} - engines: {node: '>= 0.4.0'} + resolution: + { integrity: sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA== } + engines: { node: ">= 0.4.0" } dev: true /[email protected]: - resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==} + resolution: + { integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg==} + resolution: + { integrity: sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg== } hasBin: true dev: true /[email protected]: - resolution: {integrity: sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==} + resolution: + { integrity: sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg== } dev: true /[email protected]: - resolution: {integrity: sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==} + resolution: + { integrity: sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA== } dev: true /[email protected]: - resolution: {integrity: sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==} + resolution: + { integrity: sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew== } dependencies: spdx-correct: 3.2.0 spdx-expression-parse: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-M6w37eVCMMouJ9V/sdPGnC5H4uDr73/+xdq0FBLO3TFFX1+7wiUY6Es328NN+y43tmY+doUdN9g9J21vqB7iLw==} + resolution: + { integrity: sha512-M6w37eVCMMouJ9V/sdPGnC5H4uDr73/+xdq0FBLO3TFFX1+7wiUY6Es328NN+y43tmY+doUdN9g9J21vqB7iLw== } dependencies: builtins: 1.0.3 dev: true /[email protected]: - resolution: {integrity: sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: builtins: 5.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-dk0gNeNL9fQFGd1VEhNDQfFlbCqAiksRh1H2tVPlavkH88n/a/y30rXi9PPKrYPTK5kEfPO4xcldt4ts/1wIAg==} + resolution: + { integrity: sha512-dk0gNeNL9fQFGd1VEhNDQfFlbCqAiksRh1H2tVPlavkH88n/a/y30rXi9PPKrYPTK5kEfPO4xcldt4ts/1wIAg== } dependencies: - '@sphinxxxx/color-conversion': 2.2.2 + "@sphinxxxx/color-conversion": 2.2.2 dev: true /[email protected]: - resolution: {integrity: sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==} - engines: {node: '>= 0.8'} + resolution: + { integrity: sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg== } + engines: { node: ">= 0.8" } dev: true /[email protected]: - resolution: {integrity: sha512-Dhxzh5HZuiHQhbvTW9AMetFfBHDMYpo23Uo9btPXgdYP+3T5S+p+jgNy7spra+veYhBP2dCSgxR/i2Y02h5/6w==} - engines: {node: '>=0.10.0'} + resolution: + { integrity: sha512-Dhxzh5HZuiHQhbvTW9AMetFfBHDMYpo23Uo9btPXgdYP+3T5S+p+jgNy7spra+veYhBP2dCSgxR/i2Y02h5/6w== } + engines: { node: ">=0.10.0" } dev: true /[email protected]: - resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + resolution: + { integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA== } dev: true /[email protected]: - resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==} + resolution: + { integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg== } dev: true /[email protected]: - resolution: {integrity: sha512-o8qghlI8NZHU1lLPrpi2+Uq7abh4GGPpYANlalzWxyWteJOCsr/P+oPBA49TOLu5FTZO4d3F9MnWJfiMo4BkmA==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-o8qghlI8NZHU1lLPrpi2+Uq7abh4GGPpYANlalzWxyWteJOCsr/P+oPBA49TOLu5FTZO4d3F9MnWJfiMo4BkmA== } + engines: { node: ">=18" } dependencies: xml-name-validator: 5.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg== } + engines: { node: ">=10.13.0" } dependencies: glob-to-regexp: 0.4.1 graceful-fs: 4.2.11 dev: true /[email protected]: - resolution: {integrity: sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==} + resolution: + { integrity: sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg== } dependencies: defaults: 1.0.4 dev: true /[email protected]: - resolution: {integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==} + resolution: + { integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ== } dev: true /[email protected]: - resolution: {integrity: sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-s3P7pgexgT/HTUSYgxJyn28A+99mmLq4HsJepMPzu0R8ImJc52QNqaFYW1Z2z2uIb1/J3eYgaAWVpaC+v/1aAQ==} - engines: {node: '>= 10.13.0'} + resolution: + { integrity: sha512-s3P7pgexgT/HTUSYgxJyn28A+99mmLq4HsJepMPzu0R8ImJc52QNqaFYW1Z2z2uIb1/J3eYgaAWVpaC+v/1aAQ== } + engines: { node: ">= 10.13.0" } hasBin: true dependencies: - '@discoveryjs/json-ext': 0.5.7 + "@discoveryjs/json-ext": 0.5.7 acorn: 8.10.0 acorn-walk: 8.2.0 commander: 7.2.0 @@ -11822,26 +13138,27 @@ packages: dev: true /[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-pIDJHIEI9LR0yxHXQ+Qh95k2EvXpWzZ5l+d+jIo+RdSm9MiHfzazIxwwni/p7+x4eJZuvG1AJwgC4TNQ7NRgsg==} - engines: {node: '>=14.15.0'} + resolution: + { integrity: sha512-pIDJHIEI9LR0yxHXQ+Qh95k2EvXpWzZ5l+d+jIo+RdSm9MiHfzazIxwwni/p7+x4eJZuvG1AJwgC4TNQ7NRgsg== } + engines: { node: ">=14.15.0" } hasBin: true peerDependencies: - '@webpack-cli/generators': '' + "@webpack-cli/generators": "" webpack: 5.x.x - webpack-bundle-analyzer: '' - webpack-dev-server: '' + webpack-bundle-analyzer: "" + webpack-dev-server: "" peerDependenciesMeta: - '@webpack-cli/generators': + "@webpack-cli/generators": optional: true webpack-bundle-analyzer: optional: true webpack-dev-server: optional: true dependencies: - '@discoveryjs/json-ext': 0.5.7 - '@webpack-cli/configtest': 2.1.1([email protected])([email protected]) - '@webpack-cli/info': 2.0.2([email protected])([email protected]) - '@webpack-cli/serve': 2.0.5([email protected])([email protected]) + "@discoveryjs/json-ext": 0.5.7 + "@webpack-cli/configtest": 2.1.1([email protected])([email protected]) + "@webpack-cli/info": 2.0.2([email protected])([email protected]) + "@webpack-cli/serve": 2.0.5([email protected])([email protected]) colorette: 2.0.20 commander: 10.0.1 cross-spawn: 7.0.3 @@ -11856,33 +13173,36 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-6NbRQw4+Sy50vYNTw7EyOn41OZItPiXB8GNv3INSoe3PSFaHJEz3SHTrYVaRm2LilNGnFUzh0FAwqPEmU/CwDg==} - engines: {node: '>=10.0.0'} + resolution: + { integrity: sha512-6NbRQw4+Sy50vYNTw7EyOn41OZItPiXB8GNv3INSoe3PSFaHJEz3SHTrYVaRm2LilNGnFUzh0FAwqPEmU/CwDg== } + engines: { node: ">=10.0.0" } dependencies: clone-deep: 4.0.1 wildcard: 2.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w== } + engines: { node: ">=10.13.0" } dev: true /[email protected]([email protected]): - resolution: {integrity: sha512-qyfIC10pOr70V+jkmud8tMfajraGCZMBWJtrmuBymQKCrLTRejBI8STDp1MCyZu/QTdZSeacCQYpYNQVOzX5kw==} - engines: {node: '>=10.13.0'} + resolution: + { integrity: sha512-qyfIC10pOr70V+jkmud8tMfajraGCZMBWJtrmuBymQKCrLTRejBI8STDp1MCyZu/QTdZSeacCQYpYNQVOzX5kw== } + engines: { node: ">=10.13.0" } hasBin: true peerDependencies: - webpack-cli: '' + webpack-cli: "" peerDependenciesMeta: webpack-cli: optional: true dependencies: - '@types/eslint-scope': 3.7.4 - '@types/estree': 1.0.1 - '@webassemblyjs/ast': 1.11.6 - '@webassemblyjs/wasm-edit': 1.11.6 - '@webassemblyjs/wasm-parser': 1.11.6 + "@types/eslint-scope": 3.7.4 + "@types/estree": 1.0.1 + "@webassemblyjs/ast": 1.11.6 + "@webassemblyjs/wasm-edit": 1.11.6 + "@webassemblyjs/wasm-parser": 1.11.6 acorn: 8.10.0 acorn-import-assertions: 1.9.0([email protected]) browserslist: 4.22.2 @@ -11904,40 +13224,45 @@ packages: webpack-cli: 5.1.4([email protected])([email protected]) webpack-sources: 3.2.3 transitivePeerDependencies: - - '@swc/core' + - "@swc/core" - esbuild - uglify-js dev: true /[email protected]: - resolution: {integrity: sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ== } + engines: { node: ">=18" } dependencies: iconv-lite: 0.6.3 dev: true /[email protected]: - resolution: {integrity: sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg== } + engines: { node: ">=18" } dev: true /[email protected]: - resolution: {integrity: sha512-1lfMEm2IEr7RIV+f4lUNPOqfFL+pO+Xw3fJSqmjX9AbXcXcYOkCe1P6+9VBZB6n94af16NfZf+sSk0JCBZC9aw==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-1lfMEm2IEr7RIV+f4lUNPOqfFL+pO+Xw3fJSqmjX9AbXcXcYOkCe1P6+9VBZB6n94af16NfZf+sSk0JCBZC9aw== } + engines: { node: ">=18" } dependencies: tr46: 5.0.0 webidl-conversions: 7.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==} + resolution: + { integrity: sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw== } dependencies: tr46: 0.0.3 webidl-conversions: 3.0.1 dev: true /[email protected]: - resolution: {integrity: sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==} + resolution: + { integrity: sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg== } dependencies: is-bigint: 1.0.4 is-boolean-object: 1.1.2 @@ -11947,12 +13272,14 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ==} + resolution: + { integrity: sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ== } dev: true /[email protected]: - resolution: {integrity: sha512-P5Nra0qjSncduVPEAr7xhoF5guty49ArDTwzJ/yNuPIbZppyRxFQsRCWrocxIY+CnMVG+qfbU2FmDKyvSGClow==} - engines: {node: '>= 0.4'} + resolution: + { integrity: sha512-P5Nra0qjSncduVPEAr7xhoF5guty49ArDTwzJ/yNuPIbZppyRxFQsRCWrocxIY+CnMVG+qfbU2FmDKyvSGClow== } + engines: { node: ">= 0.4" } dependencies: available-typed-arrays: 1.0.5 call-bind: 1.0.5 @@ -11962,34 +13289,39 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==} - engines: {node: '>= 8'} + resolution: + { integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== } + engines: { node: ">= 8" } hasBin: true dependencies: isexe: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } hasBin: true dependencies: isexe: 2.0.0 dev: true /[email protected]: - resolution: {integrity: sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==} + resolution: + { integrity: sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg== } dependencies: string-width: 4.2.3 dev: true /[email protected]: - resolution: {integrity: sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==} + resolution: + { integrity: sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ== } dev: true /[email protected]: - resolution: {integrity: sha512-YpZzcUzBedhlTAfJg6vJDlyEai/IFMIVcaEZZyl3UXIl4gmqRpU7AE89AHLkbzLUsv0NVmw7ts+iztqKxxPW1Q==} - engines: {node: '>= 6.4.0'} + resolution: + { integrity: sha512-YpZzcUzBedhlTAfJg6vJDlyEai/IFMIVcaEZZyl3UXIl4gmqRpU7AE89AHLkbzLUsv0NVmw7ts+iztqKxxPW1Q== } + engines: { node: ">= 6.4.0" } dependencies: logform: 2.5.1 readable-stream: 3.6.2 @@ -11997,11 +13329,12 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-L3yR6/MzZAOl0DsysUXHVjOwv8mKZ71TrA/41EIduGpOOV5LQVodqN+QdQ6BS6PJ/RdIshZhq84P/fStEZkk7g==} - engines: {node: '>= 12.0.0'} + resolution: + { integrity: sha512-L3yR6/MzZAOl0DsysUXHVjOwv8mKZ71TrA/41EIduGpOOV5LQVodqN+QdQ6BS6PJ/RdIshZhq84P/fStEZkk7g== } + engines: { node: ">= 12.0.0" } dependencies: - '@colors/colors': 1.6.0 - '@dabh/diagnostics': 2.0.3 + "@colors/colors": 1.6.0 + "@dabh/diagnostics": 2.0.3 async: 3.2.4 is-stream: 2.0.1 logform: 2.5.1 @@ -12014,26 +13347,30 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-RNGKj82nUPg3g5ygxkQl0R937xLyho1J24ItRCBTr/m1YnZkzJy1hUiHUJrc/VlsDQzsCnInEGSg3bci0Lmd4w==} - engines: {node: '>= 10.0.0'} + resolution: + { integrity: sha512-RNGKj82nUPg3g5ygxkQl0R937xLyho1J24ItRCBTr/m1YnZkzJy1hUiHUJrc/VlsDQzsCnInEGSg3bci0Lmd4w== } + engines: { node: ">= 10.0.0" } dependencies: - '@babel/parser': 7.23.0 - '@babel/types': 7.23.0 + "@babel/parser": 7.23.0 + "@babel/types": 7.23.0 assert-never: 1.2.1 babel-walk: 3.0.0-canary-5 dev: true /[email protected]: - resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} + resolution: + { integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q== } dev: true /[email protected]: - resolution: {integrity: sha512-ILEIE97kDZvF9Wb9f6h5aXK4swSlKGUcOEGiIYb2OOu/IrDU9iwj0fD//SsA6E5ibwJxpEvhullJY4Sl4GcpAw==} + resolution: + { integrity: sha512-ILEIE97kDZvF9Wb9f6h5aXK4swSlKGUcOEGiIYb2OOu/IrDU9iwj0fD//SsA6E5ibwJxpEvhullJY4Sl4GcpAw== } dev: true /[email protected]: - resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== } + engines: { node: ">=8" } dependencies: ansi-styles: 4.3.0 string-width: 4.2.3 @@ -12041,8 +13378,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== } + engines: { node: ">=10" } dependencies: ansi-styles: 4.3.0 string-width: 4.2.3 @@ -12050,8 +13388,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ== } + engines: { node: ">=12" } dependencies: ansi-styles: 6.2.1 string-width: 5.1.2 @@ -12059,11 +13398,13 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==} + resolution: + { integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== } dev: true /[email protected]: - resolution: {integrity: sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ==} + resolution: + { integrity: sha512-GaETH5wwsX+GcnzhPgKcKjJ6M2Cq3/iZp1WyY/X1CSqrW+jVNM9Y7D8EC2sM4ZG/V8wZlSniJnCKWPmBYAucRQ== } dependencies: graceful-fs: 4.2.11 imurmurhash: 0.1.4 @@ -12071,7 +13412,8 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==} + resolution: + { integrity: sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q== } dependencies: imurmurhash: 0.1.4 is-typedarray: 1.0.0 @@ -12080,16 +13422,18 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-+QU2zd6OTD8XWIJCbffaiQeH9U73qIqafo1x6V1snCWYGJf6cVE0cDR4D8xRzcEnfI21IFrUPzPGtcPf8AC+Rw==} - engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} + resolution: + { integrity: sha512-+QU2zd6OTD8XWIJCbffaiQeH9U73qIqafo1x6V1snCWYGJf6cVE0cDR4D8xRzcEnfI21IFrUPzPGtcPf8AC+Rw== } + engines: { node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0 } dependencies: imurmurhash: 0.1.4 signal-exit: 4.0.2 dev: true /[email protected]: - resolution: {integrity: sha512-3xZqT7Byc2uORAatYiP3DHUUAVEkNOswEWNs9H5KXiicRTvzYzYqKjYc4G7p+8pltvAw641lVByKVtMpf+4sYQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-3xZqT7Byc2uORAatYiP3DHUUAVEkNOswEWNs9H5KXiicRTvzYzYqKjYc4G7p+8pltvAw641lVByKVtMpf+4sYQ== } + engines: { node: ">=6" } dependencies: detect-indent: 5.0.0 graceful-fs: 4.2.11 @@ -12100,8 +13444,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-v2UQ+50TNf2rNHJ8NyWttfm/EJUBWMJcx6ZTYZr6Qp52uuegWw/lBkCtCbnYZEmPRNL61m+u67dAmGxo+HTULA==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-v2UQ+50TNf2rNHJ8NyWttfm/EJUBWMJcx6ZTYZr6Qp52uuegWw/lBkCtCbnYZEmPRNL61m+u67dAmGxo+HTULA== } + engines: { node: ">=8" } dependencies: sort-keys: 2.0.0 type-fest: 0.4.1 @@ -12109,8 +13454,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q==} - engines: {node: '>=8.3.0'} + resolution: + { integrity: sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q== } + engines: { node: ">=8.3.0" } peerDependencies: bufferutil: ^4.0.1 utf-8-validate: ^5.0.2 @@ -12122,11 +13468,12 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==} - engines: {node: '>=10.0.0'} + resolution: + { integrity: sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g== } + engines: { node: ">=10.0.0" } peerDependencies: bufferutil: ^4.0.1 - utf-8-validate: '>=5.0.2' + utf-8-validate: ">=5.0.2" peerDependenciesMeta: bufferutil: optional: true @@ -12135,62 +13482,74 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-EvGK8EJ3DhaHfbRlETOWAS5pO9MZITeauHKJyb8wyajUfQUenkIg2MvLDTZ4T/TgIcm3HU0TFBgWWboAZ30UHg==} - engines: {node: '>=18'} + resolution: + { integrity: sha512-EvGK8EJ3DhaHfbRlETOWAS5pO9MZITeauHKJyb8wyajUfQUenkIg2MvLDTZ4T/TgIcm3HU0TFBgWWboAZ30UHg== } + engines: { node: ">=18" } dev: true /[email protected]: - resolution: {integrity: sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==} + resolution: + { integrity: sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw== } dev: true /[email protected]: - resolution: {integrity: sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==} - engines: {node: '>=0.4'} + resolution: + { integrity: sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ== } + engines: { node: ">=0.4" } dev: true /[email protected]: - resolution: {integrity: sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==} + resolution: + { integrity: sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ== } dev: true /[email protected]: - resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} + resolution: + { integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== } dev: true /[email protected]: - resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} + resolution: + { integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== } dev: true /[email protected]: - resolution: {integrity: sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ== } + engines: { node: ">=6" } dependencies: camelcase: 5.3.1 decamelize: 1.2.0 dev: true /[email protected]: - resolution: {integrity: sha512-WOkpgNhPTlE73h4VFAFsOnomJVaovO8VqLDzy5saChRBFQFBoMYirowyW+Q9HB4HFF4Z7VZTiG3iSzJJA29yRA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-WOkpgNhPTlE73h4VFAFsOnomJVaovO8VqLDzy5saChRBFQFBoMYirowyW+Q9HB4HFF4Z7VZTiG3iSzJJA29yRA== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== } + engines: { node: ">=12" } dev: true /[email protected]: - resolution: {integrity: sha512-7pRTIA9Qc1caZ0bZ6RYRGbHJthJWuakf+WmHK0rVeLkNrrGhfoabBNdue6kdINI6r4if7ocq9aD/n7xwKOdzOA==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-7pRTIA9Qc1caZ0bZ6RYRGbHJthJWuakf+WmHK0rVeLkNrrGhfoabBNdue6kdINI6r4if7ocq9aD/n7xwKOdzOA== } + engines: { node: ">=10" } dependencies: camelcase: 6.3.0 decamelize: 4.0.0 @@ -12199,8 +13558,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A==} - engines: {node: '>=8'} + resolution: + { integrity: sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A== } + engines: { node: ">=8" } dependencies: cliui: 6.0.0 decamelize: 1.2.0 @@ -12216,8 +13576,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw== } + engines: { node: ">=10" } dependencies: cliui: 7.0.4 escalade: 3.1.1 @@ -12229,8 +13590,9 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==} - engines: {node: '>=12'} + resolution: + { integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w== } + engines: { node: ">=12" } dependencies: cliui: 8.0.1 escalade: 3.1.1 @@ -12242,23 +13604,27 @@ packages: dev: true /[email protected]: - resolution: {integrity: sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g==} + resolution: + { integrity: sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g== } dependencies: buffer-crc32: 0.2.13 fd-slicer: 1.1.0 dev: true /[email protected]: - resolution: {integrity: sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==} - engines: {node: '>=6'} + resolution: + { integrity: sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q== } + engines: { node: ">=6" } dev: true /[email protected]: - resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} - engines: {node: '>=10'} + resolution: + { integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== } + engines: { node: ">=10" } dev: true /[email protected]: - resolution: {integrity: sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==} - engines: {node: '>=12.20'} + resolution: + { integrity: sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g== } + engines: { node: ">=12.20" } dev: true
chore(fireworks): improved fireworks preset	85358c9b8c5a913e22d3d45c21d484c09934521f	chore	https://github.com/tsparticles/tsparticles/commit/85358c9b8c5a913e22d3d45c21d484c09934521f	improved fireworks preset	[email protected]	diff --git a/fireworks.pug b/fireworks.pug index b259aeb..0975d8c 100644 --- a/fireworks.pug +++ b/fireworks.pug @@ -36,6 +36,7 @@ html(lang="en") script(src="/updater-opacity/tsparticles.updater.opacity.min.js") script(src="/updater-out-modes/tsparticles.updater.out-modes.min.js") script(src="/updater-size/tsparticles.updater.size.min.js") + script(src="/updater-stroke-color/tsparticles.updater.stroke-color.min.js") script(src="/preset-fireworks/tsparticles.preset.fireworks.min.js") script. (async () => { diff --git a/options.ts b/options.ts index 5a0c370..500f0cc 100644 --- a/options.ts +++ b/options.ts @@ -35,8 +35,8 @@ const fireworksOptions: RecursivePartial<IParticlesOptions>[] = ["#ff595e", "#ff } const hsl = rgbToHsl(rgb), - sRange = fixRange({ min: hsl.s - 20, max: hsl.s + 20 }, 0, 100), - lRange = fixRange({ min: hsl.l - 20, max: hsl.l + 20 }, 0, 100); + sRange = fixRange({ min: hsl.s - 30, max: hsl.s + 30 }, 0, 100), + lRange = fixRange({ min: hsl.l - 30, max: hsl.l + 30 }, 0, 100); return { color: { @@ -52,9 +52,6 @@ const fireworksOptions: RecursivePartial<IParticlesOptions>[] = ["#ff595e", "#ff number: { value: 0, }, - collisions: { - enable: false, - }, opacity: { value: { min: 0.1, @@ -92,14 +89,14 @@ const fireworksOptions: RecursivePartial<IParticlesOptions>[] = ["#ff595e", "#ff }, }, move: { - decay: 0.05, + decay: { min: 0.075, max: 0.1 }, enable: true, gravity: { enable: true, inverse: false, acceleration: 5, }, - speed: { min: 5, max: 10 }, + speed: { min: 5, max: 15 }, direction: "none", outModes: OutMode.destroy, }, @@ -121,7 +118,7 @@ export const options: ISourceOptions = { delay: 0.1, }, rate: { - delay: 0.15, + delay: 0.05, quantity: 1, }, size: { @@ -139,13 +136,17 @@ export const options: ISourceOptions = { }, destroy: { mode: "split", + bounds: { + top: { min: 10, max: 30 }, + }, split: { + sizeOffset: false, count: 1, factor: { value: 0.333333, }, rate: { - value: 100, + value: { min: 75, max: 150 }, }, particles: fireworksOptions, },
fix: speedup HEAD detection in `is_git()` Previously it would always check with a `store` which has a fuzzy search right now. Instead, we check once ourselves before trying to read HEAD for validation.	761324953a20d061f859c995180d603bb3734f9a	fix	https://github.com/Byron/gitoxide/commit/761324953a20d061f859c995180d603bb3734f9a	speedup HEAD detection in `is_git()` Previously it would always check with a `store` which has a fuzzy search right now. Instead, we check once ourselves before trying to read HEAD for validation.	[email protected]	diff --git a/is.rs b/is.rs index 676ee4b..e5f0ab1 100644 --- a/is.rs +++ b/is.rs @@ -98,6 +98,11 @@ pub fn git(git_dir: impl AsRef<Path>) -> Result<crate::repository::Kind, crate:: }; { + // Fast-path: avoid doing the complete search if HEAD is already not there. + // TODO(reftable): use a ref-store to lookup HEAD if ref-tables should be supported, or detect ref-tables beforehand. + if !dot_git.join("HEAD").exists() { + return Err(crate::is_git::Error::MissingHead); + } // We expect to be able to parse any ref-hash, so we shouldn't have to know the repos hash here. // With ref-table, the has is probably stored as part of the ref-db itself, so we can handle it from there. // In other words, it's important not to fail on detached heads here because we guessed the hash kind wrongly. diff --git a/lib.rs b/lib.rs index f6edc92..138d76f 100644 --- a/lib.rs +++ b/lib.rs @@ -23,6 +23,8 @@ pub mod is_git { pub enum Error { #[error("Could not find a valid HEAD reference")] FindHeadRef(#[from] gix_ref::file::find::existing::Error), + #[error("Missing HEAD at '.git/HEAD'")] + MissingHead, #[error("Expected HEAD at '.git/HEAD', got '.git/{}'", .name)] MisplacedHead { name: bstr::BString }, #[error("Expected an objects directory at '{}'", .missing.display())]
build: refactoring	8986cd6ceff65d59d20dab19d0bab923c2245615	build	https://github.com/tsparticles/tsparticles/commit/8986cd6ceff65d59d20dab19d0bab923c2245615	refactoring	[email protected]	diff --git a/Particles.ts b/Particles.ts index e5b3464..48b079e 100644 --- a/Particles.ts +++ b/Particles.ts @@ -262,27 +262,9 @@ export class Particles { let deleted = 0; for (let i = index; deleted < quantity && i < this.count; i++) { - const particle = this._array[i]; - - if (!particle \|\| particle.group !== group) { - continue; + if (this._removeParticle(i--, group, override)) { + deleted++; } - - particle.destroy(override); - - this._array.splice(i--, 1); - const zIdx = this._zArray.indexOf(particle); - this._zArray.splice(zIdx, 1); - this.pool.push(particle); - - deleted++; - - this._engine.dispatchEvent(EventType.particleRemoved, { - container: this._container, - data: { - particle, - }, - }); } } @@ -452,4 +434,33 @@ export class Particles { return; } }; + + private readonly _removeParticle: (index: number, group?: string, override?: boolean) => boolean = ( + index, + group, + override + ) => { + const particle = this._array[index]; + + if (!particle \|\| particle.group !== group) { + return false; + } + + particle.destroy(override); + + const zIdx = this._zArray.indexOf(particle); + + this._array.splice(index, 1); + this._zArray.splice(zIdx, 1); + this.pool.push(particle); + + this._engine.dispatchEvent(EventType.particleRemoved, { + container: this._container, + data: { + particle, + }, + }); + + return true; + }; }
build: updated deps	6383522425164d30b575468cf5053fd5b67df80f	build	https://github.com/tsparticles/tsparticles/commit/6383522425164d30b575468cf5053fd5b67df80f	updated deps	[email protected]	diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8c61dfc..db6822c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1321,8 +1321,8 @@ importers: utils/options-updater: dependencies: '@tsparticles/eslint-config': - specifier: ^1.15.0 - version: 1.15.0 + specifier: ^1.17.0 + version: 1.17.0 '@tsparticles/prettier-config': specifier: ^1.11.0 version: 1.11.0 @@ -1330,14 +1330,14 @@ importers: specifier: ^1.14.0 version: 1.14.0 '@tsparticles/webpack-plugin': - specifier: ^1.17.1 - version: 1.17.1 + specifier: ^1.20.0 + version: 1.20.0 '@typescript-eslint/eslint-plugin': - specifier: ^5.61.0 - version: 5.61.0(@typescript-eslint/[email protected])([email protected])([email protected]) + specifier: ^6.0.0 + version: 6.0.0(@typescript-eslint/[email protected])([email protected])([email protected]) '@typescript-eslint/parser': - specifier: ^5.61.0 - version: 5.61.0([email protected])([email protected]) + specifier: ^6.0.0 + version: 6.0.0([email protected])([email protected]) eslint: specifier: ^8.44.0 version: 8.44.0 @@ -1571,8 +1571,8 @@ importers: version: 5.88.1([email protected]) devDependencies: '@types/eslint': - specifier: ^8.40.2 - version: 8.40.2 + specifier: ^8.44.0 + version: 8.44.0 '@types/fs-extra': specifier: ^11.0.1 version: 11.0.1 @@ -1586,8 +1586,8 @@ importers: specifier: ^4.14.195 version: 4.14.195 '@types/node': - specifier: ^20.4.0 - version: 20.4.0 + specifier: ^20.4.1 + version: 20.4.1 packages: @@ -1616,29 +1616,6 @@ packages: resolution: {integrity: sha512-29tfsWTq2Ftu7MXmimyC0C5FDZv5DYxOZkh3XD3+QW4V/BYuv/LyEsjj3c0hqedEaDt6DBfDvexMKU8YevdqFg==} engines: {node: '>=6.9.0'} - /@babel/[email protected]: - resolution: {integrity: sha512-exABdCVjEk8+IFJW0gOK6+cou8VKMXfbkLGeK5Xdsa5MsuQmem1SsnnZ+6avm2gRhZ4M7UgAnE6YoAzVg9P/pw==} - engines: {node: '>=6.9.0'} - dependencies: - '@ampproject/remapping': 2.2.1 - '@babel/code-frame': 7.22.5 - '@babel/generator': 7.22.7 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-module-transforms': 7.22.5 - '@babel/helpers': 7.22.6 - '@babel/parser': 7.22.7 - '@babel/template': 7.22.5 - '@babel/traverse': 7.22.7 - '@babel/types': 7.22.5 - '@nicolo-ribaudo/semver-v6': 6.3.3 - convert-source-map: 1.9.0 - debug: 4.3.4([email protected]) - gensync: 1.0.0-beta.2 - json5: 2.2.3 - transitivePeerDependencies: - - supports-color - dev: false - /@babel/[email protected]: resolution: {integrity: sha512-75+KxFB4CZqYRXjx4NlR4J7yGvKumBuZTmV4NV6v09dVXXkuYVYLT68N6HCzLvfJ+fWCxQsntNzKwwIXL4bHnw==} engines: {node: '>=6.9.0'} @@ -1660,7 +1637,6 @@ packages: json5: 2.2.3 transitivePeerDependencies: - supports-color - dev: true /@babel/[email protected]: resolution: {integrity: sha512-p+jPjMG+SI8yvIaxGgeW24u7q9+5+TGpZh8/CuB7RhBKd7RCy8FayNEFNNKrNK/eUcY/4ExQqLmyrvBXKsIcwQ==} @@ -1689,20 +1665,6 @@ packages: dependencies: '@babel/types': 7.22.5 - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-534sYEqWD9VfUm3IPn2SLcH4Q3P86XL+QvqdC7ZsFrzyyPF3T4XGiVghF6PTYNdWg6pXuoqXxNQAhbYeEInTzA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/compat-data': 7.22.6 - '@babel/core': 7.22.7 - '@babel/helper-validator-option': 7.22.5 - '@nicolo-ribaudo/semver-v6': 6.3.3 - browserslist: 4.21.9 - lru-cache: 5.1.1 - dev: false - /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-534sYEqWD9VfUm3IPn2SLcH4Q3P86XL+QvqdC7ZsFrzyyPF3T4XGiVghF6PTYNdWg6pXuoqXxNQAhbYeEInTzA==} engines: {node: '>=6.9.0'} @@ -1715,27 +1677,6 @@ packages: '@nicolo-ribaudo/semver-v6': 6.3.3 browserslist: 4.21.9 lru-cache: 5.1.1 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-iwdzgtSiBxF6ni6mzVnZCF3xt5qE6cEA0J7nFt8QOAWZ0zjCFceEgpn3vtb2V7WFR6QzP2jmIFOHMTRo7eNJjQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-environment-visitor': 7.22.5 - '@babel/helper-function-name': 7.22.5 - '@babel/helper-member-expression-to-functions': 7.22.5 - '@babel/helper-optimise-call-expression': 7.22.5 - '@babel/helper-replace-supers': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 - '@nicolo-ribaudo/semver-v6': 6.3.3 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-iwdzgtSiBxF6ni6mzVnZCF3xt5qE6cEA0J7nFt8QOAWZ0zjCFceEgpn3vtb2V7WFR6QzP2jmIFOHMTRo7eNJjQ==} @@ -1755,19 +1696,6 @@ packages: '@nicolo-ribaudo/semver-v6': 6.3.3 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-zGuSdedkFtsFHGbexAvNuipg1hbtitDLo2XE8/uf6Y9sOQV1xsYX/2pNbtedp/X0eU1pIt+kGvaqHCowkRbS5g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.18.6 - regexpu-core: 5.3.2 - semver: 6.3.0 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-zGuSdedkFtsFHGbexAvNuipg1hbtitDLo2XE8/uf6Y9sOQV1xsYX/2pNbtedp/X0eU1pIt+kGvaqHCowkRbS5g==} @@ -1779,19 +1707,6 @@ packages: '@babel/helper-annotate-as-pure': 7.18.6 regexpu-core: 5.3.2 semver: 6.3.0 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-nBookhLKxAWo/TUCmhnaEJyLz2dekjQvv5SRpE9epWQBcpedWLKt8aZdsuT9XV5ovzR3fENLjRXVT0GsSlGGhA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.22.5 - '@nicolo-ribaudo/semver-v6': 6.3.3 - regexpu-core: 5.3.2 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-nBookhLKxAWo/TUCmhnaEJyLz2dekjQvv5SRpE9epWQBcpedWLKt8aZdsuT9XV5ovzR3fENLjRXVT0GsSlGGhA==} @@ -1803,22 +1718,6 @@ packages: '@babel/helper-annotate-as-pure': 7.22.5 '@nicolo-ribaudo/semver-v6': 6.3.3 regexpu-core: 5.3.2 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-kX4oXixDxG197yhX+J3Wp+NpL2wuCFjWQAr6yX2jtCnflK9ulMI51ULFGIrWiX1jGfvAxdHp+XQCcP2bZGPs9A==} - peerDependencies: - '@babel/core': ^7.4.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - debug: 4.3.4([email protected]) - lodash.debounce: 4.0.8 - resolve: 1.22.2 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-kX4oXixDxG197yhX+J3Wp+NpL2wuCFjWQAr6yX2jtCnflK9ulMI51ULFGIrWiX1jGfvAxdHp+XQCcP2bZGPs9A==} @@ -1833,7 +1732,6 @@ packages: resolve: 1.22.2 transitivePeerDependencies: - supports-color - dev: true /@babel/[email protected]: resolution: {integrity: sha512-XGmhECfVA/5sAt+H+xpSg0mfrHq6FzNr9Oxh7PSEBBRUb/mL7Kz3NICXb194rCqAEdxkhPT1a88teizAFyvk8Q==} @@ -1893,21 +1791,6 @@ packages: resolution: {integrity: sha512-uLls06UVKgFG9QD4OeFYLEGteMIAa5kpTPcFL28yuCIIzsf6ZyKZMllKVOCZFhiZ5ptnwX4mtKdWCBE/uT4amg==} engines: {node: '>=6.9.0'} - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-cU0Sq1Rf4Z55fgz7haOakIyM7+x/uCFwXpLPaeRzfoUtAEAuUZjZvFPjL/rk5rW693dIgn2hng1W7xbT7lWT4g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-environment-visitor': 7.22.5 - '@babel/helper-wrap-function': 7.22.5 - '@babel/types': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false - /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-cU0Sq1Rf4Z55fgz7haOakIyM7+x/uCFwXpLPaeRzfoUtAEAuUZjZvFPjL/rk5rW693dIgn2hng1W7xbT7lWT4g==} engines: {node: '>=6.9.0'} @@ -1921,7 +1804,6 @@ packages: '@babel/types': 7.22.5 transitivePeerDependencies: - supports-color - dev: true /@babel/[email protected]: resolution: {integrity: sha512-aLdNM5I3kdI/V9xGNyKSF3X/gTyMUBohTZ+/3QdQKAA9vxIiy12E+8E2HoOP1/DjeqU+g6as35QHJNMDDYpuCg==} @@ -2002,16 +1884,6 @@ packages: dependencies: '@babel/types': 7.22.5 - /@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.22.5(@babel/[email protected]): - resolution: {integrity: sha512-NP1M5Rf+u2Gw9qfSO4ihjcTGW5zXTi36ITLd4/EoAcEhIZ0yjMqmftDNl3QC19CX7olhrjpyU454g/2W7X0jvQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false - /@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.22.5(@babel/[email protected]): resolution: {integrity: sha512-NP1M5Rf+u2Gw9qfSO4ihjcTGW5zXTi36ITLd4/EoAcEhIZ0yjMqmftDNl3QC19CX7olhrjpyU454g/2W7X0jvQ==} engines: {node: '>=6.9.0'} @@ -2020,19 +1892,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-31Bb65aZaUwqCbWMnZPduIZxCBngHFlzyN6Dq6KAJjtx+lx6ohKHubc61OomYi7XwVD4Ol0XCVz4h+pYFR048g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.13.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/plugin-transform-optional-chaining': 7.22.6(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-31Bb65aZaUwqCbWMnZPduIZxCBngHFlzyN6Dq6KAJjtx+lx6ohKHubc61OomYi7XwVD4Ol0XCVz4h+pYFR048g==} @@ -2044,16 +1903,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 '@babel/plugin-transform-optional-chaining': 7.22.6(@babel/[email protected]) - dev: true - - /@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2(@babel/[email protected]): - resolution: {integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - dev: false /@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2(@babel/[email protected]): resolution: {integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==} @@ -2062,18 +1911,6 @@ packages: '@babel/core': ^7.0.0-0 dependencies: '@babel/core': 7.22.8 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-2BShG/d5yoZyXZfVePH91urL5wTG6ASZU9M4o03lKK8u8UW1y08OMttBSOADTcJrnPMpvDXRG3G8fyLh4ovs8w==} - engines: {node: '>=4'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.21.8(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.21.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-2BShG/d5yoZyXZfVePH91urL5wTG6ASZU9M4o03lKK8u8UW1y08OMttBSOADTcJrnPMpvDXRG3G8fyLh4ovs8w==} @@ -2084,16 +1921,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.21.8(@babel/[email protected]) '@babel/helper-plugin-utils': 7.21.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==} @@ -2102,16 +1929,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==} @@ -2120,17 +1937,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==} @@ -2140,16 +1946,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==} @@ -2158,16 +1954,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==} @@ -2176,17 +1962,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-rdV97N7KqsRzeNGoWUOK6yUsWarLjE5Su/Snk9IYPU9CwkWHs4t+rTGOvffTR8XGkJMTAdLfO0xVnXm8wugIJg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-rdV97N7KqsRzeNGoWUOK6yUsWarLjE5Su/Snk9IYPU9CwkWHs4t+rTGOvffTR8XGkJMTAdLfO0xVnXm8wugIJg==} @@ -2196,17 +1971,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-KwvoWDeNKPETmozyFE0P2rOLqh39EoQHNjqizrI5B8Vt0ZNS7M56s7dAiAqbYfiAYOuIzIh96z3iR2ktgu3tEg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-KwvoWDeNKPETmozyFE0P2rOLqh39EoQHNjqizrI5B8Vt0ZNS7M56s7dAiAqbYfiAYOuIzIh96z3iR2ktgu3tEg==} @@ -2216,16 +1980,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==} @@ -2234,16 +1988,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.21.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==} @@ -2252,16 +1996,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.21.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.21.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==} @@ -2270,16 +2004,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.21.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==} @@ -2288,16 +2012,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==} @@ -2306,16 +2020,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==} @@ -2324,16 +2028,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.21.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==} @@ -2342,16 +2036,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.21.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.21.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==} @@ -2360,17 +2044,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.21.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==} @@ -2380,19 +2053,8 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false - - /@babel/[email protected](@babel/[email protected]): + /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==} engines: {node: '>=6.9.0'} peerDependencies: @@ -2400,18 +2062,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==} @@ -2422,17 +2072,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-26lTNXoVRdAnsaDXPpvCNUq+OVWEVC6bx7Vvz9rC53F2bagUWW4u4ii2+h8Fejfh7RYqPxn+libeFBBck9muEw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-26lTNXoVRdAnsaDXPpvCNUq+OVWEVC6bx7Vvz9rC53F2bagUWW4u4ii2+h8Fejfh7RYqPxn+libeFBBck9muEw==} @@ -2442,22 +2081,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-7HmE7pk/Fmke45TODvxvkxRMV9RazV+ZZzhOL9AG8G29TLrr3jkjwF7uJfxZ30EoXpO+LJkq4oA8NjO2DTnEDg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-environment-visitor': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-remap-async-to-generator': 7.22.5(@babel/[email protected]) - '@babel/plugin-syntax-async-generators': 7.8.4(@babel/[email protected]) - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-7HmE7pk/Fmke45TODvxvkxRMV9RazV+ZZzhOL9AG8G29TLrr3jkjwF7uJfxZ30EoXpO+LJkq4oA8NjO2DTnEDg==} @@ -2472,21 +2095,6 @@ packages: '@babel/plugin-syntax-async-generators': 7.8.4(@babel/[email protected]) transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-b1A8D8ZzE/VhNDoV1MSJTnpKkCG5bJo+19R4o4oy03zM7ws8yEMK755j61Dc3EyvdysbqH5BOOTquJ7ZX9C6vQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-module-imports': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-remap-async-to-generator': 7.22.5(@babel/[email protected]) - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-b1A8D8ZzE/VhNDoV1MSJTnpKkCG5bJo+19R4o4oy03zM7ws8yEMK755j61Dc3EyvdysbqH5BOOTquJ7ZX9C6vQ==} @@ -2500,17 +2108,6 @@ packages: '@babel/helper-remap-async-to-generator': 7.22.5(@babel/[email protected]) transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-tdXZ2UdknEKQWKJP1KMNmuF5Lx3MymtMN/pvA+p/VEkhK8jVcQ1fzSy8KM9qRYhAf2/lV33hoMPKI/xaI9sADA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-tdXZ2UdknEKQWKJP1KMNmuF5Lx3MymtMN/pvA+p/VEkhK8jVcQ1fzSy8KM9qRYhAf2/lV33hoMPKI/xaI9sADA==} @@ -2520,17 +2117,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-EcACl1i5fSQ6bt+YGuU/XGCeZKStLmyVGytWkpyhCLeQVA0eu6Wtiw92V+I1T/hnezUv7j74dA/Ro69gWcU+hg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-EcACl1i5fSQ6bt+YGuU/XGCeZKStLmyVGytWkpyhCLeQVA0eu6Wtiw92V+I1T/hnezUv7j74dA/Ro69gWcU+hg==} @@ -2540,20 +2126,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-nDkQ0NfkOhPTq8YCLiWNxp1+f9fCobEjCb0n8WdbNUBc4IB5V7P1QnX9IjpSoquKrXF5SKojHleVNs2vGeHCHQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-class-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-nDkQ0NfkOhPTq8YCLiWNxp1+f9fCobEjCb0n8WdbNUBc4IB5V7P1QnX9IjpSoquKrXF5SKojHleVNs2vGeHCHQ==} @@ -2566,21 +2138,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-SPToJ5eYZLxlnp1UzdARpOGeC2GbHvr9d/UV0EukuVx8atktg194oe+C5BqQ8jRTkgLRVOPYeXRSBg1IlMoVRA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.12.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-class-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/[email protected]) - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-SPToJ5eYZLxlnp1UzdARpOGeC2GbHvr9d/UV0EukuVx8atktg194oe+C5BqQ8jRTkgLRVOPYeXRSBg1IlMoVRA==} @@ -2594,27 +2151,6 @@ packages: '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/[email protected]) transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-58EgM6nuPNG6Py4Z3zSuu0xWu2VfodiMi72Jt5Kj2FECmaYk1RrTXA45z6KBFsu9tRgwQDwIiY4FXTt+YsSFAQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-environment-visitor': 7.22.5 - '@babel/helper-function-name': 7.22.5 - '@babel/helper-optimise-call-expression': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-replace-supers': 7.22.5 - '@babel/helper-split-export-declaration': 7.22.6 - globals: 11.12.0 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-58EgM6nuPNG6Py4Z3zSuu0xWu2VfodiMi72Jt5Kj2FECmaYk1RrTXA45z6KBFsu9tRgwQDwIiY4FXTt+YsSFAQ==} @@ -2634,18 +2170,6 @@ packages: globals: 11.12.0 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-4GHWBgRf0krxPX+AaPtgBAlTgTeZmqDynokHOX7aqqAB4tHs3U2Y02zH6ETFdLZGcg9UQSD1WCmkVrE9ErHeOg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/template': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-4GHWBgRf0krxPX+AaPtgBAlTgTeZmqDynokHOX7aqqAB4tHs3U2Y02zH6ETFdLZGcg9UQSD1WCmkVrE9ErHeOg==} @@ -2656,17 +2180,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/template': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-GfqcFuGW8vnEqTUBM7UtPd5A4q797LTvvwKxXTgRsFjoqaJiEg9deBG6kWeQYkVEL569NpnmpC0Pkr/8BLKGnQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-GfqcFuGW8vnEqTUBM7UtPd5A4q797LTvvwKxXTgRsFjoqaJiEg9deBG6kWeQYkVEL569NpnmpC0Pkr/8BLKGnQ==} @@ -2676,18 +2189,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5/Yk9QxCQCl+sOIB1WelKnVRxTJDSAIxtJLL2/pqL14ZVlbH0fUQUZa/T5/UnQtBNgghR7mfB8ERBKyKPCi7Vw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-5/Yk9QxCQCl+sOIB1WelKnVRxTJDSAIxtJLL2/pqL14ZVlbH0fUQUZa/T5/UnQtBNgghR7mfB8ERBKyKPCi7Vw==} @@ -2698,17 +2199,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-dEnYD+9BBgld5VBXHnF/DbYGp3fqGMsyxKbtD1mDyIA7AkTSpKXFhCVuj/oQVOoALfBs77DudA0BE4d5mcpmqw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-dEnYD+9BBgld5VBXHnF/DbYGp3fqGMsyxKbtD1mDyIA7AkTSpKXFhCVuj/oQVOoALfBs77DudA0BE4d5mcpmqw==} @@ -2718,18 +2208,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-0MC3ppTB1AMxd8fXjSrbPa7LT9hrImt+/fcj+Pg5YMD7UQyWp/02+JWpdnCymmsXwIx5Z+sYn1bwCn4ZJNvhqQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-0MC3ppTB1AMxd8fXjSrbPa7LT9hrImt+/fcj+Pg5YMD7UQyWp/02+JWpdnCymmsXwIx5Z+sYn1bwCn4ZJNvhqQ==} @@ -2740,18 +2218,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vIpJFNM/FjZ4rh1myqIya9jXwrwwgFRHPjT3DkUA9ZLHuzox8jiXkOLvwm1H+PQIP3CqfC++WPKeuDi0Sjdj1g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-builder-binary-assignment-operator-visitor': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-vIpJFNM/FjZ4rh1myqIya9jXwrwwgFRHPjT3DkUA9ZLHuzox8jiXkOLvwm1H+PQIP3CqfC++WPKeuDi0Sjdj1g==} @@ -2762,18 +2228,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-builder-binary-assignment-operator-visitor': 7.22.5 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-X4hhm7FRnPgd4nDA4b/5V280xCx6oL7Oob5+9qVS5C13Zq4bh1qq7LU0GgRU6b5dBWBvhGaXYVB4AcN6+ol6vg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-X4hhm7FRnPgd4nDA4b/5V280xCx6oL7Oob5+9qVS5C13Zq4bh1qq7LU0GgRU6b5dBWBvhGaXYVB4AcN6+ol6vg==} @@ -2784,17 +2238,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-3kxQjX1dU9uudwSshyLeEipvrLjBCVthCgeTp6CzE/9JYrlAIaeekVxRpCWsDDfYTfRZRoCeZatCQvwo+wvK8A==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-3kxQjX1dU9uudwSshyLeEipvrLjBCVthCgeTp6CzE/9JYrlAIaeekVxRpCWsDDfYTfRZRoCeZatCQvwo+wvK8A==} @@ -2804,19 +2247,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-UIzQNMS0p0HHiQm3oelztj+ECwFnj+ZRV4KnguvlsD2of1whUeM6o7wGNj6oLwcDoAXQ8gEqfgC24D+VdIcevg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-function-name': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-UIzQNMS0p0HHiQm3oelztj+ECwFnj+ZRV4KnguvlsD2of1whUeM6o7wGNj6oLwcDoAXQ8gEqfgC24D+VdIcevg==} @@ -2828,18 +2258,6 @@ packages: '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) '@babel/helper-function-name': 7.22.5 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-DuCRB7fu8MyTLbEQd1ew3R85nx/88yMoqo2uPSjevMj3yoN7CDM8jkgrY0wmVxfJZyJ/B9fE1iq7EQppWQmR5A==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-json-strings': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-DuCRB7fu8MyTLbEQd1ew3R85nx/88yMoqo2uPSjevMj3yoN7CDM8jkgrY0wmVxfJZyJ/B9fE1iq7EQppWQmR5A==} @@ -2850,17 +2268,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-json-strings': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-fTLj4D79M+mepcw3dgFBTIDYpbcB9Sm0bpm4ppXPaO+U+PKFFyV9MGRvS0gvGw62sd10kT5lRMKXAADb9pWy8g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-fTLj4D79M+mepcw3dgFBTIDYpbcB9Sm0bpm4ppXPaO+U+PKFFyV9MGRvS0gvGw62sd10kT5lRMKXAADb9pWy8g==} @@ -2870,18 +2277,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-MQQOUW1KL8X0cDWfbwYP+TbVbZm16QmQXJQ+vndPtH/BoO0lOKpVoEDMI7+PskYxH+IiE0tS8xZye0qr1lGzSA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-MQQOUW1KL8X0cDWfbwYP+TbVbZm16QmQXJQ+vndPtH/BoO0lOKpVoEDMI7+PskYxH+IiE0tS8xZye0qr1lGzSA==} @@ -2892,17 +2287,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-RZEdkNtzzYCFl9SE9ATaUMTj2hqMb4StarOJLrZRbqqU4HSBE7UlBw9WBWQiDzrJZJdUWiMTVDI6Gv/8DPvfew==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-RZEdkNtzzYCFl9SE9ATaUMTj2hqMb4StarOJLrZRbqqU4HSBE7UlBw9WBWQiDzrJZJdUWiMTVDI6Gv/8DPvfew==} @@ -2912,20 +2296,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-R+PTfLTcYEmb1+kK7FNkhQ1gP4KgjpSO6HfH9+f8/yfp2Nt3ggBjiVpRwmwTlfqZLafYKJACy36yDXlEmI9HjQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-module-transforms': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-R+PTfLTcYEmb1+kK7FNkhQ1gP4KgjpSO6HfH9+f8/yfp2Nt3ggBjiVpRwmwTlfqZLafYKJACy36yDXlEmI9HjQ==} @@ -2938,21 +2308,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-B4pzOXj+ONRmuaQTg05b3y/4DuFz3WcCNAXPLb2Q0GT0TrGKGxNKV4jwsXts+StaM0LQczZbOpj8o1DLPDJIiA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-module-transforms': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-simple-access': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-B4pzOXj+ONRmuaQTg05b3y/4DuFz3WcCNAXPLb2Q0GT0TrGKGxNKV4jwsXts+StaM0LQczZbOpj8o1DLPDJIiA==} @@ -2966,22 +2321,6 @@ packages: '@babel/helper-simple-access': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-emtEpoaTMsOs6Tzz+nbmcePl6AKVtS1yC4YNAeMun9U8YCsgadPNxnOPQ8GhHFB2qdx+LZu9LgoC0Lthuu05DQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-hoist-variables': 7.22.5 - '@babel/helper-module-transforms': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-validator-identifier': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-emtEpoaTMsOs6Tzz+nbmcePl6AKVtS1yC4YNAeMun9U8YCsgadPNxnOPQ8GhHFB2qdx+LZu9LgoC0Lthuu05DQ==} @@ -2996,20 +2335,6 @@ packages: '@babel/helper-validator-identifier': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-+S6kzefN/E1vkSsKx8kmQuqeQsvCKCd1fraCM7zXm4SFoggI099Tr4G8U81+5gtMdUeMQ4ipdQffbKLX0/7dBQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-module-transforms': 7.22.5 - '@babel/helper-plugin-utils': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-+S6kzefN/E1vkSsKx8kmQuqeQsvCKCd1fraCM7zXm4SFoggI099Tr4G8U81+5gtMdUeMQ4ipdQffbKLX0/7dBQ==} @@ -3022,18 +2347,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ==} @@ -3044,17 +2357,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-AsF7K0Fx/cNKVyk3a+DW0JLo+Ua598/NxMRvxDnkpCIGFh43+h/v2xyhRUYf6oD8gE4QtL83C7zZVghMjHd+iw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-AsF7K0Fx/cNKVyk3a+DW0JLo+Ua598/NxMRvxDnkpCIGFh43+h/v2xyhRUYf6oD8gE4QtL83C7zZVghMjHd+iw==} @@ -3064,18 +2366,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-6CF8g6z1dNYZ/VXok5uYkkBBICHZPiGEl7oDnAx2Mt1hlHVHOSIKWJaXHjQJA5VB43KZnXZDIexMchY4y2PGdA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-6CF8g6z1dNYZ/VXok5uYkkBBICHZPiGEl7oDnAx2Mt1hlHVHOSIKWJaXHjQJA5VB43KZnXZDIexMchY4y2PGdA==} @@ -3086,18 +2376,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-NbslED1/6M+sXiwwtcAB/nieypGw02Ejf4KtDeMkCEpP6gWFMX1wI9WKYua+4oBneCCEmulOkRpwywypVZzs/g==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-NbslED1/6M+sXiwwtcAB/nieypGw02Ejf4KtDeMkCEpP6gWFMX1wI9WKYua+4oBneCCEmulOkRpwywypVZzs/g==} @@ -3108,21 +2386,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Kk3lyDmEslH9DnvCDA1s1kkd3YWQITiBOHngOtDL9Pt6BZjzqb6hiOlb8VfjiiQJ2unmegBqZu0rx5RxJb5vmQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/compat-data': 7.22.6 - '@babel/core': 7.22.7 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/[email protected]) - '@babel/plugin-transform-parameters': 7.22.5(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-Kk3lyDmEslH9DnvCDA1s1kkd3YWQITiBOHngOtDL9Pt6BZjzqb6hiOlb8VfjiiQJ2unmegBqZu0rx5RxJb5vmQ==} @@ -3136,20 +2399,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/[email protected]) '@babel/plugin-transform-parameters': 7.22.5(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-klXqyaT9trSjIUrcsYIfETAzmOEZL3cBYqOYLJxBHfMFFggmXOv+NYSX/Jbs9mzMVESw/WycLFPRx8ba/b2Ipw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-replace-supers': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-klXqyaT9trSjIUrcsYIfETAzmOEZL3cBYqOYLJxBHfMFFggmXOv+NYSX/Jbs9mzMVESw/WycLFPRx8ba/b2Ipw==} @@ -3162,18 +2411,6 @@ packages: '@babel/helper-replace-supers': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-pH8orJahy+hzZje5b8e2QIlBWQvGpelS76C63Z+jhZKsmzfNaPQ+LaW6dcJ9bxTpo1mtXbgHwy765Ro3jftmUg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-pH8orJahy+hzZje5b8e2QIlBWQvGpelS76C63Z+jhZKsmzfNaPQ+LaW6dcJ9bxTpo1mtXbgHwy765Ro3jftmUg==} @@ -3184,19 +2421,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Vd5HiWml0mDVtcLHIoEU5sw6HOUW/Zk0acLs/SAeuLzkGNOPc9DB4nkUajemhCmTIz3eiaKREZn2hQQqF79YTg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/[email protected]) - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-Vd5HiWml0mDVtcLHIoEU5sw6HOUW/Zk0acLs/SAeuLzkGNOPc9DB4nkUajemhCmTIz3eiaKREZn2hQQqF79YTg==} @@ -3208,17 +2432,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/[email protected]) - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-AVkFUBurORBREOmHRKo06FjHYgjrabpdqRSwq6+C7R5iTCZOsM4QbcB27St0a4U6fffyAOqh3s/qEfybAhfivg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-AVkFUBurORBREOmHRKo06FjHYgjrabpdqRSwq6+C7R5iTCZOsM4QbcB27St0a4U6fffyAOqh3s/qEfybAhfivg==} @@ -3228,20 +2441,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-PPjh4gyrQnGe97JTalgRGMuU4icsZFnWkzicB/fUtzlKUqvsWBKEpPPfr5a2JiyirZkHxnAqkQMO5Z5B2kK3fA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-class-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-PPjh4gyrQnGe97JTalgRGMuU4icsZFnWkzicB/fUtzlKUqvsWBKEpPPfr5a2JiyirZkHxnAqkQMO5Z5B2kK3fA==} @@ -3254,22 +2453,6 @@ packages: '@babel/helper-plugin-utils': 7.22.5 transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-/9xnaTTJcVoBtSSmrVyhtSvO3kbqS2ODoh2juEU72c3aYonNF0OMGiaz2gjukyKM2wBBYJP38S4JiE0Wfb5VMQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-annotate-as-pure': 7.22.5 - '@babel/helper-create-class-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/[email protected]) - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-/9xnaTTJcVoBtSSmrVyhtSvO3kbqS2ODoh2juEU72c3aYonNF0OMGiaz2gjukyKM2wBBYJP38S4JiE0Wfb5VMQ==} @@ -3284,17 +2467,6 @@ packages: '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/[email protected]) transitivePeerDependencies: - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-TiOArgddK3mK/x1Qwf5hay2pxI6wCZnvQqrFSqbtg1GLl2JcNMitVH/YnqjP+M31pLUeTfzY1HAXFDnUBV30rQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-TiOArgddK3mK/x1Qwf5hay2pxI6wCZnvQqrFSqbtg1GLl2JcNMitVH/YnqjP+M31pLUeTfzY1HAXFDnUBV30rQ==} @@ -3304,18 +2476,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-rR7KePOE7gfEtNTh9Qw+iO3Q/e4DEsoQ+hdvM6QUDH7JRJ5qxq5AA52ZzBWbI5i9lfNuvySgOGP8ZN7LAmaiPw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - regenerator-transform: 0.15.1 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-rR7KePOE7gfEtNTh9Qw+iO3Q/e4DEsoQ+hdvM6QUDH7JRJ5qxq5AA52ZzBWbI5i9lfNuvySgOGP8ZN7LAmaiPw==} @@ -3326,17 +2486,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 regenerator-transform: 0.15.1 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-DTtGKFRQUDm8svigJzZHzb/2xatPc6TzNvAIJ5GqOKDsGFYgAskjRulbR/vGsPKq3OPqtexnz327qYpP57RFyA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-DTtGKFRQUDm8svigJzZHzb/2xatPc6TzNvAIJ5GqOKDsGFYgAskjRulbR/vGsPKq3OPqtexnz327qYpP57RFyA==} @@ -3346,17 +2495,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-vM4fq9IXHscXVKzDv5itkO1X52SmdFBFcMIBZ2FRn2nqVYqw6dBexUgMvAjHW+KXpPPViD/Yo3GrDEBaRC0QYA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-vM4fq9IXHscXVKzDv5itkO1X52SmdFBFcMIBZ2FRn2nqVYqw6dBexUgMvAjHW+KXpPPViD/Yo3GrDEBaRC0QYA==} @@ -3366,18 +2504,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5ZzDQIGyvN4w8+dMmpohL6MBo+l2G7tfC/O2Dg7/hjpgeWvUx8FzfeOKxGog9IimPa4YekaQ9PlDqTLOljkcxg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-5ZzDQIGyvN4w8+dMmpohL6MBo+l2G7tfC/O2Dg7/hjpgeWvUx8FzfeOKxGog9IimPa4YekaQ9PlDqTLOljkcxg==} @@ -3388,17 +2514,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-zf7LuNpHG0iEeiyCNwX4j3gDg1jgt1k3ZdXBKbZSoA3BbGQGvMiSvfbZRR3Dr3aeJe3ooWFZxOOG3IRStYp2Bw==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-zf7LuNpHG0iEeiyCNwX4j3gDg1jgt1k3ZdXBKbZSoA3BbGQGvMiSvfbZRR3Dr3aeJe3ooWFZxOOG3IRStYp2Bw==} @@ -3408,17 +2523,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-5ciOehRNf+EyUeewo8NkbQiUs4d6ZxiHo6BcBcnFlgiJfu16q0bQUw9Jvo0b0gBKFG1SMhDSjeKXSYuJLeFSMA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-5ciOehRNf+EyUeewo8NkbQiUs4d6ZxiHo6BcBcnFlgiJfu16q0bQUw9Jvo0b0gBKFG1SMhDSjeKXSYuJLeFSMA==} @@ -3428,17 +2532,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-bYkI5lMzL4kPii4HHEEChkD0rkc+nvnlR6+o/qdqR6zrm0Sv/nodmyLhlq2DO0YKLUNd2VePmPRjJXSBh9OIdA==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-bYkI5lMzL4kPii4HHEEChkD0rkc+nvnlR6+o/qdqR6zrm0Sv/nodmyLhlq2DO0YKLUNd2VePmPRjJXSBh9OIdA==} @@ -3448,17 +2541,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-biEmVg1IYB/raUO5wT1tgfacCef15Fbzhkx493D3urBI++6hpJ+RFG4SrWMn0NEZLfvilqKf3QDrRVZHo08FYg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-biEmVg1IYB/raUO5wT1tgfacCef15Fbzhkx493D3urBI++6hpJ+RFG4SrWMn0NEZLfvilqKf3QDrRVZHo08FYg==} @@ -3468,18 +2550,6 @@ packages: dependencies: '@babel/core': 7.22.8 '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-HCCIb+CbJIAE6sXn5CjFQXMwkCClcOfPCzTlilJ8cUatfzwHlWQkbtV0zD338u9dZskwvuOYTuuaMaA8J5EI5A==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-HCCIb+CbJIAE6sXn5CjFQXMwkCClcOfPCzTlilJ8cUatfzwHlWQkbtV0zD338u9dZskwvuOYTuuaMaA8J5EI5A==} @@ -3490,18 +2560,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-028laaOKptN5vHJf9/Arr/HiJekMd41hOEZYvNsrsXqJ7YPYuX2bQxh31fkZzGmq3YqHRJzYFFAVYvKfMPKqyg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-028laaOKptN5vHJf9/Arr/HiJekMd41hOEZYvNsrsXqJ7YPYuX2bQxh31fkZzGmq3YqHRJzYFFAVYvKfMPKqyg==} @@ -3512,18 +2570,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-lhMfi4FC15j13eKrh3DnYHjpGj6UKQHtNKTbtc1igvAhRy4+kLhV07OpLcsN0VgDEw/MjAvJO4BdMJsHwMhzCg==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-lhMfi4FC15j13eKrh3DnYHjpGj6UKQHtNKTbtc1igvAhRy4+kLhV07OpLcsN0VgDEw/MjAvJO4BdMJsHwMhzCg==} @@ -3534,98 +2580,6 @@ packages: '@babel/core': 7.22.8 '@babel/helper-create-regexp-features-plugin': 7.22.6(@babel/[email protected]) '@babel/helper-plugin-utils': 7.22.5 - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-1whfDtW+CzhETuzYXfcgZAh8/GFMeEbz0V5dVgya8YeJyCU6Y/P2Gnx4Qb3MylK68Zu9UiwUvbPMPTpFAOJ+sQ==} - engines: {node: '>=6.9.0'} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/compat-data': 7.22.6 - '@babel/core': 7.22.7 - '@babel/helper-compilation-targets': 7.22.6(@babel/[email protected]) - '@babel/helper-plugin-utils': 7.22.5 - '@babel/helper-validator-option': 7.22.5 - '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression': 7.22.5(@babel/[email protected]) - '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining': 7.22.5(@babel/[email protected]) - '@babel/plugin-proposal-private-property-in-object': 7.21.0-placeholder-for-preset-env.2(@babel/[email protected]) - '@babel/plugin-syntax-async-generators': 7.8.4(@babel/[email protected]) - '@babel/plugin-syntax-class-properties': 7.12.13(@babel/[email protected]) - '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-import-assertions': 7.22.5(@babel/[email protected]) - '@babel/plugin-syntax-import-attributes': 7.22.5(@babel/[email protected]) - '@babel/plugin-syntax-import-meta': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-json-strings': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/[email protected]) - '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/[email protected]) - '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-top-level-await': 7.14.5(@babel/[email protected]) - '@babel/plugin-syntax-unicode-sets-regex': 7.18.6(@babel/[email protected]) - '@babel/plugin-transform-arrow-functions': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-async-generator-functions': 7.22.7(@babel/[email protected]) - '@babel/plugin-transform-async-to-generator': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-block-scoped-functions': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-block-scoping': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-class-properties': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-class-static-block': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-classes': 7.22.6(@babel/[email protected]) - '@babel/plugin-transform-computed-properties': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-destructuring': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-dotall-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-duplicate-keys': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-dynamic-import': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-exponentiation-operator': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-export-namespace-from': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-for-of': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-function-name': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-json-strings': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-literals': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-logical-assignment-operators': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-member-expression-literals': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-modules-amd': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-modules-commonjs': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-modules-systemjs': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-modules-umd': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-named-capturing-groups-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-new-target': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-nullish-coalescing-operator': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-numeric-separator': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-object-rest-spread': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-object-super': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-optional-catch-binding': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-optional-chaining': 7.22.6(@babel/[email protected]) - '@babel/plugin-transform-parameters': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-private-methods': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-private-property-in-object': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-property-literals': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-regenerator': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-reserved-words': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-shorthand-properties': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-spread': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-sticky-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-template-literals': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-typeof-symbol': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-unicode-escapes': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-unicode-property-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-unicode-regex': 7.22.5(@babel/[email protected]) - '@babel/plugin-transform-unicode-sets-regex': 7.22.5(@babel/[email protected]) - '@babel/preset-modules': 0.1.5(@babel/[email protected]) - '@babel/types': 7.22.5 - '@nicolo-ribaudo/semver-v6': 6.3.3 - babel-plugin-polyfill-corejs2: 0.4.4(@babel/[email protected]) - babel-plugin-polyfill-corejs3: 0.8.2(@babel/[email protected]) - babel-plugin-polyfill-regenerator: 0.5.1(@babel/[email protected]) - core-js-compat: 3.31.1 - transitivePeerDependencies: - - supports-color - dev: false /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-1whfDtW+CzhETuzYXfcgZAh8/GFMeEbz0V5dVgya8YeJyCU6Y/P2Gnx4Qb3MylK68Zu9UiwUvbPMPTpFAOJ+sQ==} @@ -3712,24 +2666,10 @@ packages: '@nicolo-ribaudo/semver-v6': 6.3.3 babel-plugin-polyfill-corejs2: 0.4.4(@babel/[email protected]) babel-plugin-polyfill-corejs3: 0.8.2(@babel/[email protected]) - babel-plugin-polyfill-regenerator: 0.5.1(@babel/[email protected]) - core-js-compat: 3.31.1 - transitivePeerDependencies: - - supports-color - dev: true - - /@babel/[email protected](@babel/[email protected]): - resolution: {integrity: sha512-A57th6YRG7oR3cq/yt/Y84MvGgE0eJG2F1JLhKuyG+jFxEgrd/HAMJatiFtmOiZurz+0DkrvbheCLaV5f2JfjA==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-plugin-utils': 7.22.5 - '@babel/plugin-proposal-unicode-property-regex': 7.18.6(@babel/[email protected]) - '@babel/plugin-transform-dotall-regex': 7.22.5(@babel/[email protected]) - '@babel/types': 7.22.5 - esutils: 2.0.3 - dev: false + babel-plugin-polyfill-regenerator: 0.5.1(@babel/[email protected]) + core-js-compat: 3.31.1 + transitivePeerDependencies: + - supports-color /@babel/[email protected](@babel/[email protected]): resolution: {integrity: sha512-A57th6YRG7oR3cq/yt/Y84MvGgE0eJG2F1JLhKuyG+jFxEgrd/HAMJatiFtmOiZurz+0DkrvbheCLaV5f2JfjA==} @@ -3742,7 +2682,6 @@ packages: '@babel/plugin-transform-dotall-regex': 7.22.5(@babel/[email protected]) '@babel/types': 7.22.5 esutils: 2.0.3 - dev: true /@babel/[email protected]: resolution: {integrity: sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==} @@ -4757,25 +3696,6 @@ packages: - webpack-dev-server dev: true - /@tsparticles/[email protected]: - resolution: {integrity: sha512-yGfCmD/JpRlcJmDQNdPNfLwYRimxXHiRJWBYgk8HWfWRdiMahhB5shoUUou/S33ZGVwCBUg2vkvrkOBSdqCbSA==} - dependencies: - '@tsparticles/prettier-config': 1.11.0 - '@typescript-eslint/eslint-plugin': 5.61.0(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': 5.61.0([email protected])([email protected]) - eslint: 8.44.0 - eslint-config-prettier: 8.8.0([email protected]) - eslint-plugin-import: 2.27.5(@typescript-eslint/[email protected])([email protected]) - eslint-plugin-jsdoc: 46.4.3([email protected]) - eslint-plugin-tsdoc: 0.2.17 - prettier: 3.0.0 - typescript: 5.1.6 - transitivePeerDependencies: - - eslint-import-resolver-typescript - - eslint-import-resolver-webpack - - supports-color - dev: false - /@tsparticles/[email protected]: resolution: {integrity: sha512-GANEGW8s+U4HuPcFBFD2MizknkPhszg7329TCWkIHqhpsFHtwrU0uhopgn8Kd/CstCGTVFxty3hXr+ZOCNnRew==} dependencies: @@ -4793,7 +3713,6 @@ packages: - eslint-import-resolver-typescript - eslint-import-resolver-webpack - supports-color - dev: true /@tsparticles/[email protected]: resolution: {integrity: sha512-DTUBCPNhY7t5XMVAPOSxfeYCJIKqEUrZF0DC13zUBnhEf6QjYA5f67XRx7+LdSAORog35Qa/2QSYScajKMs/sw==} @@ -4805,46 +3724,6 @@ packages: dependencies: typescript: 5.1.6 - /@tsparticles/[email protected]: - resolution: {integrity: sha512-fnIGETEwprrYltkyf/z+IpHmYbZwPXQmjy1gzu/kgFIXbF/vodiAwAHLYuLqpkhdWKmTdRdMdAJpX+gT1wJ14w==} - dependencies: - '@babel/core': 7.22.7 - '@babel/preset-env': 7.22.7(@babel/[email protected]) - '@tsparticles/eslint-config': 1.15.0 - '@tsparticles/prettier-config': 1.11.0 - '@types/node': 20.4.0 - '@types/webpack-bundle-analyzer': 4.6.0([email protected]) - '@types/webpack-env': 1.18.1 - '@typescript-eslint/eslint-plugin': 5.61.0(@typescript-eslint/[email protected])([email protected])([email protected]) - '@typescript-eslint/parser': 5.61.0([email protected])([email protected]) - babel-loader: 9.1.2(@babel/[email protected])([email protected]) - browserslist: 4.21.9 - copyfiles: 2.4.1 - eslint: 8.44.0 - eslint-config-prettier: 8.8.0([email protected]) - eslint-plugin-import: 2.27.5(@typescript-eslint/[email protected])([email protected]) - eslint-plugin-jsdoc: 46.4.3([email protected]) - eslint-plugin-tsdoc: 0.2.17 - prettier: 3.0.0 - rimraf: 5.0.1 - terser-webpack-plugin: 5.3.9([email protected]) - typescript: 5.1.6 - webpack: 5.88.1([email protected]) - webpack-bundle-analyzer: 4.9.0 - webpack-cli: 5.1.4([email protected])([email protected]) - transitivePeerDependencies: - - '@swc/core' - - '@webpack-cli/generators' - - bufferutil - - esbuild - - eslint-import-resolver-typescript - - eslint-import-resolver-webpack - - supports-color - - uglify-js - - utf-8-validate - - webpack-dev-server - dev: false - /@tsparticles/[email protected]: resolution: {integrity: sha512-lMgrA+GcEXYysO5J+af3UEIn5xpx2ON/LkEAxSq7gjS8PeamrPRiglw2zsgEE6s+dXfahD7sxlMhf6CoMgMkPw==} dependencies: @@ -4883,7 +3762,6 @@ packages: - uglify-js - utf-8-validate - webpack-dev-server - dev: true /@tufjs/[email protected]: resolution: {integrity: sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ==} @@ -4943,11 +3821,11 @@ packages: /@types/[email protected]: resolution: {integrity: sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA==} dependencies: - '@types/eslint': 8.40.2 + '@types/eslint': 8.44.0 '@types/estree': 1.0.1 - /@types/[email protected]: - resolution: {integrity: sha512-PRVjQ4Eh9z9pmmtaq8nTjZjQwKFk7YIHIud3lRoKRBgUQjgjRmoGxxGEPXQkF+lH7QkHJRNr5F4aBgYCW0lqpQ==} + /@types/[email protected]: + resolution: {integrity: sha512-gsF+c/0XOguWgaOgvFs+xnnRqt9GwgTvIks36WpE6ueeI4KCEHHd8K/CKHqhOqrJKsYH8m27kRzQEvWXAwXUTw==} dependencies: '@types/estree': 1.0.1 '@types/json-schema': 7.0.12 @@ -4977,7 +3855,7 @@ packages: resolution: {integrity: sha512-MxObHvNl4A69ofaTRU8DFqvgzzv8s9yRtaPPm5gud9HDNvpB3GPQFvNuTWAI59B9huVGV5jXYJwbCsmBsOGYWA==} dependencies: '@types/jsonfile': 6.1.1 - '@types/node': 20.4.0 + '@types/node': 20.4.1 dev: true /@types/[email protected]: @@ -4987,7 +3865,7 @@ packages: /@types/[email protected]: resolution: {integrity: sha512-cZFuoVLtzKP3gmq9eNosUL1R50U+USkbLtUQ1bYVgl/lKp0FZM7Cq4aIHAL8oIvQ17uSHi7jXPtfDOdjPwBE7A==} dependencies: - '@types/node': 20.4.0 + '@types/node': 20.4.1 '@types/tough-cookie': 4.0.2 parse5: 7.1.2 dev: true @@ -5013,7 +3891,7 @@ packages: /@types/[email protected]: resolution: {integrity: sha512-mXlRDFbTLpVysvxahXUQav0hFctgu3Fqr2xmSrpf/ptO/FwOp7SFEGsJkEihwshMbof3/BIiVJ/o42cuOOuv6g==} dependencies: - '@types/node': 20.4.0 + '@types/node': 20.4.1 dev: true /@types/[email protected]: @@ -5058,9 +3936,6 @@ packages: resolution: {integrity: sha512-3iD2jaCCziTx04uudpJKwe39QxXgSUnpxXSvRQjRvHPxFQfmfP4NXIm/NURVeNlTCc+ru4WqjYGTmpXrW9uMlw==} dev: true - /@types/[email protected]: - resolution: {integrity: sha512-jfT7iTf/4kOQ9S7CHV9BIyRaQqHu67mOjsIQBC3BKZvzvUB6zLxEwJ6sBE3ozcvP8kF6Uk5PXN0Q+c0dfhGX0g==} - /@types/[email protected]: resolution: {integrity: sha512-JIzsAvJeA/5iY6Y/OxZbv1lUcc8dNSE77lb2gnBH+/PJ3lFR1Ccvgwl5JWnHAkNHcRsT0TbpVOsiMKZ1F/yyJg==} @@ -5142,34 +4017,6 @@ packages: dev: true optional: true - /@typescript-eslint/[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): - resolution: {integrity: sha512-A5l/eUAug103qtkwccSCxn8ZRwT+7RXWkFECdA4Cvl1dOlDUgTpAOfSEElZn2uSUxhdDpnCdetrf0jvU4qrL+g==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - peerDependencies: - '@typescript-eslint/parser': ^5.0.0 - eslint: ^6.0.0 \|\| ^7.0.0 \|\| ^8.0.0 - typescript: '' - peerDependenciesMeta: - typescript: - optional: true - dependencies: - '@eslint-community/regexpp': 4.5.1 - '@typescript-eslint/parser': 5.61.0([email protected])([email protected]) - '@typescript-eslint/scope-manager': 5.61.0 - '@typescript-eslint/type-utils': 5.61.0([email protected])([email protected]) - '@typescript-eslint/utils': 5.61.0([email protected])([email protected]) - debug: 4.3.4([email protected]) - eslint: 8.44.0 - graphemer: 1.4.0 - ignore: 5.2.4 - natural-compare-lite: 1.4.0 - semver: 7.5.3 - tsutils: 3.21.0([email protected]) - typescript: 5.1.6 - transitivePeerDependencies: - - supports-color - dev: false - /@typescript-eslint/[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): resolution: {integrity: sha512-xuv6ghKGoiq856Bww/yVYnXGsKa588kY3M0XK7uUW/3fJNNULKRfZfSBkMTSpqGG/8ZCXCadfh8G/z/B4aqS/A==} engines: {node: ^16.0.0 \|\| >=18.0.0} @@ -5199,27 +4046,6 @@ packages: typescript: 5.1.6 transitivePeerDependencies: - supports-color - dev: true - - /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-yGr4Sgyh8uO6fSi9hw3jAFXNBHbCtKKFMdX2IkT3ZqpKmtAq3lHS4ixB/COFuAIJpwl9/AqF7j72ZDWYKmIfvg==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - peerDependencies: - eslint: ^6.0.0 \|\| ^7.0.0 \|\| ^8.0.0 - typescript: '' - peerDependenciesMeta: - typescript: - optional: true - dependencies: - '@typescript-eslint/scope-manager': 5.61.0 - '@typescript-eslint/types': 5.61.0 - '@typescript-eslint/typescript-estree': 5.61.0([email protected]) - debug: 4.3.4([email protected]) - eslint: 8.44.0 - typescript: 5.1.6 - transitivePeerDependencies: - - supports-color - dev: false /@typescript-eslint/[email protected]([email protected])([email protected]): resolution: {integrity: sha512-TNaufYSPrr1U8n+3xN+Yp9g31vQDJqhXzzPSHfQDLcaO4tU+mCfODPxCwf4H530zo7aUBE3QIdxCXamEnG04Tg==} @@ -5240,15 +4066,6 @@ packages: typescript: 5.1.6 transitivePeerDependencies: - supports-color - dev: true - - /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-W8VoMjoSg7f7nqAROEmTt6LoBpn81AegP7uKhhW5KzYlehs8VV0ZW0fIDVbcZRcaP3aPSW+JZFua+ysQN+m/Nw==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - dependencies: - '@typescript-eslint/types': 5.61.0 - '@typescript-eslint/visitor-keys': 5.61.0 - dev: false /@typescript-eslint/[email protected]: resolution: {integrity: sha512-o4q0KHlgCZTqjuaZ25nw5W57NeykZT9LiMEG4do/ovwvOcPnDO1BI5BQdCsUkjxFyrCL0cSzLjvIMfR9uo7cWg==} @@ -5256,27 +4073,6 @@ packages: dependencies: '@typescript-eslint/types': 6.0.0 '@typescript-eslint/visitor-keys': 6.0.0 - dev: true - - /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-kk8u//r+oVK2Aj3ph/26XdH0pbAkC2RiSjUYhKD+PExemG4XSjpGFeyZ/QM8lBOa7O8aGOU+/yEbMJgQv/DnCg==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - peerDependencies: - eslint: '' - typescript: '' - peerDependenciesMeta: - typescript: - optional: true - dependencies: - '@typescript-eslint/typescript-estree': 5.61.0([email protected]) - '@typescript-eslint/utils': 5.61.0([email protected])([email protected]) - debug: 4.3.4([email protected]) - eslint: 8.44.0 - tsutils: 3.21.0([email protected]) - typescript: 5.1.6 - transitivePeerDependencies: - - supports-color - dev: false /@typescript-eslint/[email protected]([email protected])([email protected]): resolution: {integrity: sha512-ah6LJvLgkoZ/pyJ9GAdFkzeuMZ8goV6BH7eC9FPmojrnX9yNCIsfjB+zYcnex28YO3RFvBkV6rMV6WpIqkPvoQ==} @@ -5296,38 +4092,10 @@ packages: typescript: 5.1.6 transitivePeerDependencies: - supports-color - dev: true - - /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-ldyueo58KjngXpzloHUog/h9REmHl59G1b3a5Sng1GfBo14BkS3ZbMEb3693gnP1k//97lh7bKsp6/V/0v1veQ==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - dev: false /@typescript-eslint/[email protected]: resolution: {integrity: sha512-Zk9KDggyZM6tj0AJWYYKgF0yQyrcnievdhG0g5FqyU3Y2DRxJn4yWY21sJC0QKBckbsdKKjYDV2yVrrEvuTgxg==} engines: {node: ^16.0.0 \|\| >=18.0.0} - dev: true - - /@typescript-eslint/[email protected]([email protected]): - resolution: {integrity: sha512-Fud90PxONnnLZ36oR5ClJBLTLfU4pIWBmnvGwTbEa2cXIqj70AEDEmOmpkFComjBZ/037ueKrOdHuYmSFVD7Rw==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - peerDependencies: - typescript: '' - peerDependenciesMeta: - typescript: - optional: true - dependencies: - '@typescript-eslint/types': 5.61.0 - '@typescript-eslint/visitor-keys': 5.61.0 - debug: 4.3.4([email protected]) - globby: 11.1.0 - is-glob: 4.0.3 - semver: 7.5.3 - tsutils: 3.21.0([email protected]) - typescript: 5.1.6 - transitivePeerDependencies: - - supports-color - dev: false /@typescript-eslint/[email protected]([email protected]): resolution: {integrity: sha512-2zq4O7P6YCQADfmJ5OTDQTP3ktajnXIRrYAtHM9ofto/CJZV3QfJ89GEaM2BNGeSr1KgmBuLhEkz5FBkS2RQhQ==} @@ -5348,27 +4116,6 @@ packages: typescript: 5.1.6 transitivePeerDependencies: - supports-color - dev: true - - /@typescript-eslint/[email protected]([email protected])([email protected]): - resolution: {integrity: sha512-mV6O+6VgQmVE6+xzlA91xifndPW9ElFW8vbSF0xCT/czPXVhwDewKila1jOyRwa9AE19zKnrr7Cg5S3pJVrTWQ==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - peerDependencies: - eslint: ^6.0.0 \|\| ^7.0.0 \|\| ^8.0.0 - dependencies: - '@eslint-community/eslint-utils': 4.4.0([email protected]) - '@types/json-schema': 7.0.12 - '@types/semver': 7.5.0 - '@typescript-eslint/scope-manager': 5.61.0 - '@typescript-eslint/types': 5.61.0 - '@typescript-eslint/typescript-estree': 5.61.0([email protected]) - eslint: 8.44.0 - eslint-scope: 5.1.1 - semver: 7.5.3 - transitivePeerDependencies: - - supports-color - - typescript - dev: false /@typescript-eslint/[email protected]([email protected])([email protected]): resolution: {integrity: sha512-SOr6l4NB6HE4H/ktz0JVVWNXqCJTOo/mHnvIte1ZhBQ0Cvd04x5uKZa3zT6tiodL06zf5xxdK8COiDvPnQ27JQ==} @@ -5388,15 +4135,6 @@ packages: transitivePeerDependencies: - supports-color - typescript - dev: true - - /@typescript-eslint/[email protected]: - resolution: {integrity: sha512-50XQ5VdbWrX06mQXhy93WywSFZZGsv3EOjq+lqp6WC2t+j3mb6A9xYVdrRxafvK88vg9k9u+CT4l6D8PEatjKg==} - engines: {node: ^12.22.0 \|\| ^14.17.0 \|\| >=16.0.0} - dependencies: - '@typescript-eslint/types': 5.61.0 - eslint-visitor-keys: 3.4.1 - dev: false /@typescript-eslint/[email protected]: resolution: {integrity: sha512-cvJ63l8c0yXdeT5POHpL0Q1cZoRcmRKFCtSjNGJxPkcP571EfZMcNbzWAc7oK3D1dRzm/V5EwtkANTZxqvuuUA==} @@ -5404,7 +4142,6 @@ packages: dependencies: '@typescript-eslint/types': 6.0.0 eslint-visitor-keys: 3.4.1 - dev: true /@webassemblyjs/[email protected]: resolution: {integrity: sha512-IN1xI7PwOvLPgjcf180gC1bqn3q/QaOCwYUahIOhbYUu8KA/3tw2RT/T0Gidi1l7Hhj5D/INhJxiICObqpMu4Q==} @@ -5935,19 +4672,6 @@ packages: - debug dev: true - /[email protected](@babel/[email protected])([email protected]): - resolution: {integrity: sha512-mN14niXW43tddohGl8HPu5yfQq70iUThvFL/4QzESA7GcZoC0eVOhvWdQ8+3UlSjaDE9MVtsW9mxDY07W7VpVA==} - engines: {node: '>= 14.15.0'} - peerDependencies: - '@babel/core': ^7.12.0 - webpack: '>=5' - dependencies: - '@babel/core': 7.22.7 - find-cache-dir: 3.3.2 - schema-utils: 4.2.0 - webpack: 5.88.1([email protected]) - dev: false - /[email protected](@babel/[email protected])([email protected]): resolution: {integrity: sha512-xG3ST4DglodGf8qSwv0MdeWLhrDsw/32QMdTO5T1ZIp9gQur0HkCyFs7Awskr10JKXFXwpAhiCuYX5oGXnRGbw==} engines: {node: '>= 14.15.0'} @@ -5959,20 +4683,6 @@ packages: find-cache-dir: 4.0.0 schema-utils: 4.2.0 webpack: 5.88.1([email protected]) - dev: true - - /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-9WeK9snM1BfxB38goUEv2FLnA6ja07UMfazFHzCXUb3NyDZAwfXvQiURQ6guTTMeHcOsdknULm1PDhs4uWtKyA==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/compat-data': 7.22.6 - '@babel/core': 7.22.7 - '@babel/helper-define-polyfill-provider': 0.4.1(@babel/[email protected]) - '@nicolo-ribaudo/semver-v6': 6.3.3 - transitivePeerDependencies: - - supports-color - dev: false /[email protected](@babel/[email protected]): resolution: {integrity: sha512-9WeK9snM1BfxB38goUEv2FLnA6ja07UMfazFHzCXUb3NyDZAwfXvQiURQ6guTTMeHcOsdknULm1PDhs4uWtKyA==} @@ -5985,19 +4695,6 @@ packages: '@nicolo-ribaudo/semver-v6': 6.3.3 transitivePeerDependencies: - supports-color - dev: true - - /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-Cid+Jv1BrY9ReW9lIfNlNpsI53N+FN7gE+f73zLAUbr9C52W4gKLWSByx47pfDJsEysojKArqOtOKZSVIIUTuQ==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-define-polyfill-provider': 0.4.1(@babel/[email protected]) - core-js-compat: 3.31.1 - transitivePeerDependencies: - - supports-color - dev: false /[email protected](@babel/[email protected]): resolution: {integrity: sha512-Cid+Jv1BrY9ReW9lIfNlNpsI53N+FN7gE+f73zLAUbr9C52W4gKLWSByx47pfDJsEysojKArqOtOKZSVIIUTuQ==} @@ -6009,18 +4706,6 @@ packages: core-js-compat: 3.31.1 transitivePeerDependencies: - supports-color - dev: true - - /[email protected](@babel/[email protected]): - resolution: {integrity: sha512-L8OyySuI6OSQ5hFy9O+7zFjyr4WhAfRjLIOkhQGYl+emwJkd/S4XXT1JpfrgR1jrQ1NcGiOh+yAdGlF8pnC3Jw==} - peerDependencies: - '@babel/core': ^7.0.0-0 - dependencies: - '@babel/core': 7.22.7 - '@babel/helper-define-polyfill-provider': 0.4.1(@babel/[email protected]) - transitivePeerDependencies: - - supports-color - dev: false /[email protected](@babel/[email protected]): resolution: {integrity: sha512-L8OyySuI6OSQ5hFy9O+7zFjyr4WhAfRjLIOkhQGYl+emwJkd/S4XXT1JpfrgR1jrQ1NcGiOh+yAdGlF8pnC3Jw==} @@ -6031,7 +4716,6 @@ packages: '@babel/helper-define-polyfill-provider': 0.4.1(@babel/[email protected]) transitivePeerDependencies: - supports-color - dev: true /[email protected]: resolution: {integrity: sha512-ITKNuq2wKlW1fJg9sSW52eepoYgZBggvOAHC0u/CYu/qxQ9EVzThCgR69BnSXLHjy2f7SY5zaQ4yt7H9ZVxY2g==} @@ -6569,10 +5253,10 @@ packages: /[email protected]: resolution: {integrity: sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==} - dev: true /[email protected]: resolution: {integrity: sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==} + dev: true /[email protected]: resolution: {integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==} @@ -7282,35 +5966,6 @@ packages: transitivePeerDependencies: - supports-color - /[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): - resolution: {integrity: sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==} - engines: {node: '>=4'} - peerDependencies: - '@typescript-eslint/parser': '' - eslint: '' - eslint-import-resolver-node: '' - eslint-import-resolver-typescript: '' - eslint-import-resolver-webpack: '' - peerDependenciesMeta: - '@typescript-eslint/parser': - optional: true - eslint: - optional: true - eslint-import-resolver-node: - optional: true - eslint-import-resolver-typescript: - optional: true - eslint-import-resolver-webpack: - optional: true - dependencies: - '@typescript-eslint/parser': 5.61.0([email protected])([email protected]) - debug: 3.2.7([email protected]) - eslint: 8.44.0 - eslint-import-resolver-node: 0.3.7 - transitivePeerDependencies: - - supports-color - dev: false - /[email protected](@typescript-eslint/[email protected])([email protected])([email protected]): resolution: {integrity: sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==} engines: {node: '>=4'} @@ -7338,40 +5993,6 @@ packages: eslint-import-resolver-node: 0.3.7 transitivePeerDependencies: - supports-color - dev: true - - /[email protected](@typescript-eslint/[email protected])([email protected]): - resolution: {integrity: sha512-LmEt3GVofgiGuiE+ORpnvP+kAm3h6MLZJ4Q5HCyHADofsb4VzXFsRiWj3c0OFiV+3DWFh0qg3v9gcPlfc3zRow==} - engines: {node: '>=4'} - peerDependencies: - '@typescript-eslint/parser': '*' - eslint: ^2 \|\| ^3 \|\| ^4 \|\| ^5 \|\| ^6 \|\| ^7.2.0 \|\| ^8 - peerDependenciesMeta: - '@typescript-eslint/parser': - optional: true - dependencies: - '@typescript-eslint/parser': 5.61.0([email protected])([email protected]) - array-includes: 3.1.6 - array.prototype.flat: 1.3.1 - array.prototype.flatmap: 1.3.1 - debug: 3.2.7([email protected]) - doctrine: 2.1.0 - eslint: 8.44.0 - eslint-import-resolver-node: 0.3.7 - eslint-module-utils: 2.8.0(@typescript-eslint/[email protected])([email protected])([email protected]) - has: 1.0.3 - is-core-module: 2.12.1 - is-glob: 4.0.3 - minimatch: 3.1.2 - object.values: 1.1.6 - resolve: 1.22.2 - semver: 6.3.0 - tsconfig-paths: 3.14.2 - transitivePeerDependencies: - - eslint-import-resolver-typescript - - eslint-import-resolver-webpack - - supports-color - dev: false /[email protected](@typescript-eslint/[email protected])([email protected]): resolution: {integrity: sha512-LmEt3GVofgiGuiE+ORpnvP+kAm3h6MLZJ4Q5HCyHADofsb4VzXFsRiWj3c0OFiV+3DWFh0qg3v9gcPlfc3zRow==} @@ -7404,7 +6025,6 @@ packages: - eslint-import-resolver-typescript - eslint-import-resolver-webpack - supports-color - dev: true /[email protected]([email protected]): resolution: {integrity: sha512-Prc7ol+vCIghPeECpwZq5+P+VZfoi87suywvbYCiCnkI1kTmVSdcOC2M8mioglWxBbd28wbb1OVjg/8OzGzatA==} @@ -7753,6 +6373,7 @@ packages: commondir: 1.0.1 make-dir: 3.1.0 pkg-dir: 4.2.0 + dev: true /[email protected]: resolution: {integrity: sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==} @@ -7760,7 +6381,6 @@ packages: dependencies: common-path-prefix: 3.0.0 pkg-dir: 7.0.0 - dev: true /[email protected]: resolution: {integrity: sha512-NWzkk0jSJtTt08+FBFMvXoeZnOJD+jTtsRmBYbAIzJdX6l7dLgR7CTubCM5/eDdPUBvLCeVasP1brfVR/9/EZQ==} @@ -7789,7 +6409,6 @@ packages: dependencies: locate-path: 7.2.0 path-exists: 5.0.0 - dev: true /[email protected]: resolution: {integrity: sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==} @@ -8227,7 +6846,6 @@ packages: /[email protected]: resolution: {integrity: sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ==} - dev: true /[email protected]: resolution: {integrity: sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==} @@ -9345,7 +7963,6 @@ packages: engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} dependencies: p-locate: 6.0.0 - dev: true /[email protected]: resolution: {integrity: sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA==} @@ -10389,7 +9006,6 @@ packages: engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} dependencies: yocto-queue: 1.0.0 - dev: true /[email protected]: resolution: {integrity: sha512-nQja7m7gSKuewoVRen45CtVfODR3crN3goVQ0DDZ9N3yHxgpkuBhZqsaiotSQRrADUrne346peY7kT3TSACykg==} @@ -10415,7 +9031,6 @@ packages: engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} dependencies: p-limit: 4.0.0 - dev: true /[email protected]: resolution: {integrity: sha512-RpYIIK1zXSNEOdwxcfe7FdvGcs7+y5n8rifMhMNWvaxRNMPINJHF5GDeuVxWqnfrcHPSCnp7Oo5yNXHId9Av2Q==} @@ -10591,7 +9206,6 @@ packages: /[email protected]: resolution: {integrity: sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==} engines: {node: ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0} - dev: true /[email protected]: resolution: {integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==} @@ -10684,7 +9298,6 @@ packages: engines: {node: '>=14.16'} dependencies: find-up: 6.3.0 - dev: true /[email protected]: resolution: {integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==} @@ -12145,7 +10758,6 @@ packages: typescript: '>=4.2.0' dependencies: typescript: 5.1.6 - dev: true /[email protected]: resolution: {integrity: sha512-tUMeO3ZvA12d3HHh7T/AK8W5hmUhDRNtqWRHSMN3ZRbUFt+UmV0oX8k1RK4SA+a+BKNHpmW2v06MS49e8Fi3Yg==} @@ -12240,10 +10852,6 @@ packages: strip-bom: 3.0.0 dev: true - /[email protected]: - resolution: {integrity: sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==} - dev: false - /[email protected]: resolution: {integrity: sha512-KaI6gPil5m9vF7DKaoXxx1ia9fxS4qG5YveErRRVknPDXXriu5M8h48YRjB6h5ZUOKuAKlSJYb0GaDe8I39fRw==} dev: true @@ -12252,16 +10860,6 @@ packages: resolution: {integrity: sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==} dev: true - /[email protected]([email protected]): - resolution: {integrity: sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==} - engines: {node: '>= 6'} - peerDependencies: - typescript: '>=2.8.0 \|\| >= 3.2.0-dev \|\| >= 3.3.0-dev \|\| >= 3.4.0-dev \|\| >= 3.5.0-dev \|\| >= 3.6.0-dev \|\| >= 3.6.0-beta \|\| >= 3.7.0-dev \|\| >= 3.7.0-beta' - dependencies: - tslib: 1.14.1 - typescript: 5.1.6 - dev: false - /[email protected]: resolution: {integrity: sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg==} engines: {node: ^14.17.0 \|\| ^16.13.0 \|\| >=18.0.0} @@ -13112,4 +11710,3 @@ packages: /[email protected]: resolution: {integrity: sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==} engines: {node: '>=12.20'} - dev: true diff --git a/package.json b/package.json index abdf734..8384571 100644 --- a/package.json +++ b/package.json @@ -26,12 +26,12 @@ "prepack": "pnpm run build" }, "dependencies": { - "@tsparticles/eslint-config": "^1.15.0", + "@tsparticles/eslint-config": "^1.17.0", "@tsparticles/prettier-config": "^1.11.0", "@tsparticles/tsconfig": "^1.14.0", - "@tsparticles/webpack-plugin": "^1.17.1", - "@typescript-eslint/eslint-plugin": "^5.61.0", - "@typescript-eslint/parser": "^5.61.0", + "@tsparticles/webpack-plugin": "^1.20.0", + "@typescript-eslint/eslint-plugin": "^6.0.0", + "@typescript-eslint/parser": "^6.0.0", "eslint": "^8.44.0", "eslint-config-prettier": "^8.8.0", "fs-extra": "^11.1.1", @@ -111,11 +111,11 @@ "webpack": "^5.88.1" }, "devDependencies": { - "@types/eslint": "^8.40.2", + "@types/eslint": "^8.44.0", "@types/fs-extra": "^11.0.1", "@types/jsdom": "^21.1.1", "@types/klaw": "^3.0.3", "@types/lodash": "^4.14.195", - "@types/node": "^20.4.0" + "@types/node": "^20.4.1" } }
fix: use default "config" props when explicitly undefined When a prop like "config.easing" is defined with an undefined value (confusing huh?), it should use its default value. In the case of "config.easing", the default is linear easing.	5138a4fc9f340085c81fb5a070d78c4362445ee3	fix	https://github.com/pmndrs/react-spring/commit/5138a4fc9f340085c81fb5a070d78c4362445ee3	use default "config" props when explicitly undefined When a prop like "config.easing" is defined with an undefined value (confusing huh?), it should use its default value. In the case of "config.easing", the default is linear easing.	[email protected]	diff --git a/AnimationConfig.ts b/AnimationConfig.ts index fab05ee..8d8f579 100644 --- a/AnimationConfig.ts +++ b/AnimationConfig.ts @@ -1,8 +1,14 @@ import { is } from 'shared' import { config as configs } from './constants' -const defaultConfig = configs.default const linear = (t: number) => t +const defaults: any = { + ...configs.default, + mass: 1, + damping: 1, + easing: linear, + clamp: false, +} export class AnimationConfig { /** @@ -10,7 +16,7 @@ export class AnimationConfig { * * When tension is zero, no animation occurs. / - tension: number = defaultConfig.tension + tension!: number /* * The damping ratio coefficient, or just the damping ratio when `speed` is defined. @@ -19,7 +25,7 @@ export class AnimationConfig { * * Higher friction means the spring will slow down faster. / - friction: number = defaultConfig.friction + friction!: number /* * The natural frequency (in seconds), which dictates the number of bounces @@ -40,14 +46,14 @@ export class AnimationConfig { * * Defaults to 1 / - damping = 1 + damping!: number /* * Higher mass means more friction is required to slow down. * * Defaults to 1, which works fine most of the time. / - mass = 1 + mass!: number /* * The initial velocity of one or more values. @@ -94,12 +100,12 @@ export class AnimationConfig { * * Defaults to quadratic ease-in-out. / - easing = linear + easing!: (t: number) => number /* * Avoid overshooting by ending abruptly at the goal value. / - clamp = false + clamp!: boolean /* * When above zero, the spring will bounce instead of overshooting when @@ -128,12 +134,22 @@ export class AnimationConfig { * passed to the `set` method of an animated value. */ round?: number + + constructor() { + Object.assign(this, defaults) + } } export function mergeConfig( config: AnimationConfig, newConfig: Partial<AnimationConfig>, defaultConfig?: Partial<AnimationConfig> +): typeof config + +export function mergeConfig( + config: any, + newConfig: object, + defaultConfig?: object ) { if (defaultConfig) { defaultConfig = { ...defaultConfig } @@ -144,6 +160,12 @@ export function mergeConfig( sanitizeConfig(config, newConfig) Object.assign(config, newConfig) + for (const key in defaults) { + if (config[key] == null) { + config[key] = defaults[key] + } + } + let { mass, frequency, damping } = config if (!is.und(frequency)) { if (frequency < 0.01) frequency = 0.01
build: fixed react distfiles script and dist package.json file	e144c8cadf757bf3a616415e7fe5cc45cf3d055b	build	https://github.com/tsparticles/tsparticles/commit/e144c8cadf757bf3a616415e7fe5cc45cf3d055b	fixed react distfiles script and dist package.json file	[email protected]	diff --git a/package.dist.json b/package.dist.json index a36df56..927b3af 100644 --- a/package.dist.json +++ b/package.dist.json @@ -86,6 +86,6 @@ }, "dependencies": { "fast-deep-equal": "^3.1.3", - "tsparticles-engine": "^2.0.6" + "tsparticles-engine": "^2.1.4" } } \\ No newline at end of file diff --git a/distfiles.js b/distfiles.js index c296031..9a2be9c 100644 --- a/distfiles.js +++ b/distfiles.js @@ -13,6 +13,10 @@ fs.readFile(libPackage, function (error, data) { libObj.version = mainInfo.version; + const dependencies = Object.fromEntries(Object.keys(mainInfo.dependencies).filter(t => t.indexOf("react") === -1).map(t => [t, mainInfo.dependencies[t]])); + + libObj.dependencies = JSON.parse(JSON.stringify(dependencies)); + fs.writeFileSync(libPackage, JSON.stringify(libObj, undefined, 2), "utf8"); console.log(`package.dist.json updated successfully to version ${mainInfo.version}`);
ci(rebase): revert to original rebase strategy [skip ci]	8d3076fe0199fa4ae8355f7d05d63de6e8a7265f	ci	https://github.com/ibis-project/ibis/commit/8d3076fe0199fa4ae8355f7d05d63de6e8a7265f	revert to original rebase strategy [skip ci]	[email protected]	diff --git a/ibis-rebase-nightly.yml b/ibis-rebase-nightly.yml index 9c43a85..a439c6c 100644 --- a/ibis-rebase-nightly.yml +++ b/ibis-rebase-nightly.yml @@ -4,8 +4,6 @@ on: # run every 24 hours at 1 AM - cron: "1 /24 * " workflow_dispatch: - branches: - - ".x.x" jobs: generate_branches: @@ -39,7 +37,6 @@ jobs: - uses: actions/checkout@v3 with: ref: ${{ matrix.branch }} - fetch-depth: 0 - name: fetch and rebase on top of upstream run: git pull --rebase https://github.com/ibis-project/ibis master @@ -78,4 +75,4 @@ jobs: with: token: ${{ steps.generate_pr_token.outputs.token }} pull-request-number: ${{ steps.create_pr.outputs.pull-request-number }} - merge-method: merge + merge-method: rebase
build: update version (nightly.1)	112b9c380213f748a51a2d8cb2634e202a340283	build	https://github.com/erg-lang/erg/commit/112b9c380213f748a51a2d8cb2634e202a340283	update version (nightly.1)	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 9aabd06..9c0376a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -94,7 +94,7 @@ dependencies = [ [[package]] name = "els" -version = "0.1.30-nightly.0" +version = "0.1.30-nightly.1" dependencies = [ "erg_common", "erg_compiler", @@ -105,7 +105,7 @@ dependencies = [ [[package]] name = "erg" -version = "0.6.18-nightly.0" +version = "0.6.18-nightly.1" dependencies = [ "els", "erg_common", @@ -115,7 +115,7 @@ dependencies = [ [[package]] name = "erg_common" -version = "0.6.18-nightly.0" +version = "0.6.18-nightly.1" dependencies = [ "backtrace-on-stack-overflow", "crossterm", @@ -125,7 +125,7 @@ dependencies = [ [[package]] name = "erg_compiler" -version = "0.6.18-nightly.0" +version = "0.6.18-nightly.1" dependencies = [ "erg_common", "erg_parser", @@ -133,7 +133,7 @@ dependencies = [ [[package]] name = "erg_parser" -version = "0.6.18-nightly.0" +version = "0.6.18-nightly.1" dependencies = [ "erg_common", "unicode-xid", diff --git a/Cargo.toml b/Cargo.toml index 33575fa..05a29e4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "els" description = "An Erg compiler frontend for IDEs, implements LSP." documentation = "http://docs.rs/els" -version = "0.1.30-nightly.0" +version = "0.1.30-nightly.1" authors.workspace = true license.workspace = true edition.workspace = true
build: updated to lerna v6	aa30370b796c1f46cc60aa56b2918c3d27c0cf88	build	https://github.com/tsparticles/tsparticles/commit/aa30370b796c1f46cc60aa56b2918c3d27c0cf88	updated to lerna v6	[email protected]	diff --git a/lerna.json b/lerna.json index 0d0a460..c52015e 100644 --- a/lerna.json +++ b/lerna.json @@ -25,7 +25,6 @@ "npmClient": "pnpm", "useWorkspaces": true, "conventionalCommits": true, - "useNx": true, "command": { "version": { "message": "chore(release): published new version" diff --git a/nx.json b/nx.json index 49aa9ff..9667f85 100644 --- a/nx.json +++ b/nx.json @@ -33,32 +33,6 @@ } } }, - "targetDependencies": { - "build": [ - { - "target": "build", - "projects": "dependencies" - } - ], - "build:ci": [ - { - "target": "build:ci", - "projects": "dependencies" - } - ], - "prepare": [ - { - "target": "prepare", - "projects": "dependencies" - } - ], - "package": [ - { - "target": "package", - "projects": "dependencies" - } - ] - }, "affected": { "defaultBase": "main" }, @@ -66,5 +40,28 @@ "@nrwl/js": { "analyzeSourceFiles": false } + }, + "$schema": "./node_modules/nx/schemas/nx-schema.json", + "targetDefaults": { + "build": { + "dependsOn": [ + "^build" + ] + }, + "build:ci": { + "dependsOn": [ + "^build:ci" + ] + }, + "prepare": { + "dependsOn": [ + "^prepare" + ] + }, + "package": { + "dependsOn": [ + "^package" + ] + } } }
chore: fix tests	c03ae0dddbf3b442db4e491f11045897c5339c0d	chore	https://github.com/mikro-orm/mikro-orm/commit/c03ae0dddbf3b442db4e491f11045897c5339c0d	fix tests	[email protected]	diff --git a/typings.ts b/typings.ts index 1772359..d2bd2b6 100644 --- a/typings.ts +++ b/typings.ts @@ -405,6 +405,7 @@ export class EntityMetadata<T extends AnyEntity<T> = any> { prop.index = false; } + /* istanbul ignore next */ if (owner && prop.fieldNames.length > 1 && prop.unique) { this.uniques.push({ properties: prop.name }); prop.unique = false; diff --git a/GH2948.test.ts b/GH2948.test.ts index f33d976..d7165a1 100644 --- a/GH2948.test.ts +++ b/GH2948.test.ts @@ -14,7 +14,7 @@ export class Fiz { // eslint-disable-next-line @typescript-eslint/no-use-before-define @ManyToOne({ entity: () => BazEntity, eager: true }) - _baz: BazEntity; + _baz: any; }
test: only grab the parent directory when loading data if running in parallel	998498e7809f49ba9385b6475e30d8decf318164	test	https://github.com/rohankumardubey/ibis/commit/998498e7809f49ba9385b6475e30d8decf318164	only grab the parent directory when loading data if running in parallel	[email protected]	diff --git a/conftest.py b/conftest.py index 68eb301..0b77e69 100644 --- a/conftest.py +++ b/conftest.py @@ -93,11 +93,12 @@ def dbpath(data_directory): @pytest.fixture(scope="session") -def con(tmp_path_factory, data_directory, script_directory): +def con(tmp_path_factory, data_directory, script_directory, worker_id): return TestConf.load_data( data_directory, script_directory, tmp_path_factory, + worker_id, ).connect(data_directory) diff --git a/base.py b/base.py index 6e18a34..da97584 100644 --- a/base.py +++ b/base.py @@ -102,6 +102,7 @@ class BackendTest(abc.ABC): data_dir: Path, script_dir: Path, tmpdir: Path, + worker_id: str, **kwargs: Any, ) -> None: """Load testdata from `data_directory` into @@ -109,7 +110,9 @@ class BackendTest(abc.ABC): # handling for multi-processes pytest # get the temp directory shared by all workers - root_tmp_dir = tmpdir.getbasetemp().parent + root_tmp_dir = tmpdir.getbasetemp() + if worker_id != "master": + root_tmp_dir = root_tmp_dir.parent fn = root_tmp_dir / f"lockfile_{cls.name()}" with FileLock(f"{fn}.lock"):
refactor(polars): handle memtables like every other backend (#10056)	2b0dbb980f40ab52b5cdfbe906233c311c8cf8ee	refactor	https://github.com/rohankumardubey/ibis/commit/2b0dbb980f40ab52b5cdfbe906233c311c8cf8ee	handle memtables like every other backend (#10056)	[email protected]	diff --git a/__init__.py b/__init__.py index 74c8d6f..7772a7f 100644 --- a/__init__.py +++ b/__init__.py @@ -75,6 +75,10 @@ class Backend(BaseBackend, NoUrl): schema = sch.infer(self._tables[name]) return ops.DatabaseTable(name, schema, self).to_expr() + def _register_in_memory_table(self, op: ops.InMemoryTable) -> None: + if (name := op.name) not in self._tables: + self._add_table(name, op.data.to_polars(op.schema).lazy()) + @deprecated( as_of="9.1", instead="use the explicit `read_` method for the filetype you are trying to read, e.g., read_parquet, read_csv, etc.", @@ -466,6 +470,7 @@ class Backend(BaseBackend, NoUrl): streaming: bool = False, kwargs: Any, ) -> pl.DataFrame: + self._run_pre_execute_hooks(expr) table_expr = expr.as_table() lf = self.compile(table_expr, params=params, kwargs) if limit == "default": diff --git a/compiler.py b/compiler.py index b3865a1..d9db5f5 100644 --- a/compiler.py +++ b/compiler.py @@ -9,11 +9,14 @@ from functools import partial, reduce, singledispatch from math import isnan import polars as pl +import sqlglot as sg import ibis.common.exceptions as com import ibis.expr.datatypes as dt import ibis.expr.operations as ops from ibis.backends.pandas.rewrites import PandasAsofJoin, PandasJoin, PandasRename +from ibis.backends.sql.compilers.base import STAR +from ibis.backends.sql.dialects import Polars from ibis.expr.operations.udf import InputType from ibis.formats.polars import PolarsType from ibis.util import gen_name @@ -64,8 +67,9 @@ def dummy_table(op, kw): @translate.register(ops.InMemoryTable) -def in_memory_table(op, _): - return op.data.to_polars(op.schema).lazy() +def in_memory_table(op, , ctx, **_): + sql = sg.select(STAR).from_(sg.to_identifier(op.name, quoted=True)).sql(Polars) + return ctx.execute(sql, eager=False) def _make_duration(value, dtype):
feat(clickhouse): implement `ops.StructColumn` operation	0063007ee48066e07a264e397d41e004701dae06	feat	https://github.com/rohankumardubey/ibis/commit/0063007ee48066e07a264e397d41e004701dae06	implement `ops.StructColumn` operation	[email protected]	diff --git a/registry.py b/registry.py index 3a99c34..34f0a11 100644 --- a/registry.py +++ b/registry.py @@ -654,6 +654,14 @@ def _array_column(translator, expr): return f"[{args}]" +def _struct_column(translator, expr): + args = ", ".join(map(translator.translate, expr.op().values)) + # ClickHouse struct types cannot be nullable + # (non-nested fields can be nullable) + struct_type = serialize(expr.type()(nullable=False)) + return f"CAST(({args}) AS {struct_type})" + + def _clip(translator, expr): op = expr.op() arg = translator.translate(op.arg) @@ -832,6 +840,7 @@ operation_registry = { ops.ArrayColumn: _array_column, ops.Clip: _clip, ops.StructField: _struct_field, + ops.StructColumn: _struct_column, }
fix: add `serde` support for varous reference name types.	70d835b85ba22669bf9a30b209263181b35b9b40	fix	https://github.com/Byron/gitoxide/commit/70d835b85ba22669bf9a30b209263181b35b9b40	add `serde` support for varous reference name types.	[email protected]	diff --git a/lib.rs b/lib.rs index e7d6451..b726855 100644 --- a/lib.rs +++ b/lib.rs @@ -121,12 +121,12 @@ pub(crate) struct Store { inner: store::State, } -/// A validated complete and fully qualified referenced reference name, safe to use for all operations. +/// A validated complete and fully qualified reference name, safe to use for all operations. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub struct FullName(pub(crate) BString); -/// A validated complete and fully qualified referenced reference name, safe to use for all operations. +/// A validated complete and fully qualified reference name, safe to use for all operations. #[derive(Hash, Debug, PartialEq, Eq, Ord, PartialOrd)] #[repr(transparent)] pub struct FullNameRef(BStr); @@ -138,10 +138,12 @@ pub struct PartialNameRef(BStr); /// A validated and potentially partial reference name, safe to use for common operations. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub struct PartialName(BString); /// A _validated_ prefix for references to act as a namespace. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub struct Namespace(BString); /// Denotes the kind of reference. @@ -160,6 +162,7 @@ pub enum Kind { /// /// This translates into a prefix containing all references of a given category. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)] +#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub enum Category<'a> { /// A tag in `refs/tags` Tag, @@ -179,6 +182,7 @@ pub enum Category<'a> { /// A `PseudoRef` in another _linked_ worktree, never in the main one, like `worktrees/<id>/HEAD`. LinkedPseudoRef { /// The name of the worktree. + #[cfg_attr(feature = "serde", serde(borrow))] name: &'a BStr, }, /// Any reference that is prefixed with `worktrees/<id>/refs/`.
feat: implement `write_to()` in full.	ca9294a597d3b4a19aa6338e9ba0893269b9d1a2	feat	https://github.com/Byron/gitoxide/commit/ca9294a597d3b4a19aa6338e9ba0893269b9d1a2	implement `write_to()` in full.	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 78c0c50..4267c41 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1401,9 +1401,14 @@ dependencies = [ "gix-attributes 0.15.0", "gix-features 0.32.0", "gix-filter", + "gix-fs 0.4.0", "gix-hash 0.11.3", "gix-object 0.33.0", + "gix-odb", + "gix-path 0.8.3", + "gix-testtools", "gix-traverse 0.30.0", + "gix-worktree 0.22.0", "parking_lot", "thiserror", ] diff --git a/Cargo.toml b/Cargo.toml index e95c312..55ac049 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,6 +18,13 @@ gix-object = { version = "^0.33.0", path = "../gix-object" } gix-attributes = { version = "^0.15.0", path = "../gix-attributes" } gix-filter = { version = "^0.1.0", path = "../gix-filter" } gix-traverse = { version = "^0.30.0", path = "../gix-traverse" } +gix-fs = { version = "^0.4.0", path = "../gix-fs" } +gix-path = { version = "^0.8.3", path = "../gix-path" } thiserror = "1.0.26" parking_lot = "0.12.1" + +[dev-dependencies] +gix-testtools = { path = "../tests/tools"} +gix-odb = { path = "../gix-odb"} +gix-worktree = { path = "../gix-worktree"} diff --git a/lib.rs b/lib.rs index d56b1e8..ea3f0d2 100644 --- a/lib.rs +++ b/lib.rs @@ -1,8 +1,9 @@ -//! The implementation of creating an archive from a git tree, similar to `git archive`. +//! The implementation of creating an archive from a git tree, similar to `git archive`, but using an internal format. +//! +//! This crate can effectively be used to manipulate worktrees as streams of bytes, which can be decoded using the [`Stream`] type. #![deny(rust_2018_idioms, missing_docs, unsafe_code)] use gix_object::bstr::BString; -use std::sync::Arc; /// pub mod stream; @@ -10,10 +11,20 @@ pub mod stream; mod write; pub use write::write_to; -/// A stream of entries that is produced from an underlying reader. +/// A stream of entries that originate from a git tree and optionally from additional entries. +/// +/// Note that a git tree is mandatory, but the empty tree can be used to effectively disable it. pub struct Stream { - read: gix_features::io::pipe::Reader, - err: Arc<parking_lot::Mutex<Option<stream::Error>>>, + read: stream::utils::Read, + err: stream::SharedErrorSlot, + extra_entries: Option<std::sync::mpsc::Sender<stream::AdditionalEntry>>, + // additional_entries: Vec, /// `None` if currently held by an entry. path_buf: Option<BString>, + /// Another buffer to partially act like a buf-reader. + buf: Vec<u8>, + /// The offset into `buf` for entries being able to act like a buf reader. + pos: usize, + /// The amount of bytes usable from `buf` (even though it always has a fixed size) + filled: usize, } diff --git a/stream.rs b/stream.rs index ce32c90..4f5045f 100644 --- a/stream.rs +++ b/stream.rs @@ -1,123 +0,0 @@ -use crate::Stream; -use gix_object::bstr::{BStr, BString}; -use std::io::{ErrorKind, Read}; - -/// The error returned by [`next_entry()`][Stream::next_entry()]. -#[derive(Debug, thiserror::Error)] -#[allow(missing_docs)] -pub enum Error { - #[error(transparent)] - Io(#[from] std::io::Error), - #[error("Could not find a blob or tree for archival")] - Find(#[source] Box<dyn std::error::Error + Send + Sync + 'static>), - #[error("Could not query attributes for path \\"{path}\\"")] - Attributes { - path: BString, - source: Box<dyn std::error::Error + Send + Sync + 'static>, - }, -} - -/// An entry in a stream. Note that they must be consumed fully, by reading from them till exhaustion. -/// -/// ### Drop behaviour -/// -/// If the entry is dropped without reading it till exhaustion, the stream is tainted and -/// [`next_entry()`][Stream::next_entry()] will panic next time it is called. -pub struct Entry<'a> { - /// Access to our parent - parent: &'a mut Stream, - - /// The path relative to the repository at which data should be written. - path_buf: Option<BString>, - /// The amount of bytes left to read - remaining: usize, -} - -impl Entry<'_> { - /// Return the path of this entry as slash-separated path relative to the repository. - pub fn relative_path(&self) -> &BStr { - self.path_buf.as_ref().expect("always set during our lifetime").as_ref() - } -} - -impl<'a> Drop for Entry<'a> { - fn drop(&mut self) { - if self.remaining == 0 { - self.parent.path_buf = self.path_buf.take(); - } - } -} - -impl std::io::Read for Entry<'_> { - fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { - let buf_len = buf.len(); - if let Some(err) = self.parent.err.lock().take() { - return Err(std::io::Error::new(ErrorKind::Other, err)); - } - let bytes_read = self.parent.read.read(&mut buf[..buf_len.min(self.remaining)])?; - self.remaining -= bytes_read; - Ok(bytes_read) - } -} - -impl Stream { - /// Access the next entry of the stream or `None` if there is nothing more to read. - pub fn next_entry(&mut self) -> Result<Option<Entry<'_>>, Error> { - assert!( - self.path_buf.is_some(), - "BUG: must consume and drop entry before getting the next one" - ); - let res = self.read_entry_info(); - match res { - Ok(remaining) => { - if let Some(err) = self.err.lock().take() { - return Err(err); - } - Ok(Some(Entry { - path_buf: self.path_buf.take(), - parent: self, - remaining, - })) - } - Err(err) => { - if err.kind() == ErrorKind::UnexpectedEof { - if let Some(err) = self.err.lock().take() { - return Err(err); - } - } - Err(err.into()) - } - } - } - - // Format: [usize-LE][usize-LE][relative_path_bytes][object_stream] - fn read_entry_info(&mut self) -> Result<usize, std::io::Error> { - let mut buf = [0; std::mem::size_of::<usize>()]; - - self.read.read_exact(&mut buf)?; - let path_len = usize::from_le_bytes(buf); - - self.read.read_exact(&mut buf)?; - let stream_size = usize::from_le_bytes(buf); - - let path_buf = self.path_buf.as_mut().expect("set while producing an entry"); - clear_and_set_capacity(path_buf, path_len); - - // SAFETY: `clear_and_set_capacity` assures the vec has the right capacity to hold `path_len` - #[allow(unsafe_code)] - unsafe { - path_buf.set_len(path_len); - } - self.read.read_exact(path_buf)?; - - Ok(stream_size) - } -} - -fn clear_and_set_capacity(buf: &mut Vec<u8>, cap: usize) { - buf.clear(); - if buf.capacity() < cap { - buf.reserve(cap); - assert!(buf.capacity() >= cap, "{} >= {}", buf.capacity(), cap); - } -} diff --git a/entry.rs b/entry.rs index 866e209..1d7d4ad 100644 --- a/entry.rs +++ b/entry.rs @@ -0,0 +1,98 @@ +use crate::stream::Entry; +use gix_object::bstr::BStr; +use std::io::{ErrorKind, Read}; +use std::path::PathBuf; + +/// The source of an additional entry +pub enum Source { + /// There is no content, typically the case with directories which are always considered empty. + Null, + /// Read from the file at the given path. + Path(PathBuf), + /// Read from memory. + Memory(Vec<u8>), +} + +impl Source { + pub(crate) fn len(&self) -> Option<usize> { + match self { + Source::Null => Some(0), + Source::Path(_) => None, + Source::Memory(buf) => Some(buf.len()), + } + } +} + +impl std::fmt::Debug for Entry<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("Entry") + .field("path_buf", &self.relative_path()) + .field("mode", &self.mode) + .field("id", &self.id) + .field("remaining", &self.remaining) + .finish() + } +} + +impl Entry<'_> { + /// Return the path of this entry as slash-separated path relative to the repository. + pub fn relative_path(&self) -> &BStr { + self.path_buf.as_ref().expect("always set during our lifetime").as_ref() + } +} + +impl<'a> Drop for Entry<'a> { + fn drop(&mut self) { + if self.remaining == Some(0) { + self.parent.path_buf = self.path_buf.take(); + } + } +} + +impl Entry<'_> { + fn fill_buf(&mut self) -> std::io::Result<&[u8]> { + if self.parent.pos >= self.parent.filled { + let mut u16_buf = [0; 2]; + self.parent.read.read_exact(&mut u16_buf)?; + let nb = u16::from_le_bytes(u16_buf) as usize; + + if nb != 0 { + self.parent + .read + .read_exact(&mut self.parent.buf[self.parent.filled..][..nb])?; + } + self.parent.filled = nb; + self.parent.pos = 0; + } + Ok(&self.parent.buf[self.parent.pos..self.parent.filled]) + } +} + +impl std::io::Read for Entry<'_> { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + let buf_len = buf.len(); + if let Some(err) = self.parent.err.lock().take() { + return Err(std::io::Error::new(ErrorKind::Other, err)); + } + let bytes_read = match self.remaining.as_mut() { + None => { + // We expect a zero-read to indicate the end of stream, which is the default way of streams to end. + // In our case though, it requires sending an extra zero-write, so we avoid that usually. + let input = self.fill_buf()?; + let nb = input.len().min(buf.len()); + buf[..nb].copy_from_slice(&input[..nb]); + self.parent.pos += nb; + nb + } + Some(remaining) => { + let bytes_read = self.parent.read.read(&mut buf[..buf_len.min(remaining)])?; + remaining -= bytes_read; + bytes_read + } + }; + if bytes_read == 0 { + self.remaining = Some(0); + } + Ok(bytes_read) + } +} diff --git a/mod.rs b/mod.rs index 3b2011f..04efbac 100644 --- a/mod.rs +++ b/mod.rs @@ -0,0 +1,151 @@ +use crate::stream::{Error, SharedErrorSlot}; +use crate::{stream, Stream}; +use gix_object::bstr::BStr; +use std::io::Write; + +/// Use `find` to traverse `tree` and fetch the contained blobs to return as [`Stream`], which makes them queryable +/// on demand with support for streaming each entry. +/// `pipeline` is used to convert blobs to their worktree representation, and `attributes` is used to read +/// the `export-ignore` attribute. If set on a directory or blob, it won't be added to the archive. +/// +/// ### Types of entries in stream +/// +/// We only return blobs (with or without executable), which may be symlinks in which case their content will +/// be target of the symlink. +/// Directories are never returned, but maybe added by the caller via [Stream::add_entry()]. +/// +/// ### Progress and interruptions +/// +/// For per-file progress, integrate progress handling into the calls of [`Stream::next_entry()`] as that +/// correlates blobs. +/// Additional interrupt handling can be wrapped around the `Read` implementation of each [`stream::Entry`]. +/// For progress on bytes-written, integrate progress reporting when consuming the stream. +/// Further it's possible to drop the returned [`Stream`] to halt all operation. +/// +/// ### Threaded Operation +/// +/// This function spawns a thread that will access the tree data in the background, synchronized through +/// `Stream` so that it will not be faster than the consumer, with at most one file in flight at any time. +/// +/// ### Limitations +/// +/// * `export-subst` is not support, as it requires the entire formatting engine of `git log`. +pub fn write_to<Find, E1, E2>( + tree: gix_hash::ObjectId, + find: Find, + pipeline: gix_filter::Pipeline, + attributes: impl FnMut(&BStr, gix_object::tree::EntryMode, &mut gix_attributes::search::Outcome) -> Result<(), E2> + + Send + + 'static, +) -> Stream +where + Find: for<'a> FnMut(&gix_hash::oid, &'a mut Vec<u8>) -> Result<gix_object::Data<'a>, E1> + Clone + Send + 'static, + E1: std::error::Error + Send + Sync + 'static, + E2: std::error::Error + Send + Sync + 'static, +{ + let (stream, mut write, additional_entries) = Stream::new(); + std::thread::spawn({ + let slot = stream.err.clone(); + move \|\| { + if let Err(err) = run( + tree, + find, + pipeline, + attributes, + &mut write, + slot.clone(), + additional_entries, + ) { + { + let mut slot = slot.lock(); + if slot.is_none() { + slot = Some(err); + } else { + drop(slot); + write + .channel + .send(Err(std::io::Error::new(std::io::ErrorKind::Other, err))) + .ok(); + } + } + } + } + }); + stream +} + +fn run<Find, E1, E2>( + tree: gix_hash::ObjectId, + mut find: Find, + pipeline: gix_filter::Pipeline, + mut attributes: impl FnMut(&BStr, gix_object::tree::EntryMode, &mut gix_attributes::search::Outcome) -> Result<(), E2> + + Send + + 'static, + out: &mut gix_features::io::pipe::Writer, + err: SharedErrorSlot, + additional_entries: std::sync::mpsc::Receiver<stream::AdditionalEntry>, +) -> Result<(), Error> +where + Find: for<'a> FnMut(&gix_hash::oid, &'a mut Vec<u8>) -> Result<gix_object::Data<'a>, E1> + Clone + Send + 'static, + E1: std::error::Error + Send + Sync + 'static, + E2: std::error::Error + Send + Sync + 'static, +{ + let mut buf = Vec::new(); + let obj = find(tree.as_ref(), &mut buf).map_err(\|err\| Error::Find(Box::new(err)))?; + let tree = gix_object::TreeRefIter::from_bytes(obj.data); + + let mut attrs = gix_attributes::search::Outcome::default(); + attrs.initialize_with_selection(&Default::default(), Some("export-ignore")); + let mut dlg = traverse::Delegate { + out, + err, + pipeline, + attrs, + find: { + let mut find = find.clone(); + move \|a: &gix_hash::oid, b: &mut Vec<u8>\| find(a, b).map_err(\|err\| stream::Error::Find(Box::new(err))) + }, + fetch_attributes: move \|a: &BStr, b: gix_object::tree::EntryMode, c: &mut gix_attributes::search::Outcome\| { + attributes(a, b, c).map_err(\|err\| stream::Error::Attributes { + source: Box::new(err), + path: a.to_owned(), + }) + }, + path_deque: Default::default(), + path: Default::default(), + buf: Vec::with_capacity(1024), + }; + gix_traverse::tree::breadthfirst( + tree, + gix_traverse::tree::breadthfirst::State::default(), + \|id, buf\| { + find(id, buf) + .map(\|obj\| gix_object::TreeRefIter::from_bytes(obj.data)) + .ok() + }, + &mut dlg, + )?; + + for entry in additional_entries { + stream::protocol::write_entry_header_and_path( + entry.relative_path.as_ref(), + &entry.id, + entry.mode, + entry.source.len(), + out, + )?; + // pipe writer always writes all in one go. + #[allow(clippy::unused_io_amount)] + match entry.source { + stream::entry::Source::Memory(buf) => out.write(&buf).map(\|_\| ()), + stream::entry::Source::Null => out.write(&[]).map(\|_\| ()), + stream::entry::Source::Path(path) => { + let file = std::fs::File::open(path)?; + stream::protocol::write_stream(&mut buf, file, out) + } + }? + } + Ok(()) +} + +mod traverse; diff --git a/protocol.rs b/protocol.rs index 69ef32e..d5d4c37 100644 --- a/protocol.rs +++ b/protocol.rs @@ -0,0 +1,175 @@ +use crate::stream::{Entry, Error}; +use crate::{stream, Stream}; +use gix_object::bstr::{BStr, BString}; +use std::io::{ErrorKind, Read, Write}; + +impl Stream { + /// Access the next entry of the stream or `None` if there is nothing more to read. + pub fn next_entry(&mut self) -> Result<Option<Entry<'_>>, Error> { + assert!( + self.path_buf.is_some(), + "BUG: must consume and drop entry before getting the next one" + ); + self.extra_entries.take(); + let res = read_entry_info( + &mut self.read, + self.path_buf.as_mut().expect("set while producing an entry"), + ); + match res { + Ok((remaining, mode, id)) => { + if let Some(err) = self.err.lock().take() { + return Err(err); + } + Ok(Some(Entry { + path_buf: self.path_buf.take(), + parent: self, + id, + mode, + remaining, + })) + } + Err(err) => { + if let Some(err) = self.err.lock().take() { + return Err(err); + } + // unexpected EOF means the other side dropped. We handled potential errors already. + if err.kind() == ErrorKind::UnexpectedEof { + return Ok(None); + } + Err(err.into()) + } + } + } +} + +// Format: [usize-LE][usize-LE][byte][byte][hash][relative_path_bytes][object_stream] +// Note that stream_len can be usize::MAX to indicate the stream size is unknown +fn read_entry_info( + read: &mut stream::utils::Read, + path_buf: &mut BString, +) -> std::io::Result<(Option<usize>, gix_object::tree::EntryMode, gix_hash::ObjectId)> { + let mut buf = [0; std::mem::size_of::<usize>() 2 + 2]; + + read.read_exact(&mut buf)?; + let (path_len, rest) = buf.split_at(std::mem::size_of::<usize>()); + let (stream_len, bytes) = rest.split_at(std::mem::size_of::<usize>()); + let path_len = usize::from_le_bytes(path_len.try_into().expect("valid")); + let stream_size = usize::from_le_bytes(stream_len.try_into().expect("valid")); + let mode = byte_to_mode(bytes[0]); + let hash_kind = byte_to_hash(bytes[1]); + + let mut hash = hash_kind.null(); + read.read_exact(hash.as_mut_slice())?; + + clear_and_set_len(path_buf, path_len); + read.read_exact(path_buf)?; + + Ok(((stream_size != usize::MAX).then_some(stream_size), mode, hash)) +} + +/// This function must match the read-count of `read_entry_info` for max efficiency. +pub(crate) fn write_entry_header_and_path( + path: &BStr, + oid: &gix_hash::oid, + mode: gix_object::tree::EntryMode, + stream_len: Option<usize>, + out: &mut gix_features::io::pipe::Writer, +) -> std::io::Result<()> { + let mut buf = [0u8; std::mem::size_of::<usize>() * 2 + 2]; + let (path_len_buf, rest) = buf.split_at_mut(std::mem::size_of::<usize>()); + let (stream_len_buf, bytes) = rest.split_at_mut(std::mem::size_of::<usize>()); + + path_len_buf.copy_from_slice(&path.len().to_le_bytes()); + stream_len_buf.copy_from_slice(&stream_len.unwrap_or(usize::MAX).to_le_bytes()); + bytes[0] = mode_to_byte(mode); + bytes[1] = hash_to_byte(oid.kind()); + + // We know how `out` works in a pipe writer, it's always writing everything. + #[allow(clippy::unused_io_amount)] + { + out.write(&buf)?; + out.write(oid.as_bytes())?; + out.write(path)?; + } + Ok(()) +} + +/// This writes everything in `input` in such way that the receiver knows exactly how much to read. +/// The format is similar to the packetline format, but in binary. +pub(crate) fn write_stream( + buf: &mut Vec<u8>, + mut input: impl std::io::Read, + out: &mut gix_features::io::pipe::Writer, +) -> std::io::Result<()> { + const BUF_LEN: usize = u16::MAX as usize; + clear_and_set_len(buf, BUF_LEN); + + // We know how `out` works in a pipe writer, it's always writing everything. + #[allow(clippy::unused_io_amount)] + loop { + match input.read(buf) { + Ok(0) => { + // terminator + out.write(&0_u16.to_le_bytes())?; + break; + } + Ok(n) => { + out.write(&(n as u16).to_le_bytes())?; + out.write(&buf[..n])?; + } + Err(ref e) if e.kind() == ErrorKind::Interrupted => {} + Err(e) => return Err(e), + } + } + + Ok(()) +} + +fn byte_to_hash(b: u8) -> gix_hash::Kind { + match b { + 0 => gix_hash::Kind::Sha1, + _ => unreachable!("BUG: we control the protocol"), + } +} + +fn byte_to_mode(b: u8) -> gix_object::tree::EntryMode { + use gix_object::tree::EntryMode::; + match b { + 0 => Tree, + 1 => Blob, + 2 => BlobExecutable, + 3 => Link, + 4 => Commit, + _ => unreachable!("BUG: we control the protocol"), + } +} + +fn hash_to_byte(h: gix_hash::Kind) -> u8 { + match h { + gix_hash::Kind::Sha1 => 0, + } +} + +fn mode_to_byte(m: gix_object::tree::EntryMode) -> u8 { + use gix_object::tree::EntryMode::; + match m { + Tree => 0, + Blob => 1, + BlobExecutable => 2, + Link => 3, + Commit => 4, + } +} + +fn clear_and_set_len(buf: &mut Vec<u8>, len: usize) { + buf.clear(); + if buf.capacity() < len { + buf.reserve(len); + assert!(buf.capacity() >= len, "{} >= {}", buf.capacity(), len); + } + // SAFETY: we just assured that `buf` has the right capacity to hold `cap` + #[allow(unsafe_code)] + unsafe { + buf.set_len(len); + } +} diff --git a/write.rs b/write.rs index 2b21d37..95c7d70 100644 --- a/write.rs +++ b/write.rs @@ -1,37 +0,0 @@ -use crate::Stream; -use gix_object::bstr::BStr; - -/// Use `find` to traverse `tree` and fetch the contained blobs to return as [`Stream`], which makes them queryable -/// on demand with support for streaming each entry. -/// `pipeline` is used to convert blobs to their worktree representation, and `attributes` is used to read -/// the `export-ignore` attribute. If set on a directory or blob, it won't be added to the archive. -/// -/// ### Progress and interruptions -/// -/// For per-file progress, integrate progress handling into `find` as it is called for trees and blobs. -/// `find` should also be used for interrupt handling, as it can return an error once per file. -/// For progress on bytes-written, integrate progress reporting when consuming the stream. -/// Further it's possible to drop the returned [`Stream`] to halt all operation. -/// -/// ### Threaded Operation -/// -/// This function spawns a thread that will access the tree data in the background, synchronized through -/// `Stream` so that it will not be faster than the consumer, with at most one file in flight at any time. -/// -/// ### Limitations -/// -/// * `export-subst` is not support, as it requires the entire formatting engine of `git log`. -pub fn write_to<W, Find, E1, E2>( - _tree: gix_hash::ObjectId, - mut _find: Find, - _pipeline: &mut gix_filter::Pipeline, - _attributes: impl FnMut(&BStr, &mut gix_attributes::search::Outcome) -> Result<(), E2> + Send, -) -> Stream -where - W: std::io::Write, - Find: for<'a> FnMut(&gix_hash::oid, &'a mut Vec<u8>) -> Result<gix_object::Data<'a>, E1> + Send, - E1: std::error::Error + Send + Sync + 'static, - E2: std::error::Error + Send + Sync + 'static, -{ - todo!() -} diff --git a/traverse.rs b/traverse.rs index b8782d9..8dcf740 100644 --- a/traverse.rs +++ b/traverse.rs @@ -0,0 +1,153 @@ +use crate::stream; +use crate::stream::SharedErrorSlot; +use gix_filter::driver::apply::MaybeDelayed; +use gix_filter::pipeline::convert::ToWorktreeOutcome; +use gix_object::bstr::{BStr, BString, ByteSlice, ByteVec}; +use gix_object::tree; +use gix_traverse::tree::visit::Action; +use gix_traverse::tree::Visit; +use std::collections::VecDeque; +use std::io::Write; + +pub struct Delegate<'a, AttributesFn, FindFn> +where + FindFn: for<'b> FnMut(&gix_hash::oid, &'b mut Vec<u8>) -> Result<gix_object::Data<'b>, stream::Error> + 'static, +{ + pub(crate) out: &'a mut gix_features::io::pipe::Writer, + pub(crate) err: SharedErrorSlot, + pub(crate) path_deque: VecDeque<BString>, + pub(crate) path: BString, + pub(crate) pipeline: gix_filter::Pipeline, + pub(crate) attrs: gix_attributes::search::Outcome, + pub(crate) fetch_attributes: AttributesFn, + pub(crate) find: FindFn, + pub(crate) buf: Vec<u8>, +} + +impl<AttributesFn, FindFn> Delegate<'_, AttributesFn, FindFn> +where + FindFn: for<'b> FnMut(&gix_hash::oid, &'b mut Vec<u8>) -> Result<gix_object::Data<'b>, stream::Error> + 'static, + AttributesFn: FnMut(&BStr, gix_object::tree::EntryMode, &mut gix_attributes::search::Outcome) -> Result<(), stream::Error> + + 'static, +{ + fn pop_element(&mut self) { + if let Some(pos) = self.path.rfind_byte(b'/') { + self.path.resize(pos, 0); + } else { + self.path.clear(); + } + } + + fn push_element(&mut self, name: &BStr) { + if !self.path.is_empty() { + self.path.push(b'/'); + } + self.path.push_str(name); + } + /// Return the state of the `export-ignore` attribute. + fn ignore_state(&self) -> gix_attributes::StateRef<'_> { + self.attrs + .iter_selected() + .next() + .expect("initialized with one attr") + .assignment + .state + } + + fn handle_entry(&mut self, entry: &tree::EntryRef<'_>) -> Result<Action, stream::Error> { + if !entry.mode.is_blob_or_symlink() { + return Ok(Action::Continue); + } + (self.fetch_attributes)(self.path.as_ref(), entry.mode, &mut self.attrs)?; + if self.ignore_state().is_set() { + return Ok(Action::Continue); + } + (self.find)(entry.oid, &mut self.buf)?; + + let converted = self.pipeline.convert_to_worktree( + &self.buf, + self.path.as_ref(), + \|a, b\| { + (self.fetch_attributes)(a, entry.mode, b).ok(); + }, + gix_filter::driver::apply::Delay::Forbid, + )?; + + // Our pipe writer always writes the whole amount. + #[allow(clippy::unused_io_amount)] + match converted { + ToWorktreeOutcome::Unchanged(buf) \| ToWorktreeOutcome::Buffer(buf) => { + stream::protocol::write_entry_header_and_path( + self.path.as_ref(), + entry.oid, + entry.mode, + Some(buf.len()), + self.out, + )?; + self.out.write(buf)?; + } + ToWorktreeOutcome::Process(MaybeDelayed::Immediate(read)) => { + stream::protocol::write_entry_header_and_path( + self.path.as_ref(), + entry.oid, + entry.mode, + None, + self.out, + )?; + stream::protocol::write_stream(&mut self.buf, read, self.out)?; + } + ToWorktreeOutcome::Process(MaybeDelayed::Delayed(_)) => { + unreachable!("we forbade it") + } + } + Ok(Action::Continue) + } +} + +impl<AttributesFn, FindFn> Visit for Delegate<'_, AttributesFn, FindFn> +where + FindFn: for<'a> FnMut(&gix_hash::oid, &'a mut Vec<u8>) -> Result<gix_object::Data<'a>, stream::Error> + 'static, + AttributesFn: FnMut(&BStr, gix_object::tree::EntryMode, &mut gix_attributes::search::Outcome) -> Result<(), stream::Error> + + 'static, +{ + fn pop_front_tracked_path_and_set_current(&mut self) { + self.path = self + .path_deque + .pop_front() + .expect("every call is matched with push_tracked_path_component"); + } + + fn push_back_tracked_path_component(&mut self, component: &BStr) { + self.push_element(component); + self.path_deque.push_back(self.path.clone()); + } + + fn push_path_component(&mut self, component: &BStr) { + self.push_element(component); + } + + fn pop_path_component(&mut self) { + self.pop_element() + } + + fn visit_tree(&mut self, entry: &tree::EntryRef<'_>) -> Action { + if let Err(err) = (self.fetch_attributes)(self.path.as_ref(), entry.mode, &mut self.attrs) { + self.err.lock() = Some(err); + Action::Cancel + } else if self.ignore_state().is_set() { + Action::Skip + } else { + Action::Continue + } + } + + fn visit_nontree(&mut self, entry: &tree::EntryRef<'_>) -> Action { + match self.handle_entry(entry) { + Ok(action) => action, + Err(err) => { + self.err.lock() = Some(err); + Action::Cancel + } + } + } +} diff --git a/archive.rs b/archive.rs index 0606365..b09a76c 100644 --- a/archive.rs +++ b/archive.rs @@ -1 +1,295 @@ +/// Convert a hexadecimal hash into its corresponding `ObjectId` or _panic_. +fn hex_to_id(hex: &str) -> gix_hash::ObjectId { + gix_hash::ObjectId::from_hex(hex.as_bytes()).expect("40 bytes hex") +} +mod write_to { + use crate::hex_to_id; + use gix_archive::write_to; + use gix_attributes::glob::pattern::Case; + use gix_object::bstr::ByteSlice; + use gix_object::tree::EntryMode; + use gix_odb::FindExt; + use gix_testtools::once_cell::sync::Lazy; + use gix_worktree::cache::state::attributes::Source; + use std::convert::Infallible; + use std::io::{Error, ErrorKind, Read, Write}; + use std::path::PathBuf; + use std::sync::Arc; + + #[test] + fn can_receive_err_if_root_is_not_found() { + let mut stream = write_to( + gix_hash::Kind::Sha1.null(), + \|_, _\| Err(Error::new(ErrorKind::Other, "object retrieval failed")), + mutating_pipeline(false), + \|_, _, _\| -> Result<_, Infallible> { unreachable!("must not be called") }, + ); + let err = stream.next_entry().unwrap_err(); + assert_eq!(err.to_string(), "Could not find a blob or tree for archival"); + } + + #[test] + fn can_receive_err_if_attribute_not_found() -> gix_testtools::Result { + let (_dir, head_tree, odb, _cache) = basic()?; + let mut stream = write_to( + head_tree, + move \|id, buf\| odb.find(id, buf), + mutating_pipeline(false), + \|_, _, _\| Err(Error::new(ErrorKind::Other, "attribute retrieval failed")), + ); + let err = stream.next_entry().unwrap_err(); + assert_eq!( + err.to_string(), + "Could not query attributes for path \\".gitattributes\\"" + ); + Ok(()) + } + + #[test] + fn will_provide_all_information_and_respect_export_ignore() -> gix_testtools::Result { + let (dir, head_tree, odb, mut cache) = basic()?; + let mut stream = write_to( + head_tree, + { + let odb = odb.clone(); + move \|id, buf\| odb.find(id, buf) + }, + mutating_pipeline(true), + move \|rela_path, mode, attrs\| { + cache + .at_entry(rela_path, mode.is_tree().into(), \|id, buf\| odb.find_blob(id, buf)) + .map(\|entry\| entry.matching_attributes(attrs)) + .map(\|_\| ()) + }, + ); + stream + .add_entry_from_path(&dir, &dir.join("extra-file"))? + .add_entry_from_path(&dir, &dir.join("extra-exe"))? + .add_entry_from_path(&dir, &dir.join("extra-dir-empty"))? + .add_entry_from_path(&dir, &dir.join("extra-dir").join("symlink-to-extra"))?; + + let tee_read = TeeToMemory { + read: stream.into_read(), + write: Default::default(), + }; + let copy = tee_read.write.clone(); + let mut paths_and_modes = Vec::new(); + let mut stream = gix_archive::Stream::from_read(tee_read); + + while let Some(mut entry) = stream.next_entry().expect("entry retrieval does not fail") { + paths_and_modes.push((entry.relative_path().to_owned(), entry.mode, entry.id)); + let mut buf = Vec::new(); + entry.read_to_end(&mut buf).expect("stream can always be read"); + if !buf.is_empty() && entry.mode.is_blob() { + if entry.relative_path().contains_str("extra") { + assert!( + buf.find_byte(b'\\r').is_none(), + "extra-files are not processed in any way" + ); + } else { + assert!( + buf.find_byte(b'\\r').is_some(), + "'{}' did not contain a carriage return as sign of having been filtered", + buf.as_bstr() + ); + if entry.relative_path().ends_with_str(b"streamed") { + assert_eq!(buf.as_bstr(), "➡streamed-by-driver\\r\\n"); + } + } + } + } + + let expected_extra_exe_mode = if cfg!(windows) { + EntryMode::Blob + } else { + EntryMode::BlobExecutable + }; + assert_eq!( + paths_and_modes, + &[ + ( + ".gitattributes".into(), + EntryMode::Blob, + hex_to_id("45c160c35c17ad264b96431cceb9793160396e99") + ), + ( + "a".into(), + EntryMode::Blob, + hex_to_id("45b983be36b73c0788dc9cbcb76cbb80fc7bb057") + ), + ( + "symlink-to-a".into(), + EntryMode::Link, + hex_to_id("2e65efe2a145dda7ee51d1741299f848e5bf752e") + ), + ( + "dir/.gitattributes".into(), + EntryMode::Blob, + hex_to_id("81b9a375276405703e05be6cecf0fc1c8b8eed64") + ), + ( + "dir/b".into(), + EntryMode::Blob, + hex_to_id("ab4a98190cf776b43cb0fe57cef231fb93fd07e6") + ), + ( + "dir/subdir/exe".into(), + EntryMode::BlobExecutable, + hex_to_id("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391") + ), + ( + "dir/subdir/streamed".into(), + EntryMode::Blob, + hex_to_id("08991f58f4de5d85b61c0f87f3ac053c79d0e739") + ), + ( + "extra-file".into(), + EntryMode::Blob, + hex_to_id("0000000000000000000000000000000000000000") + ), + ( + "extra-exe".into(), + expected_extra_exe_mode, + hex_to_id("0000000000000000000000000000000000000000") + ), + ( + "extra-dir-empty".into(), + EntryMode::Tree, + hex_to_id("0000000000000000000000000000000000000000") + ), + ( + "extra-dir/symlink-to-extra".into(), + EntryMode::Link, + hex_to_id("0000000000000000000000000000000000000000") + ) + ] + ); + assert_eq!( + copy.lock().len(), + 710, + "keep track of file size changes of the streaming format" + ); + + let mut copied_stream = gix_archive::Stream::from_read(std::io::Cursor::new(copy.lock().as_bytes().to_owned())); + let mut copied_paths_and_modes = Vec::new(); + let mut buf = Vec::new(); + while let Some(mut entry) = copied_stream.next_entry().expect("entry retrieval does not fail") { + copied_paths_and_modes.push((entry.relative_path().to_owned(), entry.mode, entry.id)); + buf.clear(); + entry.read_to_end(&mut buf).expect("stream can always be read"); + } + assert_eq!( + copied_paths_and_modes, paths_and_modes, + "a stream copy yields exactly the same result" + ); + Ok(()) + } + + #[test] + fn can_drop_entry_without_reading_it() -> gix_testtools::Result { + let (_dir, head_tree, odb, mut cache) = basic()?; + let mut stream = write_to( + head_tree, + { + let odb = odb.clone(); + move \|id, buf\| odb.find(id, buf) + }, + mutating_pipeline(false), + move \|rela_path, mode, attrs\| { + cache + .at_entry(rela_path, mode.is_tree().into(), \|id, buf\| odb.find_blob(id, buf)) + .map(\|entry\| entry.matching_attributes(attrs)) + .map(\|_\| ()) + }, + ); + + drop(stream.next_entry().expect("entry retrieval does not fail")); + Ok(()) + } + + fn basic() -> gix_testtools::Result<(PathBuf, gix_hash::ObjectId, gix_odb::HandleArc, gix_worktree::Cache)> { + let dir = gix_testtools::scripted_fixture_read_only("basic.sh")?; + + let head = { + let hex = std::fs::read(dir.join("head.hex"))?; + gix_hash::ObjectId::from_hex(hex.trim())? + }; + let odb = gix_odb::at(dir.join(".git").join("objects"))?; + + let mut collection = Default::default(); + let mut buf = Default::default(); + let attributes = gix_worktree::cache::state::Attributes::new( + gix_attributes::Search::new_globals(None::<PathBuf>, &mut buf, &mut collection)?, + None, + Source::WorktreeThenIdMapping, + collection, + ); + let state = gix_worktree::cache::State::AttributesStack(attributes); + let cache = gix_worktree::Cache::new(&dir, state, Case::Sensitive, Default::default(), Default::default()); + Ok((dir, head, odb.into_arc()?, cache)) + } + + fn mutating_pipeline(driver: bool) -> gix_filter::Pipeline { + gix_filter::Pipeline::new( + &Default::default(), + gix_filter::pipeline::Options { + drivers: if driver { vec![driver_with_process()] } else { vec![] }, + eol_config: gix_filter::eol::Configuration { + auto_crlf: gix_filter::eol::AutoCrlf::Enabled, + ..Default::default() + }, + ..Default::default() + }, + ) + } + + pub(crate) fn driver_with_process() -> gix_filter::Driver { + let mut exe = DRIVER.to_string_lossy().into_owned(); + if cfg!(windows) { + exe = exe.replace('\\\\', "/"); + } + gix_filter::Driver { + name: "arrow".into(), + clean: None, + smudge: None, + process: Some((exe + " process").into()), + required: true, + } + } + + static DRIVER: Lazy<PathBuf> = Lazy::new(\|\| { + let mut cargo = std::process::Command::new(env!("CARGO")); + let res = cargo + .args(["build", "-p=gix-filter", "--example", "arrow"]) + .status() + .expect("cargo should run fine"); + assert!(res.success(), "cargo invocation should be successful"); + + let path = PathBuf::from(env!("CARGO_TARGET_TMPDIR")) + .ancestors() + .nth(1) + .expect("first parent in target dir") + .join("debug") + .join("examples") + .join(if cfg!(windows) { "arrow.exe" } else { "arrow" }); + assert!(path.is_file(), "Expecting driver to be located at {path:?}"); + path + }); + + struct TeeToMemory<R> { + read: R, + write: Arc<parking_lot::Mutex<Vec<u8>>>, + } + + impl<R> std::io::Read for TeeToMemory<R> + where + R: std::io::Read, + { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + let nb = self.read.read(buf)?; + self.write.lock().write_all(&buf[..nb])?; + Ok(nb) + } + } +} diff --git a/basic.sh b/basic.sh index cbdbdfe..0e2ac22 100644 --- a/basic.sh +++ b/basic.sh @@ -0,0 +1,31 @@ +set -eu -o pipefail + +git init + +mkdir dir-ignored +touch dir-ignored/file-ignored-transitively +touch file-ignored + +echo "hi" > a +mkdir dir +echo "ho" > dir/b +mkdir dir/subdir +echo "subdir/streamed filter=arrow" > dir/.gitattributes +echo "streamed-by-driver" > dir/subdir/streamed +touch dir/subdir/exe +chmod +x dir/subdir/exe +ln -s a symlink-to-a + +echo "/dir-ignored/ export-ignore" > .gitattributes +echo "/file-ignored export-ignore" >> .gitattributes + +git add . +git commit -m "init" + +echo "extra" > extra-file +touch extra-exe && chmod +x extra-exe +mkdir extra-dir-empty extra-dir +ln -s ../extra-file extra-dir/symlink-to-extra + +git rev-parse @^{tree} > head.hex + diff --git a/basic.tar.xz b/basic.tar.xz index 6ecafed..e44029f 100644 --- a/basic.tar.xz +++ b/basic.tar.xz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:939077297db2dbe9917633082205c063bcd35e890b2877d530f2e0f4a75d7e3f +size 11544
fix(core): support advanced custom types in batch queries Closes #1625	88cc71e933d99416fa6a6e24759db281194e97c1	fix	https://github.com/mikro-orm/mikro-orm/commit/88cc71e933d99416fa6a6e24759db281194e97c1	support advanced custom types in batch queries Closes #1625	[email protected]	diff --git a/AbstractSqlDriver.ts b/AbstractSqlDriver.ts index 15f7b1f..e2809dd 100644 --- a/AbstractSqlDriver.ts +++ b/AbstractSqlDriver.ts @@ -225,12 +225,21 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra sql += ` values `; const params: any[] = []; sql += data.map(row => { - let len = 0; + const keys: string[] = []; props.forEach(prop => { - len += prop.fieldNames.length; - prop.fieldNames.length > 1 ? params.push(...(row[prop.name] as unknown[])) : params.push(row[prop.name]); + if (prop.fieldNames.length > 1) { + params.push(...(row[prop.name] as unknown[])); + keys.push(...prop.fieldNames.map(_ => '?')); + } else if (prop.customType && 'convertToDatabaseValueSQL' in prop.customType && !this.platform.isRaw(row[prop.name])) { + keys.push(prop.customType.convertToDatabaseValueSQL!('?', this.platform)); + params.push(row[prop.name]); + } else { + params.push(row[prop.name]); + keys.push('?'); + } }); - return '(' + new Array(len).fill('?').join(', ') + ')'; + + return '(' + keys.join(', ') + ')'; }).join(', '); if (this.platform.usesReturningStatement()) { @@ -296,12 +305,20 @@ export abstract class AbstractSqlDriver<C extends AbstractSqlConnection = Abstra keys.forEach(key => { const prop = meta.properties[key]; + prop.fieldNames.forEach((fieldName: string, fieldNameIdx: number) => { sql += `${this.platform.quoteIdentifier(fieldName)} = case`; where.forEach((cond, idx) => { if (key in data[idx]) { const pks = Utils.getOrderedPrimaryKeys(cond as Dictionary, meta); - sql += ` when (${pkCond}) then ?`; + sql += ` when (${pkCond}) then `; + + if (prop.customType && 'convertToDatabaseValueSQL' in prop.customType && !this.platform.isRaw(data[idx][key])) { + sql += prop.customType.convertToDatabaseValueSQL!('?', this.platform); + } else { + sql += '?'; + } + params.push(...pks, prop.fieldNames.length > 1 ? data[idx][key][fieldNameIdx] : data[idx][key]); } }); diff --git a/custom-types.test.ts b/custom-types.test.ts index 633819e..0a525b4 100644 --- a/custom-types.test.ts +++ b/custom-types.test.ts @@ -160,4 +160,27 @@ describe('custom types [mysql]', () => { expect(meta.properties.extendedPoint.customType).toBeInstanceOf(ExtendedPointType); }); + test('create and update many records with custom types (gh issue 1625)', async () => { + const mock = jest.fn(); + const logger = new Logger(mock, ['query', 'query-params']); + Object.assign(orm.config, { logger }); + + const locations = [new Location(), new Location()]; + locations[0].point = new Point(-1.23, -4.56); + locations[1].point = new Point(-7.89, -0.12); + await orm.em.persistAndFlush(locations); + + locations[0].point = new Point(1.23, 4.56); + locations[1].point = new Point(7.89, 0.12); + await orm.em.persistAndFlush(locations); + + expect(mock.mock.calls[0][0]).toMatch('begin'); + expect(mock.mock.calls[1][0]).toMatch('insert into `location` (`point`) values (ST_PointFromText(\\'point(-1.23 -4.56)\\')), (ST_PointFromText(\\'point(-7.89 -0.12)\\'))'); + expect(mock.mock.calls[2][0]).toMatch('commit'); + expect(mock.mock.calls[3][0]).toMatch('begin'); + expect(mock.mock.calls[4][0]).toMatch(`update \\`location\\` set \\`point\\` = case when (\\`id\\` = ${locations[0].id}) then ST_PointFromText('point(1.23 4.56)') when (\\`id\\` = ${locations[1].id}) then ST_PointFromText('point(7.89 0.12)') else \\`point\\` end where \\`id\\` in (${locations[0].id}, ${locations[1].id})`); + expect(mock.mock.calls[5][0]).toMatch('commit'); + expect(mock.mock.calls).toHaveLength(6); + }); + });
chore(release): update internal dependencies [skip ci]	c0dacd8964786118d094fb6f88c3c136bcfa7115	chore	https://github.com/mikro-orm/mikro-orm/commit/c0dacd8964786118d094fb6f88c3c136bcfa7115	update internal dependencies [skip ci]	[email protected]	diff --git a/package.json b/package.json index 1788fad..b462930 100644 --- a/package.json +++ b/package.json @@ -58,7 +58,7 @@ "access": "public" }, "dependencies": { - "@mikro-orm/knex": "^6.3.7", + "@mikro-orm/knex": "6.3.7", "fs-extra": "11.2.0", "sqlite3": "5.1.7", "sqlstring-sqlite": "0.1.1" diff --git a/yarn.lock b/yarn.lock index b3b328a..6cc27b4 100644 --- a/yarn.lock +++ b/yarn.lock Binary files a/yarn.lock and b/yarn.lock differ
chore: add github action to deploy docs	4cc333e5f46c0a1670d8554f2d4ef9a4052849a8	chore	https://github.com/mikro-orm/mikro-orm/commit/4cc333e5f46c0a1670d8554f2d4ef9a4052849a8	add github action to deploy docs	[email protected]	diff --git a/docs.yml b/docs.yml index 3f12a41..6e0c5d6 100644 --- a/docs.yml +++ b/docs.yml @@ -0,0 +1,26 @@ +name: CI + +on: + push: + branches: + - master + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: Use Node.js 12 + uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node_version }} + + - name: Build docs + run: \| + cd docs + yarn + yarn deploy + env: + GIT_USER: B4nan + GH_TOKEN: ${{ secrets.GH_TOKEN }}
ci: fix `actionlint` lints	4e49032a6a5715a32d936fda3a4c6e8a58e84fe8	ci	https://github.com/ibis-project/ibis/commit/4e49032a6a5715a32d936fda3a4c6e8a58e84fe8	fix `actionlint` lints	[email protected]	diff --git a/ci-data.yml b/ci-data.yml index 8ab293d..3180837 100644 --- a/ci-data.yml +++ b/ci-data.yml @@ -14,7 +14,7 @@ jobs: run: \| set -euo pipefail - echo "::set-output name=yesterday::$(date --date=yesterday +%Y-%m-%d)" + echo "yesterday=$(date --date=yesterday +%Y-%m-%d)" >> "$GITHUB_OUTPUT" - name: generate data id: generate_data diff --git a/ibis-backends.yml b/ibis-backends.yml index d25ba75..4a0aaa8 100644 --- a/ibis-backends.yml +++ b/ibis-backends.yml @@ -82,18 +82,37 @@ jobs: - os: windows-latest backend: name: mysql + title: MySQL + services: + - mysql - os: windows-latest backend: name: clickhouse + title: ClickHouse + services: + - clickhouse - os: windows-latest backend: name: pyspark + title: PySpark - os: windows-latest backend: name: postgres + title: PostgreSQL + services: + - postgres + sys-deps: + - libgeos-dev - os: windows-latest backend: name: impala + title: Impala + services: + - impala + - kudu + sys-deps: + - cmake + - ninja-build steps: - name: update and install system dependencies if: ${{ matrix.os == 'ubuntu-latest' && matrix.backend.sys-deps != null }} @@ -210,9 +229,25 @@ jobs: - os: windows-latest backend: name: postgres + title: PostgreSQL + deps: + - "[email protected]" + - "[email protected]" + - "[email protected]" + - "[email protected]" + services: + - postgres - python-version: "3.10" backend: name: postgres + title: PostgreSQL + deps: + - "[email protected]" + - "[email protected]" + - "[email protected]" + - "[email protected]" + services: + - postgres steps: - name: checkout uses: actions/checkout@v3 diff --git a/update-deps.yml b/update-deps.yml index 0ae6f4e..e1b785b 100644 --- a/update-deps.yml +++ b/update-deps.yml @@ -19,7 +19,7 @@ jobs: set -euo pipefail deps="$(jq -rcM '{dep: keys}' < nix/sources.json)" - echo "::set-output name=matrix::$deps" + echo "matrix=${deps}" >> "$GITHUB_OUTPUT" niv_update: runs-on: ubuntu-latest @@ -58,7 +58,7 @@ jobs: run: \| set -euo pipefail - echo "::set-output name=did_change::${{ steps.get_current_commit.outputs.rev != steps.get_new_commit.outputs.rev }}" + echo "did_change=${{ steps.get_current_commit.outputs.rev != steps.get_new_commit.outputs.rev }}" >> "$GITHUB_OUTPUT" - uses: tibdex/github-app-token@v1 if: ${{ fromJSON(steps.needs_pr.outputs.did_change) }}
build: update version (nightly.4)	53a43962e82d70854e21d50f1ec228c7f47e21c4	build	https://github.com/erg-lang/erg/commit/53a43962e82d70854e21d50f1ec228c7f47e21c4	update version (nightly.4)	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 5ab4a2f..e0b43c9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -97,7 +97,7 @@ dependencies = [ [[package]] name = "els" -version = "0.1.33-nightly.3" +version = "0.1.33-nightly.4" dependencies = [ "erg_common", "erg_compiler", @@ -110,7 +110,7 @@ dependencies = [ [[package]] name = "erg" -version = "0.6.21-nightly.3" +version = "0.6.21-nightly.4" dependencies = [ "els", "erg_common", @@ -120,7 +120,7 @@ dependencies = [ [[package]] name = "erg_common" -version = "0.6.21-nightly.3" +version = "0.6.21-nightly.4" dependencies = [ "backtrace-on-stack-overflow", "crossterm", @@ -130,7 +130,7 @@ dependencies = [ [[package]] name = "erg_compiler" -version = "0.6.21-nightly.3" +version = "0.6.21-nightly.4" dependencies = [ "erg_common", "erg_parser", @@ -138,7 +138,7 @@ dependencies = [ [[package]] name = "erg_parser" -version = "0.6.21-nightly.3" +version = "0.6.21-nightly.4" dependencies = [ "erg_common", "unicode-xid", @@ -146,7 +146,7 @@ dependencies = [ [[package]] name = "erg_proc_macros" -version = "0.6.21-nightly.3" +version = "0.6.21-nightly.4" dependencies = [ "erg_common", "quote", diff --git a/Cargo.toml b/Cargo.toml index 0bcc4dd..ac543b9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "els" description = "An Erg compiler frontend for IDEs, implements LSP." documentation = "http://docs.rs/els" -version = "0.1.33-nightly.3" +version = "0.1.33-nightly.4" authors.workspace = true license.workspace = true edition.workspace = true diff --git a/cargo_publish.bat b/cargo_publish.bat index 03bc4da..548b513 100644 --- a/cargo_publish.bat +++ b/cargo_publish.bat @@ -5,8 +5,8 @@ if %~dp0 == C:%homepath%\\GitHub\\erg\\ ( echo publish erg_common ... cargo publish rem from cargo 1.66 timeout is not needed - echo publish erg_proc_macro ... - cd ../erg_proc_macro + echo publish erg_proc_macros ... + cd ../erg_proc_macros cargo publish cd ../erg_parser echo publish erg_parser ... diff --git a/cargo_publish.sh b/cargo_publish.sh index a2b9975..fc3e504 100644 --- a/cargo_publish.sh +++ b/cargo_publish.sh @@ -1,6 +1,6 @@ cd crates/erg_common cargo publish -cd ../erg_proc_macro +cd ../erg_proc_macros cargo publish cd ../erg_parser cargo publish
fix(snowflake): convert arrays, maps and structs using the base class implementation	f361891dfd00bf8aa144423e1976d0f346af778b	fix	https://github.com/ibis-project/ibis/commit/f361891dfd00bf8aa144423e1976d0f346af778b	convert arrays, maps and structs using the base class implementation	[email protected]	diff --git a/converter.py b/converter.py index 5e571aa..b39d019 100644 --- a/converter.py +++ b/converter.py @@ -14,13 +14,6 @@ if TYPE_CHECKING: class SnowflakePandasData(PandasData): - @classmethod - def convert_JSON(cls, s, dtype, pandas_type): - converter = cls.convert_JSON_element(dtype) - return s.map(converter, na_action="ignore").astype("object") - - convert_Struct = convert_Map = convert_JSON - @classmethod def convert_Timestamp_element(cls, dtype): return datetime.datetime.fromisoformat @@ -33,11 +26,25 @@ class SnowflakePandasData(PandasData): def convert_Time_element(cls, dtype): return datetime.time.fromisoformat + @classmethod + def convert_JSON(cls, s, dtype, pandas_type): + converter = cls.convert_JSON_element(dtype) + return s.map(converter, na_action="ignore").astype("object") + @classmethod def convert_Array(cls, s, dtype, pandas_type): raw_json_objects = cls.convert_JSON(s, dtype, pandas_type) - converter = cls.get_element_converter(dtype.value_type) - return raw_json_objects.map(converter, na_action="ignore") + return super().convert_Array(raw_json_objects, dtype, pandas_type) + + @classmethod + def convert_Map(cls, s, dtype, pandas_type): + raw_json_objects = cls.convert_JSON(s, dtype, pandas_type) + return super().convert_Map(raw_json_objects, dtype, pandas_type) + + @classmethod + def convert_Struct(cls, s, dtype, pandas_type): + raw_json_objects = cls.convert_JSON(s, dtype, pandas_type) + return super().convert_Struct(raw_json_objects, dtype, pandas_type) class SnowflakePyArrowData(PyArrowData):
perf(core): cache if entity has event listeners	cfa8d52fa0c3e783ae7842ef7932cc1f73663942	perf	https://github.com/mikro-orm/mikro-orm/commit/cfa8d52fa0c3e783ae7842ef7932cc1f73663942	cache if entity has event listeners	[email protected]	diff --git a/enums.ts b/enums.ts index 4280177..f8450c1 100644 --- a/enums.ts +++ b/enums.ts @@ -165,6 +165,11 @@ export enum EventType { afterTransactionRollback = 'afterTransactionRollback', } +export const EventTypeMap = Object.keys(EventType).reduce((a, b, i) => { + a[b as EventType] = i; + return a; +}, {} as Record<EventType, number>); + export type TransactionEventType = EventType.beforeTransactionStart \| EventType.afterTransactionStart \| EventType.beforeTransactionCommit \| EventType.afterTransactionCommit \| EventType.beforeTransactionRollback \| EventType.afterTransactionRollback; export interface TransactionOptions { diff --git a/EventManager.ts b/EventManager.ts index 7160022..6ca499b 100644 --- a/EventManager.ts +++ b/EventManager.ts @@ -1,12 +1,13 @@ import type { AnyEntity, AsyncFunction, EntityMetadata } from '../typings'; import type { EventArgs, EventSubscriber, FlushEventArgs, TransactionEventArgs } from './EventSubscriber'; import { Utils } from '../utils'; -import { EventType, type TransactionEventType } from '../enums'; +import { EventType, EventTypeMap, type TransactionEventType } from '../enums'; export class EventManager { private readonly listeners: { [K in EventType]?: EventSubscriber[] } = {}; private readonly entities: Map<EventSubscriber, string[]> = new Map(); + private readonly cache: Map<number, boolean> = new Map(); private readonly subscribers: EventSubscriber[] = []; constructor(subscribers: EventSubscriber[]) { @@ -16,6 +17,7 @@ export class EventManager { registerSubscriber(subscriber: EventSubscriber): void { this.subscribers.push(subscriber); this.entities.set(subscriber, this.getSubscribedEntities(subscriber)); + this.cache.clear(); Utils.keys(EventType) .filter(event => event in subscriber) .forEach(event => { @@ -55,9 +57,16 @@ export class EventManager { } hasListeners<T>(event: EventType, meta: EntityMetadata<T>): boolean { + const cacheKey = meta._id + EventTypeMap[event]; + + if (this.cache.has(cacheKey)) { + return this.cache.get(cacheKey)!; + } + const hasHooks = meta.hooks[event]?.length; if (hasHooks) { + this.cache.set(cacheKey, true); return true; } @@ -65,10 +74,12 @@ export class EventManager { const entities = this.entities.get(listener)!; if (entities.length === 0 \|\| entities.includes(meta.className)) { + this.cache.set(cacheKey, true); return true; } } + this.cache.set(cacheKey, false); return false; } diff --git a/typings.ts b/typings.ts index 78aa965..3dc78e0 100644 --- a/typings.ts +++ b/typings.ts @@ -341,6 +341,8 @@ export interface EntityProperty<T = any> { export class EntityMetadata<T = any> { + private static counter = 0; + readonly _id = 1000 * EntityMetadata.counter++; // keep the id >= 1000 to allow computing cache keys by simple addition readonly propertyOrder = new Map<string, number>(); constructor(meta: Partial<EntityMetadata> = {}) { @@ -571,6 +573,8 @@ export interface EntityMetadata<T = any> { polymorphs?: EntityMetadata[]; root: EntityMetadata<T>; definedProperties: Dictionary; + /** @internal can be used for computed numeric cache keys */ + readonly _id: number; } export interface ISchemaGenerator {
chore: set default params display threshold	1cd166283713fe27ff6c142e8e666470ed46a313	chore	https://github.com/erg-lang/erg/commit/1cd166283713fe27ff6c142e8e666470ed46a313	set default params display threshold	[email protected]	diff --git a/mod.rs b/mod.rs index 0a82a23..d887edb 100644 --- a/mod.rs +++ b/mod.rs @@ -47,6 +47,7 @@ use self::constructors::subr_t; pub const STR_OMIT_THRESHOLD: usize = 16; pub const CONTAINER_OMIT_THRESHOLD: usize = 8; +pub const DEFAULT_PARAMS_THRESHOLD: usize = 5; /// cloneのコストがあるためなるべく.ref_tを使うようにすること /// いくつかの構造体は直接Typeを保持していないので、その場合は.tを使う @@ -315,6 +316,10 @@ impl LimitedDisplay for SubrType { var_params.typ().limited_fmt(f, limit - 1)?; } for (i, pt) in self.default_params.iter().enumerate() { + if limit.is_positive() && i >= DEFAULT_PARAMS_THRESHOLD { + write!(f, ", ...")?; + break; + } if i > 0 \|\| !self.non_default_params.is_empty() \|\| self.var_params.is_some() { write!(f, ", ")?; }
fix(pandas): fix integer wraparound when extracting epoch seconds	e98fa3caa9a6325bdc647324f6a9e18e5fab43ca	fix	https://github.com/ibis-project/ibis/commit/e98fa3caa9a6325bdc647324f6a9e18e5fab43ca	fix integer wraparound when extracting epoch seconds	[email protected]	diff --git a/temporal.py b/temporal.py index bc0dbe2..6772f39 100644 --- a/temporal.py +++ b/temporal.py @@ -65,9 +65,19 @@ def execute_extract_microsecond_series(op, data, kwargs): return data.dt.microsecond.astype(np.int32) -@execute_node.register(ops.ExtractEpochSeconds, (datetime.datetime, pd.Series)) -def execute_epoch_seconds(op, data, kwargs): - return data.astype("datetime64[s]").astype("int64").astype("int32") +@execute_node.register(ops.ExtractEpochSeconds, pd.Series) +def execute_epoch_seconds_series(op, data, kwargs): + return ( + data.astype("datetime64[ns]") + .astype("int64") + .floordiv(1_000_000_000) + .astype("int32") + ) + + +@execute_node.register(ops.ExtractEpochSeconds, (pd.Timestamp, datetime.datetime)) +def execute_epoch_seconds_literal(op, data, kwargs): + return pd.Timestamp(data).floor("s").value // 1_000_000_000 @execute_node.register( diff --git a/test_temporal.py b/test_temporal.py index 9db90e5..deaff96 100644 --- a/test_temporal.py +++ b/test_temporal.py @@ -354,7 +354,11 @@ def test_timestamp_extract_epoch_seconds(backend, alltypes, df): result = expr.execute() expected = backend.default_series_rename( - df.timestamp_col.astype("datetime64[s]").astype("int64").astype("int32") + df.timestamp_col.astype("datetime64[ns]") + .dt.floor("s") + .astype("int64") + .floordiv(1_000_000_000) + .astype("int32") ) backend.assert_series_equal(result, expected)
chore: update lerna to v6	6db7093d2ca914f12116175e5a1f23090b5173a2	chore	https://github.com/Hardeepex/crawlee/commit/6db7093d2ca914f12116175e5a1f23090b5173a2	update lerna to v6	[email protected]	diff --git a/lerna.json b/lerna.json index cb760c8..33105af 100644 --- a/lerna.json +++ b/lerna.json @@ -11,6 +11,7 @@ } }, "useWorkspaces": true, + "useNx": false, "ignoreChanges": [ "/test/", "*/.md"
refactor(postgres): fail at execute time for UDFs to avoid db connections in `.compile()`	e3a4d4d2fbe6ca0016cf54bebf45114c8b093cf0	refactor	https://github.com/rohankumardubey/ibis/commit/e3a4d4d2fbe6ca0016cf54bebf45114c8b093cf0	fail at execute time for UDFs to avoid db connections in `.compile()`	[email protected]	diff --git a/test_udf.py b/test_udf.py index 6bb52bc..afce084 100644 --- a/test_udf.py +++ b/test_udf.py @@ -180,4 +180,4 @@ def test_client_udf_decorator_fails(con_for_udf, test_schema): return a * b with pytest.raises(exc.InvalidDecoratorError, match="@udf"): - con_for_udf.compile(multiply(1, 2)) + con_for_udf.execute(multiply(1, 2))
feat(core): automatically fix wrongly assigned associations (#62) When you use `Object.assign(entity, { ... })` instead of `entity.assign({ ... })` you could put your entity into invalid state where there will be PK instead of entity reference. With this change all managed entities will be validated before flushing and this case will be automatically handled, converting the PK to entity when persisting it. This is especially handy when you migrate existing project where you used `Object.assign(entity, { ... })` to update entities (like in TypeORM) as this kind of error could be hard to find because they were failing silently.	05e6ce561a53992ee1a079172f05b6d08838a49c	feat	https://github.com/mikro-orm/mikro-orm/commit/05e6ce561a53992ee1a079172f05b6d08838a49c	automatically fix wrongly assigned associations (#62) When you use `Object.assign(entity, { ... })` instead of `entity.assign({ ... })` you could put your entity into invalid state where there will be PK instead of entity reference. With this change all managed entities will be validated before flushing and this case will be automatically handled, converting the PK to entity when persisting it. This is especially handy when you migrate existing project where you used `Object.assign(entity, { ... })` to update entities (like in TypeORM) as this kind of error could be hard to find because they were failing silently.	[email protected]	diff --git a/IDatabaseDriver.ts b/IDatabaseDriver.ts index 6311c50..8f26f5d 100644 --- a/IDatabaseDriver.ts +++ b/IDatabaseDriver.ts @@ -1,6 +1,6 @@ import { EntityData, EntityMetadata, EntityProperty, IEntity, IEntityType, IPrimaryKey } from '../decorators'; import { Connection, QueryResult } from '../connections'; -import { QueryOrder } from '../query'; +import { QueryOrderMap } from '../query'; import { Platform } from '../platforms'; import { LockMode } from '../unit-of-work'; diff --git a/ArrayCollection.ts b/ArrayCollection.ts index 6c67c44..f9216b5 100644 --- a/ArrayCollection.ts +++ b/ArrayCollection.ts @@ -1,4 +1,4 @@ -import { EntityProperty, IEntity, IEntityType, IPrimaryKey } from '../decorators'; +import { EntityProperty, IEntityType, IPrimaryKey } from '../decorators'; import { MetadataStorage } from '../metadata'; export class ArrayCollection<T extends IEntityType<T>> { @@ -76,9 +76,9 @@ export class ArrayCollection<T extends IEntityType<T>> { contains(item: T): boolean { return !!this.items.find(i => { const objectIdentity = i === item; - const primaryKeyIdentity = i.__primaryKey && item.__primaryKey && i.__serializedPrimaryKey === item.__serializedPrimaryKey; + const primaryKeyIdentity = !!i.__primaryKey && !!item.__primaryKey && i.__serializedPrimaryKey === item.__serializedPrimaryKey; - return !!(objectIdentity \|\| primaryKeyIdentity); + return objectIdentity \|\| primaryKeyIdentity; }); } diff --git a/Collection.ts b/Collection.ts index d6fea8c..173c8d0 100644 --- a/Collection.ts +++ b/Collection.ts @@ -1,4 +1,4 @@ -import { FilterQuery, QueryOrder, QueryOrderMap } from '..'; +import { FilterQuery, QueryOrder, QueryOrderMap, Utils } from '..'; import { IEntityType } from '../decorators'; import { ArrayCollection } from './ArrayCollection'; import { ReferenceType } from './enums'; @@ -32,7 +32,7 @@ export class Collection<T extends IEntityType<T>> extends ArrayCollection<T> { this.initialized = true; } - super.set(items); + super.set(items.map(item => Utils.isEntity(item) ? item : this.owner.__em.getReference(this.property.type, item))); this.dirty = !initialize; for (const item of items) { diff --git a/UnitOfWork.ts b/UnitOfWork.ts index 696a541..8f2087c 100644 --- a/UnitOfWork.ts +++ b/UnitOfWork.ts @@ -183,7 +183,7 @@ export class UnitOfWork { } for (const prop of Object.values(meta.properties)) { - const reference = entity[prop.name as keyof T]; + const reference = entity[prop.name]; this.processReference(entity, prop, reference, visited); } @@ -211,7 +211,7 @@ export class UnitOfWork { private processToOneReference<T extends IEntityType<T>>(parent: T, prop: EntityProperty<T>, reference: any, visited: IEntity[]): void { if (!this.hasIdentifier(reference) && visited.includes(reference)) { this.extraUpdates.push([parent, prop.name as keyof IEntity, reference]); - delete parent[prop.name as keyof T]; + delete parent[prop.name]; } if (!this.originalEntityData[reference.__uuid]) { @@ -308,16 +308,18 @@ export class UnitOfWork { } } - private cascadeReference<T extends IEntityType<T>>(entity: T, prop: EntityProperty, type: Cascade, visited: IEntity[]): void { + private cascadeReference<T extends IEntityType<T>>(entity: T, prop: EntityProperty<T>, type: Cascade, visited: IEntity[]): void { + this.fixMissingReference(entity, prop); + if (!this.shouldCascade(prop, type)) { return; } - if ((prop.reference === ReferenceType.MANY_TO_ONE \|\| prop.reference === ReferenceType.ONE_TO_ONE) && entity[prop.name as keyof T]) { - return this.cascade(entity[prop.name as keyof T], type, visited); + if ((prop.reference === ReferenceType.MANY_TO_ONE \|\| prop.reference === ReferenceType.ONE_TO_ONE) && entity[prop.name]) { + return this.cascade(entity[prop.name], type, visited); } - const collection = entity[prop.name as keyof T] as Collection<IEntity>; + const collection = entity[prop.name] as Collection<IEntity>; const requireFullyInitialized = type === Cascade.PERSIST; // only cascade persist needs fully initialized items if ([ReferenceType.ONE_TO_MANY, ReferenceType.MANY_TO_MANY].includes(prop.reference) && collection.isInitialized(requireFullyInitialized)) { @@ -365,5 +367,21 @@ export class UnitOfWork { } } + private fixMissingReference<T extends IEntityType<T>>(entity: T, prop: EntityProperty<T>): void { + const reference = entity[prop.name] as IEntity \| Collection<IEntity> \| IPrimaryKey \| (IEntity \| IPrimaryKey)[]; + + if ([ReferenceType.MANY_TO_ONE, ReferenceType.ONE_TO_ONE].includes(prop.reference) && reference && !Utils.isEntity(reference)) { + entity[prop.name] = this.em.getReference(prop.type, reference as IPrimaryKey); + } + + const isCollection = [ReferenceType.ONE_TO_MANY, ReferenceType.MANY_TO_MANY].includes(prop.reference); + + if (isCollection && Array.isArray(reference)) { + entity[prop.name] = new Collection<IEntity>(entity) as T[keyof T]; + (entity[prop.name] as Collection<IEntity>).set(reference as IEntity[]); + (entity[prop.name] as Collection<IEntity>).setDirty(); + } + } + } diff --git a/EntityManager.mongo.test.ts b/EntityManager.mongo.test.ts index f9a99e8..4ed2f55 100644 --- a/EntityManager.mongo.test.ts +++ b/EntityManager.mongo.test.ts @@ -1260,6 +1260,55 @@ describe('EntityManagerMongo', () => { expect(a.born).toBeUndefined(); }); + test('automatically fix PK instead of entity when flushing (m:1)', async () => { + const author = new Author('Jon Snow', '[email protected]'); + Object.assign(author, { favouriteBook: '0000007b5c9c61c332380f78' }); + expect(author.favouriteBook).not.toBeInstanceOf(Book); + expect(author.favouriteBook).toBe('0000007b5c9c61c332380f78'); + await orm.em.persist(author); + expect(author.favouriteBook).toBeInstanceOf(Book); + expect(author.favouriteBook.id).toBe('0000007b5c9c61c332380f78'); + }); + + test('automatically fix array of PKs instead of collection when flushing (m:n)', async () => { + const mock = jest.fn(); + const logger = new Logger(mock, true); + Object.assign(orm.em.getConnection(), { logger }); + + const author = new Author('Jon Snow', '[email protected]'); + const book = new Book('B123', author); + await orm.em.persistAndFlush(book); + + const tag = orm.em.getReference(BookTag, '0000007b5c9c61c332380f79') + Object.assign(book, { tags: ['0000007b5c9c61c332380f78', tag] }); + expect(book.tags).not.toBeInstanceOf(Collection); + expect(book.tags).toEqual(['0000007b5c9c61c332380f78', tag]); + await orm.em.persistLater(book); + expect(book.tags).toBeInstanceOf(Collection); + expect(book.tags[0]).toBeInstanceOf(BookTag); + expect(book.tags[1]).toBeInstanceOf(BookTag); + expect(book.tags[0].id).toBe('0000007b5c9c61c332380f78'); + expect(book.tags[1].id).toBe('0000007b5c9c61c332380f79'); + expect(book.tags.isInitialized()).toBe(true); + expect(book.tags.isDirty()).toBe(true); + + await orm.em.flush(); + expect(mock.mock.calls[0][0]).toMatch(/db\\.getCollection\$"author"\$\\.insertOne\${"createdAt":".","updatedAt":".","termsAccepted":false,"name":"Jon Snow","email":"snow@wall\\.st","foo":"bar","_id":"."}\$;/); + expect(mock.mock.calls[1][0]).toMatch(/db\\.getCollection\$"books-table"\$\\.insertOne\${"title":"B123","author":".","_id":"."}\$;/); + expect(mock.mock.calls[2][0]).toMatch(/db\\.getCollection\$"books-table"\$\\.updateMany\${"_id":"."}, {"\\$set":{"tags":\\["0000007b5c9c61c332380f78","0000007b5c9c61c332380f79"]}}\$;/); + }); + + test('automatically fix PK in collection instead of entity when flushing (m:n)', async () => { + const author = new Author('Jon Snow', '[email protected]'); + const book = new Book('B123', author); + book.tags.set(['0000007b5c9c61c332380f78' as any]); + expect(book.tags).not.toBeInstanceOf(BookTag); + expect(book.tags[0]).toBeInstanceOf(BookTag); + expect(book.tags[0].id).toBe('0000007b5c9c61c332380f78'); + expect(book.tags.isInitialized()).toBe(true); + expect(book.tags.isDirty()).toBe(true); + }); + afterAll(async () => orm.close(true)); });
fix: use batchedUpdates in the FrameLoop This prevents React from rendering while the animation queue is being processed, as well as batching any React-managed state changes made in response to animation events. This also fixes a nasty bug where new animations were lost when added while the animation queue was being processed. This edge case is no longer possible.	86bf6c4a4450f971e54103e62741bb326b22bfb0	fix	https://github.com/pmndrs/react-spring/commit/86bf6c4a4450f971e54103e62741bb326b22bfb0	use batchedUpdates in the FrameLoop This prevents React from rendering while the animation queue is being processed, as well as batching any React-managed state changes made in response to animation events. This also fixes a nasty bug where new animations were lost when added while the animation queue was being processed. This edge case is no longer possible.	[email protected]	diff --git a/FrameLoop.ts b/FrameLoop.ts index e707991..ff93263 100644 --- a/FrameLoop.ts +++ b/FrameLoop.ts @@ -102,34 +102,36 @@ export class FrameLoop { startQueue.clear() } - // Animations can be added while the frameloop is updating, - // but they need a higher priority to be started on this frame. - if (animations.length) { - animations = animations.filter(animation => { - priority = animation.priority - - // Animations may go idle before the next frame. - if (!animation.idle) { - animation.advance(dt) - } - - // Remove idle animations. - return !animation.idle - }) - priority = 0 - } - - if (frameQueue.size) { - frameQueue.forEach(onFrame => onFrame(time)) - frameQueue.clear() - } - - if (writeQueue.size) { - writing = true - writeQueue.forEach(write => write(time)) - writeQueue.clear() - writing = false - } + G.batchedUpdates(() => { + // Animations can be added while the frameloop is updating, + // but they need a higher priority to be started on this frame. + if (animations.length) { + animations = animations.filter(animation => { + priority = animation.priority + + // Animations may go idle before the next frame. + if (!animation.idle) { + animation.advance(dt) + } + + // Remove idle animations. + return !animation.idle + }) + priority = 0 + } + + if (frameQueue.size) { + frameQueue.forEach(onFrame => onFrame(time)) + frameQueue.clear() + } + + if (writeQueue.size) { + writing = true + writeQueue.forEach(write => write(time)) + writeQueue.clear() + writing = false + } + }) if (!animations.length) { idle = true
test(join): account for older sqlite installs	5682afb105f7a496e9700b53a762d089dde28ea7	test	https://github.com/rohankumardubey/ibis/commit/5682afb105f7a496e9700b53a762d089dde28ea7	account for older sqlite installs	[email protected]	diff --git a/test_join.py b/test_join.py index 8146a2c..f75e156 100644 --- a/test_join.py +++ b/test_join.py @@ -343,7 +343,9 @@ def test_join_with_trivial_predicate(awards_players, predicate, how, pandas_valu raises=sa.exc.ProgrammingError, reason="mysql doesn't support full outer joins", ) - ], + ] + + [pytest.mark.notyet(["sqlite"])] + * (vparse(sqlite3.sqlite_version) < vparse("3.39")), ), ], )
feat: `file::Transaction::rollback()` allows to explicitly roll back a pending change. (#595) As opposed to dropping the Transaction, this method allows to obtain all edits that would have been applied.	e86e159e00c9b54803abbfa09809707be7ac8aee	feat	https://github.com/Byron/gitoxide/commit/e86e159e00c9b54803abbfa09809707be7ac8aee	`file::Transaction::rollback()` allows to explicitly roll back a pending change. (#595) As opposed to dropping the Transaction, this method allows to obtain all edits that would have been applied.	[email protected]	diff --git a/prepare.rs b/prepare.rs index f52edba..f521546 100644 --- a/prepare.rs +++ b/prepare.rs @@ -357,6 +357,20 @@ impl<'s, 'p> Transaction<'s, 'p> { self.updates = Some(updates); Ok(self) } + + /// Rollback all intermediate state and return the `RefEdits` as we know them thus far. + /// + /// Note that they have been altered compared to what was initially provided as they have + /// been split and know about their current state on disk. + /// + /// # Note + /// + /// A rollback happens automatically as this instance is dropped as well. + pub fn rollback(self) -> Vec<RefEdit> { + self.updates + .map(\|updates\| updates.into_iter().map(\|u\| u.update).collect()) + .unwrap_or_default() + } } fn possibly_adjust_name_for_prefixes(name: &FullNameRef) -> Option<FullName> { diff --git a/create_or_update.rs b/create_or_update.rs index a9afd0a..228615b 100644 --- a/create_or_update.rs +++ b/create_or_update.rs @@ -68,6 +68,45 @@ fn reference_with_equally_named_empty_or_non_empty_directory_already_in_place_ca Ok(()) } +#[test] +fn intermediate_directories_are_removed_on_rollback() -> crate::Result { + for explicit_rollback in [false, true] { + let (dir, store) = empty_store()?; + + let create_at = \|name: &str\| RefEdit { + change: Change::Update { + log: LogChange::default(), + expected: PreviousValue::MustNotExist, + new: Target::Peeled(git_hash::Kind::Sha1.null()), + }, + name: name.try_into().expect("valid"), + deref: false, + }; + + let transaction = store.transaction().prepare( + [create_at("refs/heads/a/b/ref"), create_at("refs/heads/a/c/ref")], + Fail::Immediately, + Fail::Immediately, + )?; + + assert!( + dir.path().join("refs/heads/a/b").exists(), + "lock files have been created in their place to avoid concurrent modification" + ); + assert!(dir.path().join("refs/heads/a/c").exists()); + + if explicit_rollback { + transaction.rollback(); + } else { + drop(transaction); + } + + assert!(!dir.path().join("refs/heads").exists()); + assert!(!dir.path().join("refs").exists(), "we go all in right now and also remove the refs directory. 'git' might not do that, but it's not a problem either"); + } + Ok(()) +} + #[test] fn reference_with_old_value_must_exist_when_creating_it() -> crate::Result { let (_keep, store) = empty_store()?;
feat: add `codecs/warnings` module	cdabb2e546a00f1fdea0c036134e1d84edd98c2f	feat	https://github.com/erg-lang/erg/commit/cdabb2e546a00f1fdea0c036134e1d84edd98c2f	add `codecs/warnings` module	[email protected]	diff --git a/codecs.d.er b/codecs.d.er index e62d577..d791c90 100644 --- a/codecs.d.er +++ b/codecs.d.er @@ -0,0 +1,84 @@ +.BOM: Bytes +.BOM_BE: Bytes +.BOM_LE: Bytes +.BOM_UTF8: Bytes +.BOM_UTF16: Bytes +.BOM_UTF16_BE: Bytes +.BOM_UTF16_LE: Bytes +.BOM_UTF32: Bytes +.BOM_UTF32_BE: Bytes +.BOM_UTF32_LE: Bytes + +.EncodedFile: ClassType + +.StreamReader!: ClassType +.StreamReader!. + read!: (self: RefMut StreamReader!, size := Int, chars := Int, firstline := Bool) => Bytes + readline!: (self: RefMut StreamReader!, size := Int, keepends := Bool) => Bytes + readlines!: (self: RefMut StreamReader!, sizehint := Int, keepends := Bool) => List Bytes + reset!: (self: RefMut StreamReader!) => NoneType + __iter__: (self: Ref StreamReader!) => Iterator Bytes + +.StreamWriter!: ClassType +.StreamWriter!. + write!: (self: RefMut StreamWriter!, obj: Bytes) => Int + writelines!: (self: RefMut StreamWriter!, obj: List Bytes) => NoneType + reset!: (self: RefMut StreamWriter!) => NoneType + +.StreamReaderWriter!: ClassType +.StreamReaderWriter!. + read!: (self: RefMut StreamReaderWriter!, size := Int, chars := Int, firstline := Bool) => Bytes + readline!: (self: RefMut StreamReaderWriter!, size := Int, keepends := Bool) => Bytes + readlines!: (self: RefMut StreamReaderWriter!, sizehint := Int, keepends := Bool) => List Bytes + write!: (self: RefMut StreamReaderWriter!, obj: Bytes) => Int + writelines!: (self: RefMut StreamReaderWriter!, obj: List Bytes) => NoneType + reset!: (self: RefMut StreamReaderWriter!) => NoneType + __iter__: (self: Ref StreamReaderWriter!) => Iterator Bytes + +.Codec: ClassType +.Codec. + name: Str + encode: (obj: Str, errors := Str) -> Bytes + decode: (obj: Bytes, errors := Str) -> Str + +.CodecInfo: ClassType +.CodecInfo. + name: Str + encode: (obj: Str, encoding := Str, errors := Str) -> Bytes + decode: (obj: Bytes, encoding := Str, errors:= Str) -> Str + streamreader: (obj: Bytes, errors: Str) -> StreamReader! + streamwriter: (obj: Bytes, errors: Str) -> StreamWriter! + __call__: ( + encode: (obj: Str, encoding := Str, errors := Str) -> Bytes, + decode: (obj: Bytes, encoding := Str, errors := Str) -> Str, + streamreader := StreamReader!, + streamwriter := StreamWriter!, + incrementalencoder := IncrementalEncoder, + incrementaldecoder := IncrementalDecoder, + name := Str, + ) -> CodecInfo + +.IncrementalEncoder: ClassType +.IncrementalEncoder. + encode: (obj: Str, final := Bool) -> Bytes + +.IncrementalDecoder: ClassType +.IncrementalDecoder. + decode: (obj: Bytes, final := Bool) -> Str + +.BufferedIncrementalEncoder: ClassType +.BufferedIncrementalEncoder <: IncrementalEncoder + +.BufferedIncrementalDecoder: ClassType +.BufferedIncrementalDecoder <: IncrementalDecoder + +.encode: (obj: Str, encoding := Str, errors := Str) -> Bytes +.decode: (obj: Bytes, encoding := Str, errors := Str) -> Str +.lookup: (encoding: Str) -> CodecInfo + +.getencoder: (encoding: Str) -> (obj: Str) -> (Bytes, Nat) +.getdecoder: (encoding: Str) -> (obj: Bytes) -> (Str, Nat) + +.open!: (filename: Str, mode := Str, encoding := Str, errors := Str, buffering := Int) -> StreamReaderWriter! +.register!: (search_function: (name: Str) -> CodecInfo or NoneType) => NoneType +.unregister!: (search_function: (name: Str) -> CodecInfo or NoneType) => NoneType diff --git a/ssl.d.er b/ssl.d.er index 0cb4834..95cd4cc 100644 --- a/ssl.d.er +++ b/ssl.d.er @@ -1,7 +1,31 @@ +.OPENSSL_VERSION: Str +.OPENSSL_VERSION_INFO: (Nat, Nat, Nat) + .SSLContext: ClassType .create_default_context!: () => .SSLContext .SSLError: ClassType +.SSLError <: OSError + +.SSLZeroReturnError: ClassType +.SSLZeroReturnError <: SSLError + +.SSLWantReadError: ClassType +.SSLWantReadError <: SSLError + +.SSLWantWriteError: ClassType +.SSLWantWriteError <: SSLError + +.SSLSyscallError: ClassType +.SSLSyscallError <: SSLError + +.SSLEOFError: ClassType +.SSLEOFError <: SSLError + +.SSLCertVerificationError: ClassType +.SSLCertVerificationError <: SSLError + +.CertificateError = .SSLCertVerificationError .SSLSocket: ClassType .SSLSocket <: FileLike! diff --git a/warnings.d.er b/warnings.d.er index ab77f70..9cb6ea1 100644 --- a/warnings.d.er +++ b/warnings.d.er @@ -0,0 +1,52 @@ +.CatchWarnings = 'catch_warnings': ClassType +.CatchWarnings. + __call__: () => CatchWarnings +.catch_warnings!: () => CatchWarnings + +.warn!: ( + message: Str, + category := Exception, + stacklevel := Nat, + source := Obj, + skip_file_prefixes := Iterable(Str), +) => NoneType +.warn_explicit!: ( + message: Str, + category: Exception, + filename: Str, + lineno: Nat, + module := Str, + registry := GenericDict, + module_globals := GenericDict, + source := Obj, +) => NoneType +.showwarning!: ( + message: Str, + category: Exception, + filename: Str, + lineno: Nat, + file := FileLike!, + line := Str, +) => NoneType +.formatwarning!: ( + message: Str, + category: Exception, + filename: Str, + lineno: Nat, + line := Str, +) => Str +.filterwarnings!: ( + action: Str, + message := Str, + category := Exception, + module := Str, + lineno := Nat, + append := Bool, +) => NoneType +.simplefilter!: ( + action: Str, + category := Exception, + lineno := Nat, + append := Bool, +) => NoneType +.resetwarnings!: () => NoneType
feat(duckdb): implement `ArrayFilter` translation	5f35d5c5529aa80c75ae2236bd985caf77fcaa77	feat	https://github.com/rohankumardubey/ibis/commit/5f35d5c5529aa80c75ae2236bd985caf77fcaa77	implement `ArrayFilter` translation	[email protected]	diff --git a/registry.py b/registry.py index 8146cfe..8e87057 100644 --- a/registry.py +++ b/registry.py @@ -15,6 +15,7 @@ from ibis.backends.base.sql.alchemy import unary from ibis.backends.base.sql.alchemy.datatypes import StructType from ibis.backends.base.sql.alchemy.registry import ( _table_column, + array_filter, array_map, geospatial_functions, reduction, @@ -240,6 +241,20 @@ def _array_map(t, op): ) +@compiles(array_filter, "duckdb") +def compiles_list_filter(element, compiler, *kw): + args, signature, result = map(partial(compiler.process, **kw), element.clauses) + return f"list_filter({', '.join(args)}, {signature} -> {result})" + + +def _array_filter(t, op): + return array_filter( + t.translate(op.arg), + sa.literal_column(f"({op.parameter})"), + t.translate(op.result), + ) + + operation_registry.update( { ops.ArrayColumn: ( @@ -326,6 +341,7 @@ operation_registry.update( ops.StartsWith: fixed_arity(sa.func.prefix, 2), ops.EndsWith: fixed_arity(sa.func.suffix, 2), ops.ArrayMap: _array_map, + ops.ArrayFilter: _array_filter, ops.Argument: lambda _, op: sa.literal_column(op.name), } )
fix: show submodules in status independently of their active state. Even inactive submodules are shown in the status by `git status`, so `gix` should do the same. First observed in https://github.com/helix-editor/helix/pull/5645#issuecomment-2016798212	719ced8a7949ba1f30fef13801e3466a7d1da590	fix	https://github.com/Byron/gitoxide/commit/719ced8a7949ba1f30fef13801e3466a7d1da590	show submodules in status independently of their active state. Even inactive submodules are shown in the status by `git status`, so `gix` should do the same. First observed in https://github.com/helix-editor/helix/pull/5645#issuecomment-2016798212	[email protected]	diff --git a/index_worktree.rs b/index_worktree.rs index b134eaf..72a71c4 100644 --- a/index_worktree.rs +++ b/index_worktree.rs @@ -199,10 +199,7 @@ mod submodule_status { let local_repo = repo.to_thread_local(); let submodule_paths = match local_repo.submodules()? { Some(sm) => { - let mut v: Vec<_> = sm - .filter(\|sm\| sm.is_active().unwrap_or_default()) - .filter_map(\|sm\| sm.path().ok().map(Cow::into_owned)) - .collect(); + let mut v: Vec<_> = sm.filter_map(\|sm\| sm.path().ok().map(Cow::into_owned)).collect(); v.sort(); v } @@ -271,7 +268,8 @@ mod submodule_status { /// /// ### Submodules /// -/// Note that submodules can be set to 'inactive' which automatically excludes them from the status operation. +/// Note that submodules can be set to 'inactive', which will not exclude them from the status operation, similar to +/// how `git status` includes them. /// /// ### Index Changes ///
ci: reduce the amount of downloaded package noise in ci	36313bde8ff755cad2303b411a6fd9fdca3e4d6d	ci	https://github.com/rohankumardubey/ibis/commit/36313bde8ff755cad2303b411a6fd9fdca3e4d6d	reduce the amount of downloaded package noise in ci	[email protected]	diff --git a/ibis-docs-lint.yml b/ibis-docs-lint.yml index 3f8ab77..9062330 100644 --- a/ibis-docs-lint.yml +++ b/ibis-docs-lint.yml @@ -29,7 +29,7 @@ jobs: nix_path: nixpkgs=channel:nixos-unstable-small - name: lint commits - run: nix shell -L --keep-going -f '<nixpkgs>' commitlint -c commitlint --from=${{ github.event.pull_request.base.sha }} --to=${{ github.sha }} --verbose + run: nix shell -f '<nixpkgs>' commitlint -c commitlint --from=${{ github.event.pull_request.base.sha }} --to=${{ github.sha }} --verbose lint: runs-on: ubuntu-latest @@ -50,7 +50,7 @@ jobs: extraPullNames: nix-community,poetry2nix - name: pre-commit checks - run: nix-shell --pure --keep-going --run 'pre-commit run --all-files' + run: nix develop -f shell.nix --ignore-environment --keep-going -c pre-commit run -a docs: name: Docs @@ -75,11 +75,11 @@ jobs: - name: build docs working-directory: ibis - run: nix-shell --pure --run 'make -C docs html BUILDDIR=web/docs' + run: nix develop -f shell.nix --ignore-environment --keep-going -c make -C docs html BUILDDIR=web/docs - name: build website working-directory: ibis - run: nix-shell --pure --run 'mkdocs build -f docs/mkdocs.yml' + run: nix develop -f shell.nix --ignore-environment --keep-going -c mkdocs build -f docs/mkdocs.yml - name: Add config to docs working-directory: ibis @@ -138,18 +138,10 @@ jobs: git add . git commit -am 'docs: ibis-project/ibis@${{ github.sha }}' \|\| true - - name: tag docs if this is a release - if: ${{ startsWith(github.ref, 'refs/tags') }} - working-directory: ibis-project.org - run: \| - set -euo pipefail - - git tag "${GITHUB_REF##*/}" - - name: Push docs if: ${{ github.event_name == 'push' }} working-directory: ibis-project.org - run: git push --tags -f origin master + run: git push -f origin master simulate_release: runs-on: ubuntu-latest
feat: `File::write()` for secure and complete writing of index files.	eedcffa728c7e895da51d5298db28f3fef05f7da	feat	https://github.com/Byron/gitoxide/commit/eedcffa728c7e895da51d5298db28f3fef05f7da	`File::write()` for secure and complete writing of index files.	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 8d72c24..f60eeb7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1399,6 +1399,7 @@ dependencies = [ "git-bitmap", "git-features", "git-hash", + "git-lock", "git-object", "git-repository", "git-testtools", diff --git a/Cargo.toml b/Cargo.toml index 37f5828..a950cb7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -35,6 +35,7 @@ git-hash = { version = "^0.9.11", path = "../git-hash" } git-bitmap = { version = "^0.1.2", path = "../git-bitmap" } git-object = { version = "^0.22.0", path = "../git-object" } git-traverse = { version = "^0.18.0", path = "../git-traverse" } +git-lock = { version = "2.1.1", path = "../git-lock" } thiserror = "1.0.32" memmap2 = "0.5.0" diff --git a/write.rs b/write.rs index a61ad19..9617fe8 100644 --- a/write.rs +++ b/write.rs @@ -30,7 +30,7 @@ fn roundtrips() -> crate::Result { let expected_bytes = std::fs::read(&path)?; let mut out_bytes = Vec::new(); - let actual_version = expected.write_to(&mut out_bytes, options)?; + let (actual_version, _digest) = expected.write_to(&mut out_bytes, options)?; assert_eq!( actual_version, expected.version(), @@ -94,7 +94,7 @@ fn state_comparisons_with_various_extension_configurations() { let expected = git_index::File::at(&path, Default::default()).unwrap(); let mut out = Vec::<u8>::new(); - let actual_version = expected.write_to(&mut out, options).unwrap(); + let (actual_version, _digest) = expected.write_to(&mut out, options).unwrap(); let (actual, _) = State::from_bytes(&out, FileTime::now(), decode::Options::default()).unwrap(); compare_states(&actual, actual_version, &expected, options, fixture); @@ -109,7 +109,7 @@ fn extended_flags_automatically_upgrade_the_version_to_avoid_data_loss() -> crat expected.entries_mut()[0].flags.insert(entry::Flags::EXTENDED); let mut buf = Vec::new(); - let actual_version = expected.write_to(&mut buf, Default::default())?; + let (actual_version, _digest) = expected.write_to(&mut buf, Default::default())?; assert_eq!(actual_version, Version::V3, "extended flags need V3"); Ok(()) diff --git a/init.rs b/init.rs index 326ffca..3ec8465 100644 --- a/init.rs +++ b/init.rs @@ -1,6 +1,5 @@ mod from_state { #[test] - #[ignore] fn writes_data_to_disk_and_is_a_valid_index() -> git_testtools::Result { let fixtures = [ "v2.sh", @@ -11,13 +10,13 @@ mod from_state { ]; for fixture in fixtures { + let tmp = git_testtools::tempfile::TempDir::new()?; + let index_path = tmp.path().join(fixture); + let fixture = format!("make_index/{}", fixture); let repo_dir = git_testtools::scripted_fixture_repo_read_only(&fixture)?; let index = git_index::File::at(repo_dir.join(".git").join("index"), Default::default())?; - let tmp = git_testtools::tempfile::TempDir::new()?; - - let index_path = tmp.path().join(fixture); assert!(!index_path.exists()); let mut index = git_index::File::from_state(index.state, index_path.clone()); assert!(index.checksum.is_null()); @@ -29,6 +28,12 @@ mod from_state { })?; assert!(!index.checksum.is_null(), "checksum is adjusted after writing"); assert!(index.path.is_file()); + // TODO: make it easier to test on loose indices. + assert_eq!( + index.state.version(), + git_index::Version::V2, + "V2 is enough as we don't have extended attributes" + ); index.verify_integrity()?; }
feat(clickhouse): support ms/us/ns truncate units	9881edb0c84a919c1d76ae8af745406f76cc6bea	feat	https://github.com/ibis-project/ibis/commit/9881edb0c84a919c1d76ae8af745406f76cc6bea	support ms/us/ns truncate units	[email protected]	diff --git a/out.sql b/out.sql index 200d5cb..ee57a16 100644 --- a/out.sql +++ b/out.sql @@ -1,2 +1,2 @@ SELECT - toDate(parseDateTimeBestEffort('2009-05-17T12:34:56')) AS "TimestampTruncate(datetime.datetime(2009, 5, 17, 12, 34, 56), DAY)" \\ No newline at end of file + toStartOfDay(parseDateTimeBestEffort('2009-05-17T12:34:56')) AS "TimestampTruncate(datetime.datetime(2009, 5, 17, 12, 34, 56), DAY)" \\ No newline at end of file diff --git a/clickhouse.py b/clickhouse.py index bfca862..151d0f1 100644 --- a/clickhouse.py +++ b/clickhouse.py @@ -372,24 +372,23 @@ class ClickHouseCompiler(SQLGlotCompiler): return self.f.toDateTime(arg) def visit_TimestampTruncate(self, op, , arg, unit): - converters = { - "Y": "toStartOfYear", - "Q": "toStartOfQuarter", - "M": "toStartOfMonth", - "W": "toMonday", - "D": "toDate", - "h": "toStartOfHour", - "m": "toStartOfMinute", - "s": "toDateTime", - } + if (short := unit.short) == "W": + func = "toMonday" + else: + func = f"toStartOf{unit.singular.capitalize()}" - unit = unit.short - if (converter := converters.get(unit)) is None: - raise com.UnsupportedOperationError(f"Unsupported truncate unit {unit}") + if short in ("s", "ms", "us", "ns"): + arg = self.f.toDateTime64(arg, op.arg.dtype.scale or 0) + return self.f[func](arg) - return self.f[converter](arg) + visit_TimeTruncate = visit_TimestampTruncate - visit_TimeTruncate = visit_DateTruncate = visit_TimestampTruncate + def visit_DateTruncate(self, op, , arg, unit): + if unit.short == "W": + func = "toMonday" + else: + func = f"toStartOf{unit.singular.capitalize()}" + return self.f[func](arg) def visit_TimestampBucket(self, op, *, arg, interval, offset): if offset is not None: diff --git a/test_temporal.py b/test_temporal.py index 4865831..ee2a5e5 100644 --- a/test_temporal.py +++ b/test_temporal.py @@ -359,7 +359,7 @@ def test_timestamp_extract_week_of_year(backend, alltypes, df): "ms", marks=[ pytest.mark.notimpl( - ["clickhouse", "mysql", "sqlite", "datafusion", "exasol"], + ["mysql", "sqlite", "datafusion", "exasol"], raises=com.UnsupportedOperationError, ), pytest.mark.notimpl(["druid"], raises=PyDruidProgrammingError), @@ -370,7 +370,7 @@ def test_timestamp_extract_week_of_year(backend, alltypes, df): "us", marks=[ pytest.mark.notimpl( - ["clickhouse", "mysql", "sqlite", "trino", "datafusion", "exasol"], + ["mysql", "sqlite", "trino", "datafusion", "exasol"], raises=com.UnsupportedOperationError, ), pytest.mark.notyet( @@ -388,7 +388,6 @@ def test_timestamp_extract_week_of_year(backend, alltypes, df): pytest.mark.notimpl( [ "bigquery", - "clickhouse", "duckdb", "impala", "mysql",
fix: respect `crawler.log` when creating child logger for `Statistics` Closes #2412	0a0d75d40b5f78b329589535bbe3e0e84be76a7e	fix	https://github.com/Hardeepex/crawlee/commit/0a0d75d40b5f78b329589535bbe3e0e84be76a7e	respect `crawler.log` when creating child logger for `Statistics` Closes #2412	[email protected]	diff --git a/basic-crawler.ts b/basic-crawler.ts index 79f0a1f..a484981 100644 --- a/basic-crawler.ts +++ b/basic-crawler.ts @@ -667,6 +667,7 @@ export class BasicCrawler<Context extends CrawlingContext = BasicCrawlingContext this.handledRequestsCount = 0; this.stats = new Statistics({ logMessage: `${log.getOptions().prefix} request statistics:`, + log, config, ...statisticsOptions, }); diff --git a/statistics.ts b/statistics.ts index fa28870..f74e297 100644 --- a/statistics.ts +++ b/statistics.ts @@ -1,3 +1,4 @@ +import type { Log } from '@apify/log'; import ow from 'ow'; import { ErrorTracker } from './error_tracker'; @@ -99,7 +100,7 @@ export class Statistics { private logMessage: string; private listener: () => Promise<void>; private requestsInProgress = new Map<number \| string, Job>(); - private readonly log = defaultLog.child({ prefix: 'Statistics' }); + private readonly log: Log; private instanceStart!: number; private logInterval: unknown; private events: EventManager; @@ -114,6 +115,7 @@ export class Statistics { ow.object.exactShape({ logIntervalSecs: ow.optional.number, logMessage: ow.optional.string, + log: ow.optional.object, keyValueStore: ow.optional.object, config: ow.optional.object, persistenceOptions: ow.optional.object, @@ -132,6 +134,7 @@ export class Statistics { saveErrorSnapshots = false, } = options; + this.log = (options.log ?? defaultLog).child({ prefix: 'Statistics' }); this.errorTracker = new ErrorTracker({ ...errorTrackerConfig, saveErrorSnapshots }); this.errorTrackerRetry = new ErrorTracker({ ...errorTrackerConfig, saveErrorSnapshots }); this.logIntervalMillis = logIntervalSecs * 1000; @@ -440,6 +443,12 @@ export interface StatisticsOptions { / logMessage?: string; + /* + * Parent logger instance, the statistics will create a child logger from this. + * @default crawler.log + / + log?: Log; + /* * Key value store instance to persist the statistics. * If not provided, the default one will be used when capturing starts
fix(core): ensure other conditions do not override collection operator conditions	97cdc9db96a37630736cafb5f901b22a6f348f65	fix	https://github.com/mikro-orm/mikro-orm/commit/97cdc9db96a37630736cafb5f901b22a6f348f65	ensure other conditions do not override collection operator conditions	[email protected]	diff --git a/ObjectCriteriaNode.ts b/ObjectCriteriaNode.ts index 424641d..43e069c 100644 --- a/ObjectCriteriaNode.ts +++ b/ObjectCriteriaNode.ts @@ -96,14 +96,14 @@ export class ObjectCriteriaNode<T extends object> extends CriteriaNode<T> { const a = qb.helper.isTableNameAliasRequired(qb.type) ? alias : undefined; this.inlineChildPayload(o, payload, field as EntityKey, a, childAlias); } else if (childNode.shouldRename(payload)) { - o[childNode.renameFieldToPK(qb)] = payload; + this.inlineCondition(childNode.renameFieldToPK(qb), o, payload); } else if (isRawField) { const rawField = RawQueryFragment.getKnownFragment(field)!; o[raw(rawField.sql.replaceAll(ALIAS_REPLACEMENT, alias!), rawField.params)] = payload; } else if (primaryKey \|\| virtual \|\| operator \|\| field.includes('.') \|\| ![QueryType.SELECT, QueryType.COUNT].includes(qb.type ?? QueryType.SELECT)) { - o[field.replaceAll(ALIAS_REPLACEMENT, alias!)] = payload; + this.inlineCondition(field.replaceAll(ALIAS_REPLACEMENT, alias!), o, payload); } else { - o[`${alias}.${field}`] = payload; + this.inlineCondition(`${alias}.${field}`, o, payload); } return o; diff --git a/collection-operators.test.ts b/collection-operators.test.ts index b46be14..ff88424 100644 --- a/collection-operators.test.ts +++ b/collection-operators.test.ts @@ -132,9 +132,10 @@ test('1:m sub-query operators $some, $none and $every', async () => { results = await orm.em.fork().find(Author, { books: { $every: { title: 'Foo' } }, + id: [1, 2, 5], }); expect(results.map(res => res.name)).toEqual(['Author 1', 'Author 2', 'Author 5']); - expect(mock.mock.calls[2][0]).toBe("[query] select `a0`.* from `author` as `a0` where `a0`.`id` not in (select `a0`.`id` from `author` as `a0` inner join `book` as `b1` on `a0`.`id` = `b1`.`author_id` where not (`b1`.`title` = 'Foo'))"); + expect(mock.mock.calls[2][0]).toBe("[query] select `a0`.* from `author` as `a0` where `a0`.`id` not in (select `a0`.`id` from `author` as `a0` inner join `book` as `b1` on `a0`.`id` = `b1`.`author_id` where not (`b1`.`title` = 'Foo')) and `a0`.`id` in (1, 2, 5)"); results = await orm.em.fork().find(Author, { books: { $some: {} },
chore: remove nix job os matrix element	f3c49a9bba72ac598e42edd2ad7bd749971000f1	chore	https://github.com/rohankumardubey/ibis/commit/f3c49a9bba72ac598e42edd2ad7bd749971000f1	remove nix job os matrix element	[email protected]	diff --git a/ibis-main.yml b/ibis-main.yml index d171ae0..06e164c 100644 --- a/ibis-main.yml +++ b/ibis-main.yml @@ -43,12 +43,10 @@ jobs: - name: nix-linter run: nix shell -f ./nix nix-linter -c nix-linter $(find . -name '.nix' -and \$ -not -wholename 'nix/sources.nix' \$) nix: - runs-on: ${{ matrix.os }} + runs-on: ubuntu-latest strategy: fail-fast: false matrix: - os: - - ubuntu-latest python-version: - "3.7" - "3.8"
build(docs): downgrade TS to fix docs build 2	0d55cff5f5469b1f945c58572cfcd912cd18276f	build	https://github.com/mikro-orm/mikro-orm/commit/0d55cff5f5469b1f945c58572cfcd912cd18276f	downgrade TS to fix docs build 2	[email protected]	diff --git a/yarn.lock b/yarn.lock index 98ec749..be9bf87 100644 --- a/yarn.lock +++ b/yarn.lock Binary files a/docs/yarn.lock and b/docs/yarn.lock differ
docs: add `gatsby-remark-mathjax-ssr` to project	62039224da1a624b011eb4c98b892af6ff7409f2	docs	https://github.com/wzhiqing/cube/commit/62039224da1a624b011eb4c98b892af6ff7409f2	add `gatsby-remark-mathjax-ssr` to project	[email protected]	diff --git a/gatsby-config.js b/gatsby-config.js index 22e199a..8746536 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -81,6 +81,7 @@ const config = { wrapperStyle: 'margin-bottom: 24px' } }, + `gatsby-remark-mathjax-ssr`, { resolve: 'gatsby-remark-find-replace', options: { diff --git a/package.json b/package.json index 6286d9d..29e162c 100644 --- a/package.json +++ b/package.json @@ -70,6 +70,7 @@ "@types/react-scroll": "^1.8.2", "gatsby-plugin-percy": "^0.1.4", "gatsby-remark-find-replace": "^0.3.0", + "gatsby-remark-mathjax-ssr": "^1", "lint-staged": "^10.5.2", "markdownlint-cli2": "^0.0.11", "prettier": "^2.1.2", diff --git a/Head.tsx b/Head.tsx index e25fa22..29f1e8f 100644 --- a/Head.tsx +++ b/Head.tsx @@ -40,11 +40,11 @@ const Prod: React.FC<Props> = (props) => ( name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" /> + <script src={`${process.env.PATH_PREFIX}/scripts/prism.js`} /> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js" ></script> - <script src={`${process.env.PATH_PREFIX}/scripts/prism.js`} /> <link href={`${process.env.PATH_PREFIX}/styles/content.css`} rel="stylesheet" diff --git a/DocTemplate.tsx b/DocTemplate.tsx index 02d53c8..7640257 100644 --- a/DocTemplate.tsx +++ b/DocTemplate.tsx @@ -10,6 +10,8 @@ import get from 'lodash/get'; import last from 'lodash/last'; import { renameCategory } from '../rename-category'; +import "gatsby-remark-mathjax-ssr/mathjax.css"; + import ScrollLink, { SCROLL_OFFSET, } from '../components/templates/ScrollSpyLink'; diff --git a/yarn.lock b/yarn.lock index 639d7c3..3024070 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8455,6 +8455,15 @@ gatsby-remark-images@^3.0.10: unist-util-select "^1.5.0" unist-util-visit-parents "^2.1.2" +gatsby-remark-mathjax-ssr@^1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/gatsby-remark-mathjax-ssr/-/gatsby-remark-mathjax-ssr-1.2.1.tgz#775ef9a8d80eb0863af81c36667b256c8fab4b92" + integrity sha512-QKfaQqyl4EvJvi+dCIXyLY+OjqjKrMQwLZdbQ8tFRLt2KXchyDZS2FqFtUda1sfeRPiU3BkWKyhYFkVhOEHEuA== + dependencies: + mathjax-node "^2.1.1" + remark-math "^1.0.6" + unist-util-visit "^1.4.1" + gatsby-source-filesystem@^2.0.28: version "2.11.1" resolved "https://registry.yarnpkg.com/gatsby-source-filesystem/-/gatsby-source-filesystem-2.11.1.tgz#c90f49c096c4bdafd8e68462966b3a6e21fd746b" @@ -11382,7 +11391,7 @@ jsbn@~0.1.0: resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513" integrity sha1-peZUwuWi3rXyAdls77yoDA7y9RM= -jsdom@^11.5.1: +jsdom@^11.0.0, jsdom@^11.5.1: version "11.12.0" resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-11.12.0.tgz#1a80d40ddd378a1de59656e9e6dc5a3ba8657bc8" integrity sha512-y8Px43oyiBM13Zc1z780FrfNLJCXTL40EWlty/LXUtcjykRBNgLlCjWXpfSPBl2iv+N7koQN+dvqszHZgT/Fjw== @@ -12288,6 +12297,20 @@ math-random@^1.0.1: resolved "https://registry.yarnpkg.com/math-random/-/math-random-1.0.4.tgz#5dd6943c938548267016d4e34f057583080c514c" integrity sha512-rUxjysqif/BZQH2yhd5Aaq7vXMSx9NdEsQcyA07uEzIvxgI7zIr33gGsh+RU0/XjmQpCW7RsVof1vlkvQVCK5A== +mathjax-node@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/mathjax-node/-/mathjax-node-2.1.1.tgz#25c80f494f7540418ffcfa9cc756dfd2150201bd" + integrity sha1-JcgPSU91QEGP/Pqcx1bf0hUCAb0= + dependencies: + is-fullwidth-code-point "^2.0.0" + jsdom "^11.0.0" + mathjax "^2.7.2" + +mathjax@^2.7.2: + version "2.7.9" + resolved "https://registry.yarnpkg.com/mathjax/-/mathjax-2.7.9.tgz#d6b67955c173e7d719fcb2fc0288662884eb7d3d" + integrity sha512-NOGEDTIM9+MrsqnjPEjVGNx4q0GQxqm61yQwSK+/5S59i26wId5IC5gNu9/bu8+CCVl5p9G2IHcAl/wJa+5+BQ== + md5-file@^5.0.0: version "5.0.0" resolved "https://registry.yarnpkg.com/md5-file/-/md5-file-5.0.0.tgz#e519f631feca9c39e7f9ea1780b63c4745012e20" @@ -16570,6 +16593,13 @@ remark-frontmatter@^2.0.0: dependencies: fault "^1.0.1" +remark-math@^1.0.6: + version "1.0.6" + resolved "https://registry.yarnpkg.com/remark-math/-/remark-math-1.0.6.tgz#49eb3dd15d298734c9ae21673115389793af4d1b" + integrity sha512-I43wU/QOQpXvVFXKjA4FHp5xptK65+5F6yolm8+69/JV0EqSOB64wURUZ3JK50JtnTL8FvwLiH2PZ+fvsBxviA== + dependencies: + trim-trailing-lines "^1.1.0" + remark-mdx@^2.0.0-next.4, remark-mdx@^2.0.0-next.7: version "2.0.0-next.9" resolved "https://registry.yarnpkg.com/remark-mdx/-/remark-mdx-2.0.0-next.9.tgz#3e2088550ddd4264ce48bca15fb297569d369e65" @@ -19014,7 +19044,7 @@ trim-right@^1.0.1: resolved "https://registry.yarnpkg.com/trim-right/-/trim-right-1.0.1.tgz#cb2e1203067e0c8de1f614094b9fe45704ea6003" integrity sha1-yy4SAwZ+DI3h9hQJS5/kVwTqYAM= -trim-trailing-lines@^1.0.0: +trim-trailing-lines@^1.0.0, trim-trailing-lines@^1.1.0: version "1.1.4" resolved "https://registry.yarnpkg.com/trim-trailing-lines/-/trim-trailing-lines-1.1.4.tgz#bd4abbec7cc880462f10b2c8b5ce1d8d1ec7c2c0" integrity sha512-rjUWSqnfTNrjbB9NQWfPMH/xRK1deHeGsHoVfpxJ++XeYXE0d6B1En37AHfw3jtfTU7dzMzZL2jjpe8Qb5gLIQ==
feat(deps): support duckdb 0.5.0	47165b233b1b2764009bf39e30ca7b59b1266b70	feat	https://github.com/ibis-project/ibis/commit/47165b233b1b2764009bf39e30ca7b59b1266b70	support duckdb 0.5.0	[email protected]	diff --git a/registry.py b/registry.py index a3e3f55..cc73ac7 100644 --- a/registry.py +++ b/registry.py @@ -1,4 +1,5 @@ import collections +import numbers import operator import numpy as np @@ -86,6 +87,8 @@ def _literal(_, expr): return sa.cast(sa.func.list_value(value), sqla_type) elif isinstance(value, np.ndarray): return sa.cast(sa.func.list_value(value.tolist()), sqla_type) + elif isinstance(value, (numbers.Real, np.floating)) and np.isnan(value): + return sa.cast(sa.literal("NaN"), sqla_type) elif isinstance(value, collections.abc.Mapping): if isinstance(dtype, dt.Struct): placeholders = ", ".join( diff --git a/test_numeric.py b/test_numeric.py index e33cd4f..a502943 100644 --- a/test_numeric.py +++ b/test_numeric.py @@ -203,7 +203,7 @@ def test_trig_functions_literals(con, expr, expected): param(_.dc.atan(), np.arctan, id="atan"), param(_.dc.atan2(_.dc), lambda c: np.arctan2(c, c), id="atan2"), param(_.dc.cos(), np.cos, id="cos"), - param(_.dc.cot(), lambda c: np.cos(c) / np.sin(c), id="cot"), + param(_.dc.cot(), lambda c: 1.0 / np.tan(c), id="cot"), param(_.dc.sin(), np.sin, id="sin"), param(_.dc.tan(), np.tan, id="tan"), ], @@ -217,12 +217,10 @@ def test_trig_functions_literals(con, expr, expected): ) def test_trig_functions_columns(backend, expr, alltypes, df, expected_fn): dc_max = df.double_col.max() - result = ( - alltypes.mutate(dc=(_.double_col / dc_max).nullifzero()) - .select([expr.name("tmp")]) - .execute() - .tmp + expr = alltypes.mutate(dc=(_.double_col / dc_max).nullifzero()).select( + tmp=expr ) + result = expr.tmp.execute() expected = expected_fn( (df.double_col / dc_max).replace(0.0, np.nan) ).rename("tmp") diff --git a/poetry-overrides.nix b/poetry-overrides.nix index 6962984..ebbd47d 100644 --- a/poetry-overrides.nix +++ b/poetry-overrides.nix @@ -102,15 +102,6 @@ in ''; }); - duckdb = super.duckdb.overrideAttrs (_: rec { - inherit (pkgs.duckdb) version src patches; - format = "setuptools"; - preConfigure = '' - cd tools/pythonpkg - ''; - SETUPTOOLS_SCM_PRETEND_VERSION = version; - }); - hatch-fancy-pypi-readme = super.buildPythonPackage rec { pname = "hatch-fancy-pypi-readme"; version = "22.3.0";
fix: fixed typings in onDiv configuration, the DivType accepts also valid string values now	164da18be5f3feabbc7c367469446e3446cbb5f4	fix	https://github.com/tsparticles/tsparticles/commit/164da18be5f3feabbc7c367469446e3446cbb5f4	fixed typings in onDiv configuration, the DivType accepts also valid string values now	[email protected]	diff --git a/DivEvent.ts b/DivEvent.ts index a5db193..cd2db89 100644 --- a/DivEvent.ts +++ b/DivEvent.ts @@ -22,7 +22,7 @@ export class DivEvent implements IDivEvent, IOptionLoader<IDivEvent> { selectors: SingleOrMultiple<string>; - type; + type: DivType \| keyof typeof DivType; constructor() { this.selectors = [];
feat: added style options	12045cdfe3111e018258a7bc1c88974e28b6f31e	feat	https://github.com/tsparticles/tsparticles/commit/12045cdfe3111e018258a7bc1c88974e28b6f31e	added style options	[email protected]	diff --git a/Canvas.ts b/Canvas.ts index 899cd1c..3243206 100644 --- a/Canvas.ts +++ b/Canvas.ts @@ -431,6 +431,20 @@ export class Canvas { element.style.width = originalStyle.width; element.style.height = originalStyle.height; } + + for (const key in options.style) { + if (!key \|\| !options.style) { + continue; + } + + const value = options.style[key]; + + if (!value) { + continue; + } + + element.style[key] = value; + } } private paintBase(baseColor?: string): void { diff --git a/Options.ts b/Options.ts index 629a59c..14c2004 100644 --- a/Options.ts +++ b/Options.ts @@ -78,6 +78,7 @@ export class Options implements IOptions, IOptionLoader<IOptions> { pauseOnBlur; pauseOnOutsideViewport; preset?: string \| string[]; + style: RecursivePartial<CSSStyleDeclaration>; responsive: Responsive[]; themes: Theme[]; zLayers; @@ -101,6 +102,7 @@ export class Options implements IOptions, IOptionLoader<IOptions> { this.pauseOnBlur = true; this.pauseOnOutsideViewport = true; this.responsive = []; + this.style = {}; this.themes = []; this.zLayers = 100; } diff --git a/IOptions.ts b/IOptions.ts index e7e7cea..9bcdb0d 100644 --- a/IOptions.ts +++ b/IOptions.ts @@ -108,6 +108,8 @@ export interface IOptions { / retina_detect: boolean; + style: RecursivePartial<CSSStyleDeclaration>; + /* * User-defined themes that can be retrieved by the particles [[Container]] */
chore: add `annotations` future import to all non-test files	fdfd71b2d1dade414aac996d511f15757c32a5a7	chore	https://github.com/ibis-project/ibis/commit/fdfd71b2d1dade414aac996d511f15757c32a5a7	add `annotations` future import to all non-test files	[email protected]	diff --git a/make_geography_db.py b/make_geography_db.py index 47b3bfd..2c768e2 100644 --- a/make_geography_db.py +++ b/make_geography_db.py @@ -13,6 +13,8 @@ # # The source of the `independence` table has been obtained from # [Wikipedia](https://en.wikipedia.org/wiki/List_of_national_independence_days). +from __future__ import annotations + import argparse import datetime import tempfile diff --git a/example.py b/example.py index a3e7856..ab58f9e 100644 --- a/example.py +++ b/example.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ibis con = ibis.sqlite.connect("crunchbase.db") diff --git a/sqlalchemy_example.py b/sqlalchemy_example.py index c03c140..9f1ec9e 100644 --- a/sqlalchemy_example.py +++ b/sqlalchemy_example.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import sqlalchemy as sa c = sa.table("companies") diff --git a/gen_matrix.py b/gen_matrix.py index 6e83be0..ed71cd0 100644 --- a/gen_matrix.py +++ b/gen_matrix.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from pathlib import Path import pandas as pd diff --git a/geospatial.py b/geospatial.py index 2511c4a..331dac9 100644 --- a/geospatial.py +++ b/geospatial.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public from ibis.expr import datatypes as dt diff --git a/registry.py b/registry.py index c73a96c..07d2f70 100644 --- a/registry.py +++ b/registry.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import sqlalchemy as sa import ibis diff --git a/__init__.py b/__init__.py index f4fbc87..b1de38f 100644 --- a/__init__.py +++ b/__init__.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2015 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/base.py b/base.py index e1c76d1..d35ee1c 100644 --- a/base.py +++ b/base.py @@ -1,7 +1,9 @@ +from __future__ import annotations + import abc import inspect from pathlib import Path -from typing import Any, Callable, Mapping, Optional +from typing import Any, Callable, Mapping import numpy as np import pandas as pd @@ -169,13 +171,13 @@ class BackendTest(abc.ABC): return self.connection.table('awards_players') @property - def geo(self) -> Optional[ir.Table]: + def geo(self) -> ir.Table \| None: if 'geo' in self.connection.list_tables(): return self.connection.table('geo') return None @property - def struct(self) -> Optional[ir.Table]: + def struct(self) -> ir.Table \| None: if self.supports_structs: return self.connection.table("struct") else: @@ -183,7 +185,7 @@ class BackendTest(abc.ABC): return None @property - def json_t(self) -> Optional[ir.Table]: + def json_t(self) -> ir.Table \| None: from ibis import _ if self.supports_json: @@ -196,5 +198,5 @@ class BackendTest(abc.ABC): def api(self): return self.connection - def make_context(self, params: Optional[Mapping[ir.Value, Any]] = None): + def make_context(self, params: Mapping[ir.Value, Any] \| None = None): return self.api.compiler.make_context(params=params) diff --git a/ddl.py b/ddl.py index a70e60f..a1ab993 100644 --- a/ddl.py +++ b/ddl.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from ibis.backends.base.sql.ddl import ( CTAS, AlterTable, diff --git a/aggregate.py b/aggregate.py index 52a3774..436e4cf 100644 --- a/aggregate.py +++ b/aggregate.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import itertools import ibis diff --git a/case.py b/case.py index 5d7f2a8..c797788 100644 --- a/case.py +++ b/case.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from io import StringIO diff --git a/helpers.py b/helpers.py index 36b99a8..7b9d320 100644 --- a/helpers.py +++ b/helpers.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ibis.common.exceptions as com import ibis.expr.operations as ops from ibis.backends.base.sql.registry import identifiers diff --git a/identifiers.py b/identifiers.py index 505d85e..010be5b 100644 --- a/identifiers.py +++ b/identifiers.py @@ -1,3 +1,5 @@ +from __future__ import annotations + _identifiers = frozenset( { 'add', diff --git a/literal.py b/literal.py index 359ddcf..ce3efa4 100644 --- a/literal.py +++ b/literal.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import datetime import math diff --git a/main.py b/main.py index bacfd0c..cf1a6d0 100644 --- a/main.py +++ b/main.py @@ -1,3 +1,6 @@ +from __future__ import annotations + + def define_env(env): import ibis diff --git a/string.py b/string.py index f292324..7736fbe 100644 --- a/string.py +++ b/string.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ibis.expr.operations as ops from ibis.backends.base.sql.registry import helpers diff --git a/timestamp.py b/timestamp.py index 1ff521c..cbf67c3 100644 --- a/timestamp.py +++ b/timestamp.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ibis.common.exceptions as com import ibis.expr.datatypes as dt import ibis.expr.operations as ops diff --git a/compiler.py b/compiler.py index 547a7e8..b4dc262 100644 --- a/compiler.py +++ b/compiler.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2014 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -11,7 +13,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - import sqlalchemy as sa import ibis diff --git a/datatypes.py b/datatypes.py index 4582066..f392ef7 100644 --- a/datatypes.py +++ b/datatypes.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import functools import pyspark.sql.types as pt diff --git a/operations.py b/operations.py index a9a00f9..de461d5 100644 --- a/operations.py +++ b/operations.py @@ -1,5 +1,7 @@ """Ibis operations specific to BigQuery.""" +from __future__ import annotations + import ibis.expr.operations as ops diff --git a/rewrites.py b/rewrites.py index 4bd89fc..3f0eb43 100644 --- a/rewrites.py +++ b/rewrites.py @@ -1,5 +1,7 @@ """Methods to translate BigQuery expressions before compilation.""" +from __future__ import annotations + import toolz import ibis.expr.datatypes as dt diff --git a/conftest.py b/conftest.py index 70bbe9f..99f9b5c 100644 --- a/conftest.py +++ b/conftest.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import pytest import ibis diff --git a/core.py b/core.py index 52a9dda..94bcf88 100644 --- a/core.py +++ b/core.py @@ -39,6 +39,8 @@ Recurses top-down and translates the arguments of the value expression and uses those as input to construct the output. """ +from __future__ import annotations + from typing import Any, Mapping import sqlglot as sg diff --git a/find.py b/find.py index 10da506..0c06c55 100644 --- a/find.py +++ b/find.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ast import toolz diff --git a/rewrite.py b/rewrite.py index 8eec608..ee0ba69 100644 --- a/rewrite.py +++ b/rewrite.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ast from typing import Callable diff --git a/version.py b/version.py index 636e46a..b0b223c 100644 --- a/version.py +++ b/version.py @@ -1 +1,3 @@ +from __future__ import annotations + __version__ = "2.2.0" diff --git a/relations.py b/relations.py index 88b3f6f..066e1cd 100644 --- a/relations.py +++ b/relations.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import functools from functools import partial diff --git a/client.py b/client.py index 80fcac4..11c327d 100644 --- a/client.py +++ b/client.py @@ -1,5 +1,7 @@ """The pandas client implementation.""" +from __future__ import annotations + import json import numpy as np diff --git a/dispatch.py b/dispatch.py index ac79537..711e481 100644 --- a/dispatch.py +++ b/dispatch.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import abc import functools import re diff --git a/arrays.py b/arrays.py index 0455ac9..6c641d3 100644 --- a/arrays.py +++ b/arrays.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public import ibis.common.exceptions as com diff --git a/decimal.py b/decimal.py index 528fb28..ccf1690 100644 --- a/decimal.py +++ b/decimal.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import decimal import math import numbers diff --git a/indexing.py b/indexing.py index d977a10..85ea4ff 100644 --- a/indexing.py +++ b/indexing.py @@ -1,5 +1,7 @@ """Execution rules for ops.Where operations.""" +from __future__ import annotations + import dask.dataframe as dd import ibis.expr.operations as ops diff --git a/join.py b/join.py index ed70d11..97b377f 100644 --- a/join.py +++ b/join.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import pandas as pd import ibis.expr.analysis as an diff --git a/maps.py b/maps.py index e0f53a8..4e7396a 100644 --- a/maps.py +++ b/maps.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public import ibis.expr.datatypes as dt diff --git a/numeric.py b/numeric.py index 0852bd6..26b3c7f 100644 --- a/numeric.py +++ b/numeric.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import operator from public import public diff --git a/reductions.py b/reductions.py index 280c293..9acb589 100644 --- a/reductions.py +++ b/reductions.py @@ -10,6 +10,8 @@ dask specific types and pandas types. This cannot be done via the dispatcher since the top level container is a list. """ +from __future__ import annotations + import functools from collections.abc import Sized diff --git a/strings.py b/strings.py index f1dce37..e28db4f 100644 --- a/strings.py +++ b/strings.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public import ibis.expr.datatypes as dt diff --git a/structs.py b/structs.py index 9c8b5ca..5ecab76 100644 --- a/structs.py +++ b/structs.py @@ -1,5 +1,7 @@ """Pandas backend execution of struct fields and literals.""" +from __future__ import annotations + import collections import functools diff --git a/temporal.py b/temporal.py index bfb68b5..035ab9c 100644 --- a/temporal.py +++ b/temporal.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import operator import toolz diff --git a/trace.py b/trace.py index 94134a9..435dad6 100644 --- a/trace.py +++ b/trace.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import functools import logging import traceback diff --git a/udf.py b/udf.py index e25b2ba..65913d5 100644 --- a/udf.py +++ b/udf.py @@ -1,5 +1,6 @@ +from __future__ import annotations + import itertools -from typing import List, Tuple import dask.dataframe as dd import dask.dataframe.groupby as ddgb @@ -18,7 +19,7 @@ from ibis.backends.dask.execution.util import ( ) -def make_struct_op_meta(op: ir.Expr) -> List[Tuple[str, np.dtype]]: +def make_struct_op_meta(op: ir.Expr) -> list[tuple[str, np.dtype]]: """Unpacks a dt.Struct into a DataFrame meta.""" return list( zip( diff --git a/compat.py b/compat.py index 17499d6..48720cc 100644 --- a/compat.py +++ b/compat.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2015 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -11,7 +13,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - import impala.dbapi as impyla from impala.error import Error as ImpylaError from impala.error import HiveServer2Error as HS2Error diff --git a/metadata.py b/metadata.py index 606affa..1cd40d7 100644 --- a/metadata.py +++ b/metadata.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2014 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -11,7 +13,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - from io import StringIO diff --git a/pandas_interop.py b/pandas_interop.py index 2b91c62..e7b3ee3 100644 --- a/pandas_interop.py +++ b/pandas_interop.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2014 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -11,7 +13,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - import contextlib import csv import os diff --git a/parquet.py b/parquet.py index 9677308..465633b 100644 --- a/parquet.py +++ b/parquet.py @@ -1,3 +1,5 @@ +from __future__ import annotations + # Copyright 2014 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/mocks.py b/mocks.py index 6b56b17..af29d2c 100644 --- a/mocks.py +++ b/mocks.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from ibis.backends.impala.compiler import ImpalaCompiler from ibis.tests.expr.mocks import MockBackend diff --git a/aggcontext.py b/aggcontext.py index 39fb30c..bd600d7 100644 --- a/aggcontext.py +++ b/aggcontext.py @@ -214,11 +214,13 @@ Ibis >>> t.value.sum().over(window) # doctest: +SKIP """ +from __future__ import annotations + import abc import functools import itertools import operator -from typing import Any, Callable, Dict, Iterator, Optional, Tuple, Union +from typing import Any, Callable, Iterator import numpy as np import pandas as pd @@ -263,8 +265,8 @@ class AggregationContext(abc.ABC): def wrap_for_apply( function: Callable, - args: Optional[Tuple[Any, ...]] = None, - kwargs: Optional[Dict[str, Any]] = None, + args: tuple[Any, ...] \| None = None, + kwargs: dict[str, Any] \| None = None, ) -> Callable: """Wrap a function for use with Pandas `apply`. @@ -279,11 +281,11 @@ def wrap_for_apply( """ assert callable(function), f'function {function} is not callable' - new_args: Tuple[Any, ...] = () + new_args: tuple[Any, ...] = () if args is not None: new_args = args - new_kwargs: Dict[str, Any] = {} + new_kwargs: dict[str, Any] = {} if kwargs is not None: new_kwargs = kwargs @@ -291,8 +293,8 @@ def wrap_for_apply( def wrapped_func( data: Any, function: Callable = function, - args: Tuple[Any, ...] = new_args, - kwargs: Dict[str, Any] = new_kwargs, + args: tuple[Any, ...] = new_args, + kwargs: dict[str, Any] = new_kwargs, ) -> Callable: return function(data, args, kwargs) @@ -301,8 +303,8 @@ def wrap_for_apply( def wrap_for_agg( function: Callable, - args: Tuple[Any, ...], - kwargs: Dict[str, Any], + args: tuple[Any, ...], + kwargs: dict[str, Any], ) -> Callable: """Wrap a function for use with Pandas `agg`. @@ -337,8 +339,8 @@ def wrap_for_agg( def wrapped_func( data: Any, function: Callable = function, - args: Tuple[Any, ...] = args, - kwargs: Dict[str, Any] = kwargs, + args: tuple[Any, ...] = args, + kwargs: dict[str, Any] = kwargs, ) -> Callable: # `data` will be a scalar here if Pandas `agg` is trying to behave like # like Pandas `apply`. @@ -434,8 +436,8 @@ def window_agg_built_in( windowed: pd.core.window.Window, function: str, max_lookback: int, - args: Tuple[Any], - *kwargs: Dict[str, Any], + args: tuple[Any], + *kwargs: dict[str, Any], ) -> pd.Series: """Apply window aggregation with built-in aggregators.""" assert isinstance(function, str) @@ -459,7 +461,7 @@ def window_agg_built_in( def create_window_input_iter( - grouped_data: Union[SeriesGroupBy, pd.Series], + grouped_data: SeriesGroupBy \| pd.Series, masked_window_lower_indices: pd.Series, masked_window_upper_indices: pd.Series, ) -> Iterator[np.ndarray]: @@ -484,8 +486,8 @@ def window_agg_udf( result_index: pd.Index, dtype: np.dtype, max_lookback: int, - args: Tuple[Any], - *kwargs: Dict[str, Any], + args: tuple[Any], + *kwargs: dict[str, Any], ) -> pd.Series: """Apply window aggregation with UDFs. @@ -557,8 +559,8 @@ class Window(AggregationContext): def agg( self, - grouped_data: Union[pd.Series, SeriesGroupBy], - function: Union[str, Callable], + grouped_data: pd.Series \| SeriesGroupBy, + function: str \| Callable, args: Any, *kwargs: Any, ) -> pd.Series: diff --git a/dispatcher.py b/dispatcher.py index b8a46bd..e16a3d5 100644 --- a/dispatcher.py +++ b/dispatcher.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from multipledispatch import Dispatcher diff --git a/constants.py b/constants.py index fc81c45..751eef0 100644 --- a/constants.py +++ b/constants.py @@ -1,7 +1,8 @@ """Constants for the pandas backend.""" +from __future__ import annotations + import operator -from typing import Dict, Type, Union import numpy as np import pandas as pd @@ -27,7 +28,7 @@ ALTERNATE_SUFFIXES = { } -IBIS_TYPE_TO_PANDAS_TYPE: Dict[dt.DataType, Union[Type, str]] = { +IBIS_TYPE_TO_PANDAS_TYPE: dict[dt.DataType, type \| str] = { dt.float16: np.float16, dt.float32: np.float32, dt.float64: np.float64, diff --git a/util.py b/util.py index 65229c4..d0fa71b 100644 --- a/util.py +++ b/util.py @@ -1,5 +1,7 @@ """Test utilities.""" +from __future__ import annotations + import pickle import ibis diff --git a/data.py b/data.py index 4303bc5..2cd7963 100644 --- a/data.py +++ b/data.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import numpy as np import pandas as pd diff --git a/exceptions.py b/exceptions.py index 1a00076..80c2fd0 100644 --- a/exceptions.py +++ b/exceptions.py @@ -1,4 +1,3 @@ -"""Module for exceptions.""" # Copyright 2014 Cloudera Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -12,6 +11,10 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +"""Module for exceptions.""" + +from __future__ import annotations + from typing import Callable diff --git a/parsing.py b/parsing.py index b061007..a2aeb2b 100644 --- a/parsing.py +++ b/parsing.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import ast import re diff --git a/typing.py b/typing.py index 1092844..19b0b32 100644 --- a/typing.py +++ b/typing.py @@ -1,5 +1,7 @@ """Define types for annotation.""" +from __future__ import annotations + from typing import TYPE_CHECKING, Tuple if TYPE_CHECKING: diff --git a/builders.py b/builders.py index bc3d7c1..5168d2f 100644 --- a/builders.py +++ b/builders.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from abc import abstractmethod import ibis.expr.operations as ops diff --git a/parse.py b/parse.py index 00c3862..f21f66a 100644 --- a/parse.py +++ b/parse.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import functools import parsy diff --git a/histograms.py b/histograms.py index e91ffcb..285ee4a 100644 --- a/histograms.py +++ b/histograms.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public from ibis.expr import datatypes as dt diff --git a/json.py b/json.py index 7054b85..ef48def 100644 --- a/json.py +++ b/json.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public import ibis.expr.datatypes as dt diff --git a/sortkeys.py b/sortkeys.py index 001262d..48cf82f 100644 --- a/sortkeys.py +++ b/sortkeys.py @@ -1,5 +1,7 @@ """Sort key operations.""" +from __future__ import annotations + from public import public import ibis.expr.rules as rlz diff --git a/vectorized.py b/vectorized.py index da9080e..273b0cc 100644 --- a/vectorized.py +++ b/vectorized.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from types import FunctionType, LambdaType from public import public diff --git a/rules.py b/rules.py index f51c3b7..72a4894 100644 --- a/rules.py +++ b/rules.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import builtins import enum import operator diff --git a/category.py b/category.py index 0923424..ed32d9a 100644 --- a/category.py +++ b/category.py @@ -1,4 +1,6 @@ -from typing import Optional, Sequence +from __future__ import annotations + +from typing import Sequence from public import public @@ -9,7 +11,7 @@ from ibis.expr.types.strings import StringValue @public class CategoryValue(Value): - def label(self, labels: Sequence[str], nulls: Optional[str] = None) -> StringValue: + def label(self, labels: Sequence[str], nulls: str \| None = None) -> StringValue: """Format a known number of categories as strings. Parameters diff --git a/collections.py b/collections.py index 5159c4b..e1fcfb2 100644 --- a/collections.py +++ b/collections.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public from ibis.expr.types.generic import Column, Scalar, Value diff --git a/inet.py b/inet.py index a87b7b4..10cc8a1 100644 --- a/inet.py +++ b/inet.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public from ibis.expr.types.strings import StringColumn, StringScalar, StringValue diff --git a/pretty.py b/pretty.py index 6de112c..1473f36 100644 --- a/pretty.py +++ b/pretty.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import datetime from functools import singledispatch from math import isfinite diff --git a/uuid.py b/uuid.py index 3b9ddf0..dfe0e08 100644 --- a/uuid.py +++ b/uuid.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from public import public from ibis.expr.types.strings import StringColumn, StringScalar, StringValue diff --git a/visualize.py b/visualize.py index d7a9da3..ae7de53 100644 --- a/visualize.py +++ b/visualize.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import sys import tempfile from html import escape diff --git a/strategies.py b/strategies.py index 6a68bef..1e55563 100644 --- a/strategies.py +++ b/strategies.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import hypothesis as h import hypothesis.extra.pandas as past import hypothesis.extra.pytz as tzst diff --git a/validate.py b/validate.py index a2bfcc0..264a4d1 100644 --- a/validate.py +++ b/validate.py @@ -5,8 +5,10 @@ Warning: This is an experimental module and API here can change without notice. DO NOT USE DIRECTLY. """ +from __future__ import annotations + from inspect import Parameter, Signature, signature -from typing import Any, Callable, List +from typing import Any, Callable import ibis.common.exceptions as com from ibis.expr.datatypes import DataType @@ -33,7 +35,7 @@ def _parameter_count(funcsig: Signature) -> int: ) -def validate_input_type(input_type: List[DataType], func: Callable) -> Signature: +def validate_input_type(input_type: list[DataType], func: Callable) -> Signature: """Check that the declared number of inputs and signature of func are compatible. If the signature of `func` uses args, then no check is done (since no
build: fixed some load functions that weren't async	5bd9935bac57793b0ab20ddfbe1a0a6177122896	build	https://github.com/tsparticles/tsparticles/commit/5bd9935bac57793b0ab20ddfbe1a0a6177122896	fixed some load functions that weren't async	[email protected]	diff --git a/index.ts b/index.ts index f88c7ca..68655e5 100644 --- a/index.ts +++ b/index.ts @@ -3,8 +3,8 @@ import { OrbitUpdater } from "./OrbitUpdater"; /** * - * @param engine + * @param engine - / -export function loadOrbitUpdater(engine: Engine): void { +export async function loadOrbitUpdater(engine: Engine): Promise<void> { engine.addParticleUpdater("orbit", (container) => new OrbitUpdater(container)); } diff --git a/NumberUtils.ts b/NumberUtils.ts index 1c47a66..363ae35 100644 --- a/NumberUtils.ts +++ b/NumberUtils.ts @@ -22,9 +22,11 @@ const easings = new Map<EasingType \| EasingTypeAlt, EasingFunction>(); @param easing - / export function addEasing(name: EasingType \| EasingTypeAlt, easing: EasingFunction): void { - if (!easings.get(name)) { - easings.set(name, easing); + if (easings.get(name)) { + return; } + + easings.set(name, easing); } /* diff --git a/README.md b/README.md index 80582e6..2eee7a0 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,13 @@ loadPolygonPath Once the scripts are loaded you can set up `tsParticles` and the path plugin like this: ```javascript -loadPolygonPath(tsParticles); +(async () => { + await loadPolygonPath(tsParticles); -tsParticles.load("tsparticles", { - /* options / -}); + await tsParticles.load("tsparticles", { + / options / + }); +})(); ``` ### ESM / CommonJS @@ -52,7 +54,9 @@ Then you need to import it in the app, like this: const { tsParticles } = require("tsparticles-engine"); const { loadPolygonPath } = require("tsparticles-path-polygon"); -loadPolygonPath(tsParticles); +(async () => { + await loadPolygonPath(tsParticles); +})(); ``` or @@ -61,5 +65,7 @@ or import { tsParticles } from "tsparticles-engine"; import { loadPolygonPath } from "tsparticles-path-polygon"; -loadPolygonPath(tsParticles); +(async () => { + await loadPolygonPath(tsParticles); +})(); ``` diff --git a/updater.ts b/updater.ts index 25c614a..6a1a375 100644 --- a/updater.ts +++ b/updater.ts @@ -41,8 +41,9 @@ type CustomRecord = { const objectDifference = (object: CustomRecord, base: CustomRecord): CustomRecord => { /* * - * @param object - * @param base + * @param object - + * @param base - + * @returns Options changes */ function changes(object: CustomRecord, base: CustomRecord): CustomRecord { return _.transform(object, function (result: CustomRecord, value: CustomRecord, key: string) {
feat(api): allow selectors in `order_by`	359fd5ebacaf1f56755c151351e4eb1502455499	feat	https://github.com/ibis-project/ibis/commit/359fd5ebacaf1f56755c151351e4eb1502455499	allow selectors in `order_by`	[email protected]	diff --git a/relations.py b/relations.py index 92338bb..d703219 100644 --- a/relations.py +++ b/relations.py @@ -1296,7 +1296,13 @@ class Table(Expr, _FixedTextJupyterMixin): def order_by( self, - by: str \| ir.Column \| Sequence[str] \| Sequence[ir.Column] \| None, + by: str + \| ir.Column + \| s.Selector + \| Sequence[str] + \| Sequence[ir.Column] + \| Sequence[s.Selector] + \| None, ) -> Table: """Sort a table by one or more expressions. @@ -1421,19 +1427,21 @@ class Table(Expr, _FixedTextJupyterMixin): │ 2 │ B │ 6 │ └───────┴────────┴───────┘ """ + import ibis.selectors as s + sort_keys = [] for item in util.promote_list(by): if isinstance(item, tuple): if len(item) != 2: - raise ValueError( - "Tuple must be of length 2, got {}".format(len(item)) - ) - item = (bind_expr(self, item[0]), item[1]) - used_tuple_syntax = True + raise ValueError(f"Tuple must be of length 2, got {len(item):d}") + sort_keys.append(bind_expr(self, item[0]), item[1]) + elif isinstance(item, s.Selector): + sort_keys.extend(item.expand(self)) else: - item = bind_expr(self, item) - sort_keys.append(item) + sort_keys.append(bind_expr(self, item)) + if not sort_keys: + raise com.IbisError("At least one sort key must be provided") return self.op().order_by(sort_keys).to_expr() def union(self, table: Table, *rest: Table, distinct: bool = False) -> Table: diff --git a/test_selectors.py b/test_selectors.py index 68e3240..fb1eaeb 100644 --- a/test_selectors.py +++ b/test_selectors.py @@ -475,3 +475,18 @@ def test_c_error_on_misspelled_column(penguins): sel = s.any_of(s.c("island", "inland")) with pytest.raises(exc.IbisInputError, match=match): penguins.select(sel) + + +def test_order_by_with_selectors(penguins): + expr = penguins.order_by(s.of_type("string")) + assert tuple(key.name for key in expr.op().sort_keys) == ( + "species", + "island", + "sex", + ) + + expr = penguins.order_by(s.all()) + assert tuple(key.name for key in expr.op().sort_keys) == tuple(expr.columns) + + with pytest.raises(exc.IbisError): + penguins.order_by(~s.all())
fix: #415	5eb680cb211337dc97f6ad6042bf5c3336a31a6a	fix	https://github.com/erg-lang/erg/commit/5eb680cb211337dc97f6ad6042bf5c3336a31a6a	#415	[email protected]	diff --git a/hir.rs b/hir.rs index c264176..52fb4c7 100644 --- a/hir.rs +++ b/hir.rs @@ -1377,6 +1377,9 @@ impl HasType for Call { if let Some(attr) = self.attr_name.as_mut() { Some(attr.ref_mut_t()) } else { + if let Expr::Call(call) = self.obj.as_ref() { + call.return_t()?; + } Some(self.obj.ref_mut_t()) } } @@ -1417,6 +1420,14 @@ impl Call { } }) } + + pub fn return_t(&self) -> Option<&Type> { + if let Some(attr) = self.attr_name.as_ref() { + attr.ref_t().return_t() + } else { + self.obj.ref_t().return_t() + } + } } #[derive(Debug, Clone, PartialEq, Eq, Hash)] diff --git a/lower.rs b/lower.rs index 0323b86..aa2ed13 100644 --- a/lower.rs +++ b/lower.rs @@ -1024,13 +1024,21 @@ impl ASTLowerer { .module .context .subtype_of(vi.t.return_t().unwrap(), &Type::Bool)); - vi.t.mut_return_t().unwrap() = guard; + if let Some(ret_t) = vi.t.mut_return_t() { + ret_t = guard; + } } let attr_name = if let Some(attr_name) = call.attr_name { self.inc_ref(&vi, &attr_name.name); Some(hir::Identifier::new(attr_name, None, vi)) } else { - obj.ref_mut_t() = vi.t; + if let hir::Expr::Call(call) = &obj { + if call.return_t().is_some() { + obj.ref_mut_t() = vi.t; + } + } else { + *obj.ref_mut_t() = vi.t; + } None }; let mut call = hir::Call::new(obj, attr_name, hir_args); diff --git a/mod.rs b/mod.rs index 3b3a2f3..dd8aef1 100644 --- a/mod.rs +++ b/mod.rs @@ -45,6 +45,7 @@ pub trait HasType { // 関数呼び出しの場合、.ref_t()は戻り値を返し、signature_t()は関数全体の型を返す fn signature_t(&self) -> Option<&Type>; // 最後にHIR全体の型変数を消すために使う + /// `x.ref_mut_t()` may panic, in which case `x` is `Call` and `x.ref_t() == Type::Failure`. fn ref_mut_t(&mut self) -> &mut Type; fn signature_mut_t(&mut self) -> Option<&mut Type>; #[inline] diff --git a/callable.er b/callable.er index ba25648..848c933 100644 --- a/callable.er +++ b/callable.er @@ -11,3 +11,5 @@ print! f3(1) 2 # ERR f4 x = (y) => x print! f4(1) 2 # OK + +_ = Array() [1, 2] # ERR diff --git a/test.rs b/test.rs index 67a90e9..3765713 100644 --- a/test.rs +++ b/test.rs @@ -309,7 +309,7 @@ fn exec_subtyping_err() -> Result<(), ()> { #[test] fn exec_callable() -> Result<(), ()> { - expect_failure("tests/should_err/callable.er", 0, 4) + expect_failure("tests/should_err/callable.er", 0, 5) } #[test]
fix: codegen bug	6787c9398f0df6ce72f99bc1271f941882af8a88	fix	https://github.com/erg-lang/erg/commit/6787c9398f0df6ce72f99bc1271f941882af8a88	codegen bug	[email protected]	diff --git a/codegen.rs b/codegen.rs index 44c14f5..15f1fa1 100644 --- a/codegen.rs +++ b/codegen.rs @@ -1394,10 +1394,10 @@ impl PyCodeGenerator { let argc = if self.py_version.minor >= Some(11) { 0 } else { + self.stack_dec(); 1 }; self.emit_call_instr(argc, Name); - self.stack_dec(); } // stack_dec: <code obj> + <name> -> <function> self.stack_dec();
ci(snowflake): check `matrix.backend.key` before `matrix.backend.name` `name` is never null, so checking it first leads to testing against the same schema, the prevention of which is the whole point of using name/key to specify the schema.	137179cb7c9a7d2fa9d0dda945da16963543b2e5	ci	https://github.com/rohankumardubey/ibis/commit/137179cb7c9a7d2fa9d0dda945da16963543b2e5	check `matrix.backend.key` before `matrix.backend.name` `name` is never null, so checking it first leads to testing against the same schema, the prevention of which is the whole point of using name/key to specify the schema.	[email protected]	diff --git a/ibis-backends-cloud.yml b/ibis-backends-cloud.yml index c8fed58..da47d11 100644 --- a/ibis-backends-cloud.yml +++ b/ibis-backends-cloud.yml @@ -99,7 +99,7 @@ jobs: echo "SNOWFLAKE_PASSWORD=${SNOWFLAKE_PASSWORD}" echo "SNOWFLAKE_ACCOUNT=${SNOWFLAKE_ACCOUNT}" echo "SNOWFLAKE_DATABASE=${SNOWFLAKE_DATABASE}" - echo "SNOWFLAKE_SCHEMA=${SNOWFLAKE_SCHEMA}" + echo "SNOWFLAKE_SCHEMA=${SNOWFLAKE_SCHEMA}_${{ matrix.backend.key \|\| matrix.backend.name }}" echo "SNOWFLAKE_WAREHOUSE=${SNOWFLAKE_WAREHOUSE}" } >> "$GITHUB_ENV" env: @@ -107,7 +107,7 @@ jobs: SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }} SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }} SNOWFLAKE_DATABASE: ${{ secrets.SNOWFLAKE_DATABASE }} - SNOWFLAKE_SCHEMA: ${{ secrets.SNOWFLAKE_SCHEMA }}_${{ matrix.backend.name \|\| matrix.backend.key }} + SNOWFLAKE_SCHEMA: ${{ secrets.SNOWFLAKE_SCHEMA }} SNOWFLAKE_WAREHOUSE: ${{ secrets.SNOWFLAKE_WAREHOUSE }} - name: "run parallel tests: ${{ matrix.backend.name }}; reset random seed"
feat: `Permission::is_allowed()` as convenience method (#450)	fe24b41bae244884f1f2cea43af11ab27976b9bc	feat	https://github.com/Byron/gitoxide/commit/fe24b41bae244884f1f2cea43af11ab27976b9bc	`Permission::is_allowed()` as convenience method (#450)	[email protected]	diff --git a/permission.rs b/permission.rs index d06ac1a..22be926 100644 --- a/permission.rs +++ b/permission.rs @@ -27,6 +27,10 @@ where impl<R> std::error::Error for Error<R> where R: std::fmt::Debug {} impl Permission { + /// Return true if this instance is `Permission::Allow`. + pub fn is_allowed(&self) -> bool { + matches!(self, Permission::Allow) + } /// Check this permissions and produce a reply to indicate if the `resource` can be used and in which way. /// /// Only if this permission is set to `Allow` will the resource be usable. diff --git a/sec.rs b/sec.rs index 6b05c24..7748a3e 100644 --- a/sec.rs +++ b/sec.rs @@ -25,6 +25,13 @@ mod permission { assert_eq!(Permission::Deny.check_opt("hi"), None); assert_eq!(Permission::Forbid.check_opt("hi"), None); } + + #[test] + fn is_allowed() { + assert!(Permission::Allow.is_allowed()); + assert!(!Permission::Deny.is_allowed()); + assert!(!Permission::Forbid.is_allowed()); + } } mod identity;
test(snowflake): ignore deprecation warning from old vendored requests	3902ea09031ae0ec6ef63d3e01664cb3f4b7fa88	test	https://github.com/rohankumardubey/ibis/commit/3902ea09031ae0ec6ef63d3e01664cb3f4b7fa88	ignore deprecation warning from old vendored requests	[email protected]	diff --git a/pyproject.toml b/pyproject.toml index 28f4fba..7a9f739 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -309,6 +309,8 @@ filterwarnings = [ # this has no effect on ibis's output because we convert types after # execution "ignore:Datatype BOOL does not support CAST on MySQL/MariaDB; the cast will be skipped:sqlalchemy.exc.SAWarning", + # snowflake vendors an older version requests + "ignore:'urllib3\\\\.contrib\\\\.pyopenssl' module is deprecated and will be removed in a future release of urllib3:DeprecationWarning", ] empty_parameter_set_mark = "fail_at_collect" markers = [
chore: clone index hint in `qb.clone()`	4d2ea6aee19fbd1d2765ccd38ca5c75b690a83a0	chore	https://github.com/mikro-orm/mikro-orm/commit/4d2ea6aee19fbd1d2765ccd38ca5c75b690a83a0	clone index hint in `qb.clone()`	[email protected]	diff --git a/QueryBuilder.ts b/QueryBuilder.ts index 871086e..b1d82d8 100644 --- a/QueryBuilder.ts +++ b/QueryBuilder.ts @@ -506,7 +506,7 @@ export class QueryBuilder<T extends AnyEntity<T> = AnyEntity> { Object.assign(qb, this); // clone array/object properties - const properties = ['flags', '_populate', '_populateMap', '_joins', '_joinedProps', '_aliasMap', '_cond', '_data', '_orderBy', '_schema', '_cache', 'subQueries']; + const properties = ['flags', '_populate', '_populateMap', '_joins', '_joinedProps', '_aliasMap', '_cond', '_data', '_orderBy', '_schema', '_indexHint', '_cache', 'subQueries']; properties.forEach(prop => (qb as any)[prop] = Utils.copy(this[prop as keyof this])); /* istanbul ignore else */
fix: fixed new trail with rotated or tilted particles	a43f8093204e46b2f22404960459aa0a114708c8	fix	https://github.com/tsparticles/tsparticles/commit/a43f8093204e46b2f22404960459aa0a114708c8	fixed new trail with rotated or tilted particles	[email protected]	diff --git a/TrailDrawer.ts b/TrailDrawer.ts index 826d14b..98b68fe 100644 --- a/TrailDrawer.ts +++ b/TrailDrawer.ts @@ -70,6 +70,8 @@ export class TrailDrawer implements IEffectDrawer<TrailParticle> { let lastPos = particle.trail[trailLength - 1].position; + context.setTransform(1, 0, 0, 1, currentPos.x, currentPos.y); + for (let i = trailLength; i > 0; i--) { const step = particle.trail[i - 1], position = step.position; @@ -112,6 +114,17 @@ export class TrailDrawer implements IEffectDrawer<TrailParticle> { lastPos = position; } + + const { transformData } = data; + + context.setTransform( + transformData.a, + transformData.b, + transformData.c, + transformData.d, + currentPos.x, + currentPos.y, + ); } particleInit(container: Container, particle: TrailParticle): void { diff --git a/IShapeDrawData.ts b/IShapeDrawData.ts index e5cb6e9..f319803 100644 --- a/IShapeDrawData.ts +++ b/IShapeDrawData.ts @@ -31,4 +31,29 @@ export type IShapeDrawData<TParticle extends Particle = Particle> = { * the particle radius / radius: number; + + /* + * the transform data of the particle + / + transformData: { + /* + * the horizontal scale of the particle + / + a: number; + + /* + * the horizontal skew of the particle + / + b: number; + + /* + * the vertical skew of the particle + / + c: number; + + /* + * the vertical scale of the particle + / + d: number; + }; }; diff --git a/CanvasUtils.ts b/CanvasUtils.ts index 891673c..e0688e0 100644 --- a/CanvasUtils.ts +++ b/CanvasUtils.ts @@ -123,7 +123,7 @@ export function drawParticle(data: IDrawParticleParams): void { context.strokeStyle = colorStyles.stroke; } - const drawData = { container, context, particle, radius, opacity, delta }; + const drawData: DrawShapeData = { container, context, particle, radius, opacity, delta, transformData }; context.beginPath(); @@ -178,6 +178,16 @@ type DrawShapeData = { the radius of the particle. / radius: number; + + /* + * the transform data of the particle. + / + transformData: { + a: number; + b: number; + c: number; + d: number; + }; }; /* @@ -185,7 +195,7 @@ type DrawShapeData = { * @param data - the function parameters. / export function drawEffect(data: DrawShapeData): void { - const { container, context, particle, radius, opacity, delta } = data; + const { container, context, particle, radius, opacity, delta, transformData } = data; if (!particle.effect) { return; @@ -197,7 +207,15 @@ export function drawEffect(data: DrawShapeData): void { return; } - drawer.draw({ context, particle, radius, opacity, delta, pixelRatio: container.retina.pixelRatio }); + drawer.draw({ + context, + particle, + radius, + opacity, + delta, + pixelRatio: container.retina.pixelRatio, + transformData: { ...transformData }, + }); } /* @@ -205,7 +223,7 @@ export function drawEffect(data: DrawShapeData): void { * @param data - the function parameters. / export function drawShape(data: DrawShapeData): void { - const { container, context, particle, radius, opacity, delta } = data; + const { container, context, particle, radius, opacity, delta, transformData } = data; if (!particle.shape) { return; @@ -217,7 +235,15 @@ export function drawShape(data: DrawShapeData): void { return; } - drawer.draw({ context, particle, radius, opacity, delta, pixelRatio: container.retina.pixelRatio }); + drawer.draw({ + context, + particle, + radius, + opacity, + delta, + pixelRatio: container.retina.pixelRatio, + transformData: { ...transformData }, + }); } /* @@ -225,7 +251,7 @@ export function drawShape(data: DrawShapeData): void { * @param data - the function parameters. / export function drawShapeAfterDraw(data: DrawShapeData): void { - const { container, context, particle, radius, opacity, delta } = data; + const { container, context, particle, radius, opacity, delta, transformData } = data; if (!particle.shape) { return; @@ -237,7 +263,15 @@ export function drawShapeAfterDraw(data: DrawShapeData): void { return; } - drawer.afterDraw({ context, particle, radius, opacity, delta, pixelRatio: container.retina.pixelRatio }); + drawer.afterDraw({ + context, + particle, + radius, + opacity, + delta, + pixelRatio: container.retina.pixelRatio, + transformData: { ...transformData }, + }); } /* diff --git a/fireworks2.ts b/fireworks2.ts index 854ecbc..94ef702 100644 --- a/fireworks2.ts +++ b/fireworks2.ts @@ -146,6 +146,9 @@ const options: ISourceOptions = { }, }, }, + rotate: { + path: true, + }, shape: { type: "circle", },
fix(mapping): do not require method definitions in EntitySchema Closes #512	58c96430d84c67415c21bc1265874e88c79736db	fix	https://github.com/mikro-orm/mikro-orm/commit/58c96430d84c67415c21bc1265874e88c79736db	do not require method definitions in EntitySchema Closes #512	[email protected]	diff --git a/EntitySchema.ts b/EntitySchema.ts index 9232aec..6a4b754 100644 --- a/EntitySchema.ts +++ b/EntitySchema.ts @@ -17,10 +17,12 @@ type Property<T> = \| ({ reference: ReferenceType.MANY_TO_MANY \| 'm:n' } & TypeDef<T> & ManyToManyOptions<T>) \| ({ enum: true } & EnumOptions) \| (TypeDef<T> & PropertyOptions); +type NonFunctionPropertyNames<T> = { [K in keyof T]: T[K] extends Function ? never : K }[keyof T]; +type PropertyKey<T, U> = NonFunctionPropertyNames<Omit<T, keyof U>>; type Metadata<T, U> = & Omit<Partial<EntityMetadata<T>>, 'name' \| 'properties'> & ({ name: string } \| { class: Constructor<T>; name?: string }) - & { properties?: { [K in keyof Omit<T, keyof U> & string]-?: Property<CollectionItem<NonNullable<T[K]>>> } }; + & { properties?: { [K in PropertyKey<T, U> & string]-?: Property<CollectionItem<NonNullable<T[K]>>> } }; export class EntitySchema<T extends AnyEntity<T> = AnyEntity, U extends AnyEntity<T> \| undefined = undefined> { diff --git a/User4.ts b/User4.ts index b8c9350..26bc97d 100644 --- a/User4.ts +++ b/User4.ts @@ -0,0 +1,28 @@ +import { EntitySchema } from '../../lib/schema'; + +export class User4 { + + id: string; + email: string; + agreedToTerms?: Date; + + constructor(id: string, email: string) { + this.id = id; + this.email = email; + } + + agreeToTerms(): void { + this.agreedToTerms = new Date(); + } + +} + +export const schema1 = new EntitySchema<User4>({ + class: User4, + tableName: 'person', + properties: { + id: { type: 'string', primary: true, name: 'cognito_id' }, + email: { type: 'string' }, + agreedToTerms: { type: 'datetime', nullable: true }, + }, +});
fix(snowflake): bring back default nth behavior from before the-epic-split	e94366700ae460052f675188674e24002b755ec5	fix	https://github.com/rohankumardubey/ibis/commit/e94366700ae460052f675188674e24002b755ec5	bring back default nth behavior from before the-epic-split	[email protected]	diff --git a/compiler.py b/compiler.py index 62ccea5..d97156d 100644 --- a/compiler.py +++ b/compiler.py @@ -480,6 +480,48 @@ class SnowflakeCompiler(SQLGlotCompiler): # boolxor accepts numerics ... and returns a boolean? wtf? return self.f.boolxor(self.cast(left, dt.int8), self.cast(right, dt.int8)) + def visit_Window(self, op, , how, func, start, end, group_by, order_by): + if start is None: + start = {} + if end is None: + end = {} + + start_value = start.get("value", "UNBOUNDED") + start_side = start.get("side", "PRECEDING") + end_value = end.get("value", "UNBOUNDED") + end_side = end.get("side", "FOLLOWING") + + if getattr(start_value, "this", None) == "0": + start_value = "CURRENT ROW" + start_side = None + + if getattr(end_value, "this", None) == "0": + end_value = "CURRENT ROW" + end_side = None + + spec = sge.WindowSpec( + kind=how.upper(), + start=start_value, + start_side=start_side, + end=end_value, + end_side=end_side, + over="OVER", + ) + order = sge.Order(expressions=order_by) if order_by else None + + orig_spec = spec + spec = self._minimize_spec(op.start, op.end, orig_spec) + + # due to https://docs.snowflake.com/en/sql-reference/functions-analytic#window-frame-usage-notes + # we need to make the default window rows (since range isn't supported) + # and we need to make the default frame unbounded preceding to current + # row + if spec is None and isinstance(op.func, (ops.First, ops.Last, ops.NthValue)): + spec = orig_spec + spec.args["kind"] = "ROWS" + + return sge.Window(this=func, partition_by=group_by, order=order, spec=spec) + def visit_WindowBoundary(self, op, , value, preceding): if not isinstance(op.value, ops.Literal): raise com.OperationNotDefinedError( diff --git a/test_window.py b/test_window.py index 4a78809..a60442d 100644 --- a/test_window.py +++ b/test_window.py @@ -202,11 +202,6 @@ def calc_zscore(s): pytest.mark.notimpl(["dask"], raises=com.OperationNotDefinedError), pytest.mark.notimpl(["flink"], raises=com.OperationNotDefinedError), pytest.mark.notimpl(["risingwave"], raises=PsycoPg2InternalError), - pytest.mark.broken( - ["snowflake"], - raises=AssertionError, - reason="behavior of windows with nth_value has changed; unclear whether that is in ibis or in snowflake itself", - ), ], ), param(
ci: only run coverage on pull requests	af9be8ca7832df2a22340a6476f91742b3ea1e37	ci	https://github.com/rohankumardubey/ibis/commit/af9be8ca7832df2a22340a6476f91742b3ea1e37	only run coverage on pull requests	[email protected]	diff --git a/codecov.yml b/codecov.yml index 83918f1..8e712f0 100644 --- a/codecov.yml +++ b/codecov.yml @@ -1,9 +1,17 @@ comment: - layout: "reach, diff, flags, files" + layout: "reach, diff, files" behavior: default - require_changes: false # if true: only post the comment if coverage changes - require_base: no # [yes :: must have a base report to post] - require_head: yes # [yes :: must have a head report to post] + require_changes: true # if true: only post the comment if coverage changes + require_base: false # [yes :: must have a base report to post] + require_head: true # [yes :: must have a head report to post] branches: null ignore: - "docs/**" +coverage: + status: + project: + default: + only_pulls: true + patch: + default: + only_pulls: true
feat(schema): try to infer runtime default values automatically (#3529)	d035781bc64f935d09b82660f67604e986df1c53	feat	https://github.com/mikro-orm/mikro-orm/commit/d035781bc64f935d09b82660f67604e986df1c53	try to infer runtime default values automatically (#3529)	[email protected]	diff --git a/MetadataDiscovery.ts b/MetadataDiscovery.ts index 4d43763..31c4f7b 100644 --- a/MetadataDiscovery.ts +++ b/MetadataDiscovery.ts @@ -121,7 +121,7 @@ export class MetadataDiscovery { })); for (const prop of missing) { - const target = (prop.entity instanceof Function ? prop.entity() : prop.type) as Constructor<AnyEntity>; + const target = (typeof prop.entity === 'function' ? prop.entity() : prop.type) as Constructor<AnyEntity>; await this.tryDiscoverTargets(Utils.asArray(target)); } } @@ -449,7 +449,7 @@ export class MetadataDiscovery { for (const prop of Object.values(meta.properties)) { this.initNullability(prop); this.applyNamingStrategy(meta, prop); - this.initDefaultValue(prop); + this.initDefaultValue(meta, prop); this.initVersionProperty(meta, prop); this.initCustomType(meta, prop); await this.initColumnType(prop, meta.path); @@ -910,7 +910,20 @@ export class MetadataDiscovery { return '1'; } - private initDefaultValue(prop: EntityProperty): void { + private initDefaultValue(meta: EntityMetadata, prop: EntityProperty): void { + try { + // try to create two entity instances to detect the value is stable + const entity1 = new meta.class(); + const entity2 = new meta.class(); + + // we compare the two values by reference, this will discard things like `new Date()` + if (entity1[prop.name] != null && entity1[prop.name] === entity2[prop.name]) { + prop.default ??= entity1[prop.name]; + } + } catch { + // ignore + } + if (prop.defaultRaw \|\| !('default' in prop)) { return; } @@ -926,6 +939,7 @@ export class MetadataDiscovery { private initVersionProperty(meta: EntityMetadata, prop: EntityProperty): void { if (prop.version) { + this.initDefaultValue(meta, prop); meta.versionProperty = prop.name; prop.defaultRaw = this.getDefaultVersionValue(prop); } diff --git a/QueryBuilder.test.ts b/QueryBuilder.test.ts index 1e29c5f..09ddf81 100644 --- a/QueryBuilder.test.ts +++ b/QueryBuilder.test.ts @@ -2409,7 +2409,7 @@ describe('QueryBuilder', () => { const qb9 = pg.em.createQueryBuilder(Author2); qb9.insert({ email: '[email protected]', name: 'John Doe' }).onConflict('email').ignore(); - expect(qb9.getQuery()).toEqual('insert into "author2" ("email", "name") values ($1, $2) on conflict ("email") do nothing returning "id", "created_at", "updated_at", "age", "terms_accepted"'); + expect(qb9.getQuery()).toEqual('insert into "author2" ("email", "name") values ($1, $2) on conflict ("email") do nothing returning "id", "hook_test", "created_at", "updated_at", "age", "terms_accepted"'); expect(qb9.getParams()).toEqual(['[email protected]', 'John Doe']); const timestamp = new Date(); @@ -2427,7 +2427,7 @@ describe('QueryBuilder', () => { }) .where({ updatedAt: { $lt: timestamp } }); - expect(qb10.getQuery()).toEqual('insert into "author2" ("created_at", "email", "name", "updated_at") values ($1, $2, $3, $4) on conflict ("email") do update set "name" = $5,"updated_at" = $6 where "updated_at" < $7 returning "id", "created_at", "updated_at", "age", "terms_accepted"'); + expect(qb10.getQuery()).toEqual('insert into "author2" ("created_at", "email", "name", "updated_at") values ($1, $2, $3, $4) on conflict ("email") do update set "name" = $5,"updated_at" = $6 where "updated_at" < $7 returning "id", "hook_test", "created_at", "updated_at", "age", "terms_accepted"'); expect(qb10.getParams()).toEqual([timestamp, '[email protected]', 'John Doe', timestamp, 'John Doe', timestamp, timestamp]); const qb11 = pg.em.createQueryBuilder(Book2).where({ meta: { foo: 123 } }); diff --git a/custom-pivot-entity-uni.sqlite.test.ts.snap b/custom-pivot-entity-uni.sqlite.test.ts.snap index aa3621c..49cfe0e 100644 --- a/custom-pivot-entity-uni.sqlite.test.ts.snap +++ b/custom-pivot-entity-uni.sqlite.test.ts.snap @@ -3,7 +3,7 @@ exports[`custom pivot entity for m:n with additional properties (unidirectional) schema 1`] = ` "pragma foreign_keys = off; -create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null, \\`shipped\\` integer not null, \\`created\\` datetime not null); +create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null default false, \\`shipped\\` integer not null default false, \\`created\\` datetime not null); create table \\`product\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null, \\`current_price\\` integer not null); diff --git a/custom-pivot-entity-wrong-order.sqlite.test.ts.snap b/custom-pivot-entity-wrong-order.sqlite.test.ts.snap index 197d154..395fb90 100644 --- a/custom-pivot-entity-wrong-order.sqlite.test.ts.snap +++ b/custom-pivot-entity-wrong-order.sqlite.test.ts.snap @@ -3,7 +3,7 @@ exports[`custom pivot entity for m:n with additional properties (bidirectional, with wrong property order in pivot entity) schema 1`] = ` "pragma foreign_keys = off; -create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null, \\`shipped\\` integer not null, \\`created\\` datetime not null); +create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null default false, \\`shipped\\` integer not null default false, \\`created\\` datetime not null); create table \\`product\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null, \\`current_price\\` integer not null); diff --git a/custom-pivot-entity.sqlite.test.ts.snap b/custom-pivot-entity.sqlite.test.ts.snap index 57f70ef..821c927 100644 --- a/custom-pivot-entity.sqlite.test.ts.snap +++ b/custom-pivot-entity.sqlite.test.ts.snap @@ -3,7 +3,7 @@ exports[`custom pivot entity for m:n with additional properties (bidirectional) schema 1`] = ` "pragma foreign_keys = off; -create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null, \\`shipped\\` integer not null, \\`created\\` datetime not null); +create table \\`order\\` (\\`id\\` integer not null primary key autoincrement, \\`paid\\` integer not null default false, \\`shipped\\` integer not null default false, \\`created\\` datetime not null); create table \\`product\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null, \\`current_price\\` integer not null); diff --git a/default-values.mysql.test.ts.snap b/default-values.mysql.test.ts.snap index ba486d4..b5146e6 100644 --- a/default-values.mysql.test.ts.snap +++ b/default-values.mysql.test.ts.snap @@ -0,0 +1,11 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`default values in mysql runtime default values are inferred if the entity can be created without any constructor parameters 1`] = ` +"set names utf8mb4; +set foreign_key_checks = 0; + +create table \\`a\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`foo1\\` int not null default 50, \\`foo2\\` int not null default 50, \\`foo3\\` int not null default 50, \\`version\\` int not null default 1) default character set utf8mb4 engine = InnoDB; + +set foreign_key_checks = 1; +" +`; diff --git a/default-values.mysql.test.ts b/default-values.mysql.test.ts index 8e22f6d..b86e2c2 100644 --- a/default-values.mysql.test.ts +++ b/default-values.mysql.test.ts @@ -37,6 +37,10 @@ describe('default values in mysql', () => { afterAll(() => orm.close(true)); + test(`runtime default values are inferred if the entity can be created without any constructor parameters`, async () => { + expect(await orm.schema.getCreateSchemaSQL()).toMatchSnapshot(); + }); + test(`database defaults will be available after flush`, async () => { const mock = mockLogger(orm, ['query']); diff --git a/GH2401.test.ts b/GH2401.test.ts index 323403e..dd831ae 100644 --- a/GH2401.test.ts +++ b/GH2401.test.ts @@ -10,7 +10,7 @@ export class Versioned { @Property() name!: string; - @Property({ version: true, default: 0 }) + @Property({ version: true }) version: number = 0; } diff --git a/SchemaGenerator.mysql.test.ts.snap b/SchemaGenerator.mysql.test.ts.snap index b932d82..177f72c 100644 --- a/SchemaGenerator.mysql.test.ts.snap +++ b/SchemaGenerator.mysql.test.ts.snap @@ -30,7 +30,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -270,7 +270,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -395,6 +395,8 @@ set foreign_key_checks = 0; alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; @@ -435,7 +437,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -675,7 +677,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -800,6 +802,8 @@ set foreign_key_checks = 0; alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; @@ -815,6 +819,8 @@ exports[`SchemaGenerator rename column [mysql]: mysql-update-schema-rename-colum alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`author2\\` drop index \\`author2_favourite_author_id_index\\`; alter table \\`author2\\` drop index \\`author2_name_age_index\\`; alter table \\`author2\\` change \\`age\\` \\`age_in_years\\` int null default null; @@ -870,6 +876,8 @@ exports[`SchemaGenerator update schema [mysql]: mysql-update-schema-create-table alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; @@ -958,6 +966,8 @@ exports[`SchemaGenerator update schema enums [mysql]: mysql-update-schema-enums- alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; diff --git a/SchemaGenerator.mysql2.test.ts.snap b/SchemaGenerator.mysql2.test.ts.snap index 7885068..05a55f4 100644 --- a/SchemaGenerator.mysql2.test.ts.snap +++ b/SchemaGenerator.mysql2.test.ts.snap @@ -27,7 +27,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -242,7 +242,7 @@ create table \\`foo_param2\\` (\\`bar_id\\` int unsigned not null, \\`baz_id\\` int un alter table \\`foo_param2\\` add index \\`foo_param2_bar_id_index\\`(\\`bar_id\\`); alter table \\`foo_param2\\` add index \\`foo_param2_baz_id_index\\`(\\`baz_id\\`); -create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null, \\`type\\` enum('local', 'global') not null, \\`type2\\` enum('LOCAL', 'GLOBAL') not null, \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; +create table \\`publisher2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`name\\` varchar(255) not null default 'asd', \\`type\\` enum('local', 'global') not null default 'local', \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL', \\`enum1\\` tinyint null, \\`enum2\\` tinyint null, \\`enum3\\` tinyint null, \\`enum4\\` enum('a', 'b', 'c') null, \\`enum5\\` enum('a') null) default character set utf8mb4 engine = InnoDB; create table \\`author2\\` (\\`id\\` int unsigned not null auto_increment primary key, \\`created_at\\` datetime(3) not null default current_timestamp(3), \\`updated_at\\` datetime(3) not null default current_timestamp(3), \\`name\\` varchar(255) not null, \\`email\\` varchar(255) not null, \\`age\\` int null default null, \\`terms_accepted\\` tinyint(1) not null default false, \\`optional\\` tinyint(1) null, \\`identities\\` text null, \\`born\\` date null, \\`born_time\\` time null, \\`favourite_book_uuid_pk\\` varchar(36) null, \\`favourite_author_id\\` int unsigned null) default character set utf8mb4 engine = InnoDB; alter table \\`author2\\` add index \\`custom_email_index_name\\`(\\`email\\`); @@ -313,6 +313,8 @@ alter table \\`user2_sandwiches\\` add index \\`user2_sandwiches_user2_first_name_u exports[`SchemaGenerator (no FKs) generate schema from metadata [mysql]: mysql-update-schema-dump 1`] = ` "alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; @@ -327,6 +329,8 @@ exports[`SchemaGenerator (no FKs) rename column [mysql]: mysql-update-schema-ren alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`author2\\` drop index \\`author2_favourite_author_id_index\\`; alter table \\`author2\\` drop index \\`author2_name_age_index\\`; alter table \\`author2\\` change \\`age\\` \\`age_in_years\\` int null default null; @@ -379,6 +383,8 @@ exports[`SchemaGenerator (no FKs) update schema [mysql]: mysql-update-schema-cre alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; @@ -467,6 +473,8 @@ exports[`SchemaGenerator (no FKs) update schema enums [mysql]: mysql-update-sche alter table \\`test2\\` drop foreign key \\`test2_foo___bar_foreign\\`; +alter table \\`publisher2\\` modify \\`name\\` varchar(255) not null default 'asd', modify \\`type\\` enum('local', 'global') not null default 'local', modify \\`type2\\` enum('LOCAL', 'GLOBAL') not null default 'LOCAL'; + alter table \\`book2\\` drop \\`foo\\`; alter table \\`test2\\` drop index \\`test2_foo___bar_unique\\`; diff --git a/SchemaGenerator.postgres.test.ts.snap b/SchemaGenerator.postgres.test.ts.snap index 45d40fa..8f00762 100644 --- a/SchemaGenerator.postgres.test.ts.snap +++ b/SchemaGenerator.postgres.test.ts.snap @@ -18,7 +18,7 @@ create table "foo_param2" ("bar_id" int not null, "baz_id" int not null, "value" create table "label2" ("uuid" uuid not null, "name" varchar(255) not null, constraint "label2_pkey" primary key ("uuid")); -create table "publisher2" ("id" serial primary key, "name" varchar(255) not null, "type" text check ("type" in ('local', 'global')) not null, "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null, "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); +create table "publisher2" ("id" serial primary key, "name" varchar(255) not null default 'asd', "type" text check ("type" in ('local', 'global')) not null default 'local', "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null default 'LOCAL', "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); create table "author2" ("id" serial primary key, "created_at" timestamptz(3) not null default current_timestamp(3), "updated_at" timestamptz(3) not null default current_timestamp(3), "name" varchar(255) not null, "email" varchar(255) not null, "age" int null default null, "terms_accepted" boolean not null default false, "optional" boolean null, "identities" text[] null, "born" date null, "born_time" time(0) null, "favourite_book_uuid_pk" uuid null, "favourite_author_id" int null); create index "custom_email_index_name" on "author2" ("email"); @@ -164,7 +164,7 @@ create table "foo_param2" ("bar_id" int not null, "baz_id" int not null, "value" create table "label2" ("uuid" uuid not null, "name" varchar(255) not null, constraint "label2_pkey" primary key ("uuid")); -create table "publisher2" ("id" serial primary key, "name" varchar(255) not null, "type" text check ("type" in ('local', 'global')) not null, "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null, "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); +create table "publisher2" ("id" serial primary key, "name" varchar(255) not null default 'asd', "type" text check ("type" in ('local', 'global')) not null default 'local', "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null default 'LOCAL', "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); create table "author2" ("id" serial primary key, "created_at" timestamptz(3) not null default current_timestamp(3), "updated_at" timestamptz(3) not null default current_timestamp(3), "name" varchar(255) not null, "email" varchar(255) not null, "age" int null default null, "terms_accepted" boolean not null default false, "optional" boolean null, "identities" text[] null, "born" date null, "born_time" time(0) null, "favourite_book_uuid_pk" uuid null, "favourite_author_id" int null); create index "custom_email_index_name" on "author2" ("email"); @@ -266,7 +266,7 @@ create table "foo_param2" ("bar_id" int not null, "baz_id" int not null, "value" create table "label2" ("uuid" uuid not null, "name" varchar(255) not null, constraint "label2_pkey" primary key ("uuid")); -create table "publisher2" ("id" serial primary key, "name" varchar(255) not null, "type" text check ("type" in ('local', 'global')) not null, "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null, "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); +create table "publisher2" ("id" serial primary key, "name" varchar(255) not null default 'asd', "type" text check ("type" in ('local', 'global')) not null default 'local', "type2" text check ("type2" in ('LOCAL', 'GLOBAL')) not null default 'LOCAL', "enum1" smallint null, "enum2" smallint null, "enum3" smallint null, "enum4" text check ("enum4" in ('a', 'b', 'c')) null, "enum5" text check ("enum5" in ('a')) null); create table "author2" ("id" serial primary key, "created_at" timestamptz(3) not null default current_timestamp(3), "updated_at" timestamptz(3) not null default current_timestamp(3), "name" varchar(255) not null, "email" varchar(255) not null, "age" int null default null, "terms_accepted" boolean not null default false, "optional" boolean null, "identities" text[] null, "born" date null, "born_time" time(0) null, "favourite_book_uuid_pk" uuid null, "favourite_author_id" int null); create index "custom_email_index_name" on "author2" ("email"); diff --git a/SchemaGenerator.sqlite.test.ts.snap b/SchemaGenerator.sqlite.test.ts.snap index a5169cd..243ad9a 100644 --- a/SchemaGenerator.sqlite.test.ts.snap +++ b/SchemaGenerator.sqlite.test.ts.snap @@ -103,7 +103,7 @@ exports[`SchemaGenerator [sqlite] update empty schema from metadata [sqlite]: sq create table \\`book_tag3\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null, \\`version\\` datetime not null default current_timestamp); -create table \\`publisher3\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null, \\`type\\` text not null); +create table \\`publisher3\\` (\\`id\\` integer not null primary key autoincrement, \\`name\\` text not null default 'asd', \\`type\\` text not null default 'local'); create table \\`author3\\` (\\`id\\` integer not null primary key autoincrement, \\`created_at\\` datetime null, \\`updated_at\\` datetime null, \\`name\\` text not null, \\`email\\` text not null, \\`age\\` integer null, \\`terms_accepted\\` integer not null default 0, \\`identities\\` text null, \\`born\\` date(3) null, \\`born_time\\` time(3) null, \\`favourite_book_id\\` integer null, constraint \\`author3_favourite_book_id_foreign\\` foreign key(\\`favourite_book_id\\`) references \\`book3\\`(\\`id\\`) on delete set null on update cascade); create unique index \\`author3_email_unique\\` on \\`author3\\` (\\`email\\`); diff --git a/GH529.test.ts.snap b/GH529.test.ts.snap index 38b7212..1ddae75 100644 --- a/GH529.test.ts.snap +++ b/GH529.test.ts.snap @@ -6,7 +6,7 @@ set session_replication_role = 'replica'; create table "customer" ("id" serial primary key); -create table "order" ("id" serial primary key, "customer_id" int not null, "paid" boolean not null, "shipped" boolean not null, "created" timestamptz(0) not null); +create table "order" ("id" serial primary key, "customer_id" int not null, "paid" boolean not null default false, "shipped" boolean not null default false, "created" timestamptz(0) not null); create table "product" ("id" serial primary key, "name" varchar(255) not null, "current_price" int not null);
refactor: remove unused imports	ec49708236011195b297822915daaaf7536c2d2b	refactor	https://github.com/rohankumardubey/ibis/commit/ec49708236011195b297822915daaaf7536c2d2b	remove unused imports	[email protected]	diff --git a/api.py b/api.py index c9e74a9..5fd49df 100644 --- a/api.py +++ b/api.py @@ -4,9 +4,7 @@ from __future__ import annotations import collections import datetime -import functools import numbers -import operator from typing import Iterable, Literal, Mapping, Sequence, TypeVar import dateutil.parser @@ -20,7 +18,6 @@ import ibis.expr.rules as rlz import ibis.expr.schema as sch import ibis.expr.types as ir import ibis.expr.window as win -import ibis.util as util from ibis.expr.random import random # noqa from ibis.expr.schema import Schema from ibis.expr.types import ( # noqa
test: add tests for logical negation with invert and negative	9e52f5b3dcfa626a118399fad897b400354dc508	test	https://github.com/rohankumardubey/ibis/commit/9e52f5b3dcfa626a118399fad897b400354dc508	add tests for logical negation with invert and negative	[email protected]	diff --git a/test_generic.py b/test_generic.py index 2ecdfbd..288e3ac 100644 --- a/test_generic.py +++ b/test_generic.py @@ -1,9 +1,11 @@ import decimal import io +import operator import numpy as np import pandas as pd import pytest +import toolz from packaging.version import parse as vparse from pytest import param @@ -499,3 +501,25 @@ def test_isin_notin_column_expr(backend, alltypes, df, ibis_op, pandas_op): expected = df[pandas_op(df)].sort_values(["id"]).reset_index(drop=True) result = expr.execute() backend.assert_frame_equal(result, expected) + + [email protected]( + ("expr", "expected", "op"), + [ + param(True, True, toolz.identity, id="true_noop"), + param(False, False, toolz.identity, id="false_noop"), + param(True, False, operator.invert, id="true_invert"), + param(False, True, operator.invert, id="false_invert"), + param(True, False, operator.neg, id="true_negate"), + param(False, True, operator.neg, id="false_negate"), + ], +) +def test_logical_negation_literal(con, expr, expected, op): + assert con.execute(op(ibis.literal(expr))) == expected + + [email protected]("op", [toolz.identity, operator.invert, operator.neg]) +def test_logical_negation_column(backend, alltypes, df, op): + result = op(alltypes["bool_col"]).execute() + expected = op(df["bool_col"]) + backend.assert_series_equal(result, expected, check_names=False) diff --git a/test_value_exprs.py b/test_value_exprs.py index 20d85fc..7ce61f8 100644 --- a/test_value_exprs.py +++ b/test_value_exprs.py @@ -466,7 +466,7 @@ def test_casted_exprs_are_named(table): expr.value_counts() [email protected]('col', list('abcdefh')) [email protected]('col', list('abcdef')) def test_negate(table, col): c = table[col] result = -c @@ -474,10 +474,19 @@ def test_negate(table, col): assert isinstance(result.op(), ops.Negate) -def test_negate_boolean_scalar(): - result = -(ibis.literal(False)) [email protected]("op", [operator.neg, operator.invert]) [email protected]("value", [True, False]) +def test_negate_boolean_scalar(op, value): + result = op(ibis.literal(value)) assert isinstance(result, ir.BooleanScalar) - assert isinstance(result.op(), ops.Negate) + assert isinstance(result.op(), ops.Not) + + [email protected]("op", [operator.neg, operator.invert]) +def test_negate_boolean_column(table, op): + result = op(table["h"]) + assert isinstance(result, ir.BooleanColumn) + assert isinstance(result.op(), ops.Not) @pytest.mark.parametrize('column', ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'])
build: using cli for build	86d4bbc5bc6f03699c76a9d3352d70c6899436df	build	https://github.com/tsparticles/tsparticles/commit/86d4bbc5bc6f03699c76a9d3352d70c6899436df	using cli for build	[email protected]	diff --git a/.browserslistrc b/.browserslistrc index 08ff9f5..293a7fa 100644 --- a/.browserslistrc +++ b/.browserslistrc @@ -1,5 +1,2 @@ -defaults -not IE 11 +since 2019 not dead -> 0.2% -last 2 versions \\ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index 05f8c05..4801615 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,5 +1,5 @@ module.exports = { extends: [ "@tsparticles/eslint-config", - ], + ] }; diff --git a/package.dist.json b/package.dist.json index dfef3a7..1bf937f 100644 --- a/package.dist.json +++ b/package.dist.json @@ -80,7 +80,7 @@ "url": "https://www.buymeacoffee.com/matteobruni" } ], - "main": "index.js", + "main": "cjs/index.js", "jsdelivr": "tsparticles.configs.min.js", "unpkg": "tsparticles.configs.min.js", "module": "esm/index.js", diff --git a/package.json b/package.json index ebfd947..9e03cd5 100644 --- a/package.json +++ b/package.json @@ -1,116 +1,99 @@ { - "name": "tsparticles-demo-configs", - "version": "2.10.1", - "description": "tsParticles demo configurations", - "homepage": "https://particles.js.org", - "scripts": { - "prettify:ci:src": "prettier --check ./src/", - "prettify:ci:readme": "prettier --check ./README.md", - "prettify:src": "prettier --write ./src/", - "prettify:readme": "prettier --write ./README.md", - "lint": "eslint src --ext .js,.jsx,.ts,.tsx --fix", - "lint:ci": "eslint src --ext .js,.jsx,.ts,.tsx", - "compile": "pnpm run build:ts", - "build:ts": "pnpm run build:ts:browser && pnpm run build:ts:cjs && pnpm run build:ts:esm && pnpm run build:ts:types", - "build:ts:browser": "tsc -b tsconfig.browser.json", - "build:ts:cjs": "tsc", - "build:ts:esm": "tsc -b tsconfig.module.json", - "build:ts:types": "tsc -b tsconfig.types.json", - "build:ts:umd": "tsc -b tsconfig.umd.json", - "bundle": "webpack --mode production", - "distfiles": "node ./scripts/distfiles.js", - "build": "pnpm run clear:dist && pnpm run prettify:src && pnpm run lint && pnpm run compile && pnpm run bundle && pnpm run prettify:readme && pnpm run distfiles", - "build:ci": "pnpm run clear:dist && pnpm run prettify:ci:src && pnpm run lint:ci && pnpm run compile && pnpm run bundle && pnpm run prettify:ci:readme && pnpm run distfiles", - "clear:dist": "rimraf ./dist", - "version": "pnpm run distfiles && git add package.dist.json", - "prepack": "pnpm run build" + "name": "tsparticles-demo-configs", + "version": "2.10.1", + "homepage": "https://particles.js.org", + "scripts": { + "build": "tsparticles-cli build", + "build:ci": "tsparticles-cli build --ci", + "version": "tsparticles-cli build -d && git add package.dist.json", + "prepack": "pnpm run build" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/matteobruni/tsparticles.git", + "directory": "utils/configs" + }, + "keywords": [ + "front-end", + "frontend", + "tsparticles", + "particles.js", + "particlesjs", + "particles", + "particle", + "canvas", + "jsparticles", + "xparticles", + "particles-js", + "particles-bg", + "particles-bg-vue", + "particles-ts", + "particles.ts", + "react-particles-js", + "react-particles.js", + "react-particles", + "react", + "reactjs", + "vue-particles", + "ngx-particles", + "angular-particles", + "particleground", + "vue", + "vuejs", + "preact", + "preactjs", + "jquery", + "angularjs", + "angular", + "typescript", + "javascript", + "animation", + "web", + "html5", + "web-design", + "webdesign", + "css", + "html", + "css3", + "animated", + "background", + "confetti", + "canvas", + "fireworks", + "fireworks-js", + "confetti-js", + "confettijs", + "fireworksjs", + "canvas-confetti" + ], + "author": "Matteo Bruni <[email protected]>", + "license": "MIT", + "bugs": { + "url": "https://github.com/matteobruni/tsparticles/issues" + }, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/matteobruni" }, - "repository": { - "type": "git", - "url": "git+https://github.com/matteobruni/tsparticles.git", - "directory": "utils/configs" + { + "type": "github", + "url": "https://github.com/sponsors/tsparticles" }, - "keywords": [ - "front-end", - "frontend", - "tsparticles", - "particles.js", - "particlesjs", - "particles", - "particle", - "canvas", - "jsparticles", - "xparticles", - "particles-js", - "particles-bg", - "particles-bg-vue", - "particles-ts", - "particles.ts", - "react-particles-js", - "react-particles.js", - "react-particles", - "react", - "reactjs", - "vue-particles", - "ngx-particles", - "angular-particles", - "particleground", - "vue", - "vuejs", - "preact", - "preactjs", - "jquery", - "angularjs", - "angular", - "typescript", - "javascript", - "animation", - "web", - "html5", - "web-design", - "webdesign", - "css", - "html", - "css3", - "animated", - "background", - "confetti", - "canvas", - "fireworks", - "fireworks-js", - "confetti-js", - "confettijs", - "fireworksjs", - "canvas-confetti" - ], - "publishConfig": { - "directory": "dist", - "linkDirectory": true - }, - "author": "Matteo Bruni <[email protected]>", - "license": "MIT", - "bugs": { - "url": "https://github.com/matteobruni/tsparticles/issues" - }, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/matteobruni" - }, - { - "type": "github", - "url": "https://github.com/sponsors/tsparticles" - }, - { - "type": "buymeacoffee", - "url": "https://www.buymeacoffee.com/matteobruni" - } - ], - "main": "dist/index.js", - "module": "dist/index.js", - "types": "dist/index.d.ts", - "prettier": "@tsparticles/prettier-config", - "dependencies": { - "tsparticles-engine": "^2.10.1" + { + "type": "buymeacoffee", + "url": "https://www.buymeacoffee.com/matteobruni" } + ], + "main": "dist/cjs/index.js", + "module": "dist/esm/index.js", + "types": "dist/types/index.d.ts", + "prettier": "@tsparticles/prettier-config", + "dependencies": { + "tsparticles-engine": "^2.10.1" + }, + "publishConfig": { + "directory": "dist", + "linkDirectory": true + } } diff --git a/tsconfig.base.json b/tsconfig.base.json index 680ec4d..a5935d4 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -1,86 +1,9 @@ { - "compilerOptions": { - /* Basic Options / - // "incremental": true, / Enable incremental compilation / - "target": "ES2021", - / Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. / - "module": "ESNext", - / Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. / - "lib": ["ESNext", "ES2022", "ES2021", "ES2020", "ES2019", "ES2018", "ES2017", "ES2016", "ES2015", "ES5", "DOM"], - / Specify library files to be included in the compilation. / - // "allowJs": true, / Allow javascript files to be compiled. / - // "checkJs": true, / Report errors in .js files. / - // "jsx": "preserve", / Specify JSX code generation: 'preserve', 'react-native', or 'react'. / - "declaration": true, - / Generates corresponding '.d.ts' file. / - // "declarationMap": true, / Generates a sourcemap for each corresponding '.d.ts' file. / - // "sourceMap": true, / Generates corresponding '.map' file. / - // "outFile": "./", / Concatenate and emit output to single file. / - "outDir": "./dist", - / Redirect output structure to the directory. / - "rootDir": "./src", - / Specify the root directory of input files. Use to control the output directory structure with --outDir. / - // "composite": true, / Enable project compilation / - // "tsBuildInfoFile": "./", / Specify file to store incremental compilation information / - "removeComments": true, - / Do not emit comments to output. / - // "noEmit": true, / Do not emit outputs. / - "importHelpers": false, - / Import emit helpers from 'tslib'. / - // "downlevelIteration": true, / Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. / - // "isolatedModules": true, / Transpile each file as a separate module (similar to 'ts.transpileModule'). / - - / Strict Type-Checking Options / - "strict": true, - / Enable all strict type-checking options. / - "noImplicitAny": true, - / Raise error on expressions and declarations with an implied 'any' type. / - "strictNullChecks": true, - / Enable strict null checks. / - "strictFunctionTypes": true, - / Enable strict checking of function types. / - "strictBindCallApply": true, - / Enable strict 'bind', 'call', and 'apply' methods on functions. / - "strictPropertyInitialization": true, - / Enable strict checking of property initialization in classes. / - "noImplicitThis": true, - / Raise error on 'this' expressions with an implied 'any' type. / - "alwaysStrict": true, - / Parse in strict mode and emit "use strict" for each source file. / - "useUnknownInCatchVariables": true, - / Additional Checks / - // "noUnusedLocals": true, / Report errors on unused locals. / - // "noUnusedParameters": true, / Report errors on unused parameters. / - // "noImplicitReturns": true, / Report error when not all code paths in function return a value. / - "noFallthroughCasesInSwitch": true, - / Report errors for fallthrough cases in switch statement. / - - / Module Resolution Options / - "moduleResolution": "node", - / Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). / - // "baseUrl": "./", / Base directory to resolve non-absolute module names. / - // "paths": {}, / A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. / - // "rootDirs": [], / List of root folders whose combined content represents the structure of the project at runtime. / - // "typeRoots": [], / List of folders to include type definitions from. / - "types": [], - / Type declaration files to be included in compilation. / - // "allowSyntheticDefaultImports": true, / Allow default imports from modules with no default export. This does not affect code emit, just typechecking. / - "esModuleInterop": true, - / Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. / - // "preserveSymlinks": true, / Do not resolve the real path of symlinks. / - // "allowUmdGlobalAccess": true, / Allow accessing UMD globals from modules. / - - / Source Map Options / - // "sourceRoot": "", / Specify the location where debugger should locate TypeScript files instead of source locations. / - // "mapRoot": "", / Specify the location where debugger should locate map files instead of generated locations. / - // "inlineSourceMap": true, / Emit a single file with source maps instead of having a separate file. / - // "inlineSources": true, / Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. / - - / Experimental Options / - // "experimentalDecorators": true, / Enables experimental support for ES7 decorators. / - // "emitDecoratorMetadata": true, / Enables experimental support for emitting type metadata for decorators. / - "resolveJsonModule": true - }, - "include": ["src"], - "exclude": ["./tests/", "./node_modules//", "../../node_modules/*/", "./dist/", "./typedoc/", "./docs/"] + "extends": "@tsparticles/tsconfig/tsconfig.base.json", + "compilerOptions": { + "rootDir": "./src" + }, + "include": [ + "./src" + ] } diff --git a/tsconfig.browser.json b/tsconfig.browser.json index 11ca34e..5f2d6c5 100644 --- a/tsconfig.browser.json +++ b/tsconfig.browser.json @@ -1,7 +1,6 @@ { - "extends": "./tsconfig.base.json", - "compilerOptions": { - "module": "ESNext", - "outDir": "./dist/browser" - } + "extends": ["./tsconfig.base.json", "@tsparticles/tsconfig/tsconfig.browser.json"], + "compilerOptions": { + "outDir": "./dist/browser" + } } diff --git a/tsconfig.json b/tsconfig.json index 0e35f09..5d00c23 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,8 +1,6 @@ { - "extends": "./tsconfig.base.json", - "compilerOptions": { - "target": "ES2015", - "module": "CommonJS", - "outDir": "./dist" - } + "extends": ["./tsconfig.base.json", "@tsparticles/tsconfig/tsconfig.json"], + "compilerOptions": { + "outDir": "./dist/cjs" + } } diff --git a/tsconfig.module.json b/tsconfig.module.json index 2dde64d..e9c753f 100644 --- a/tsconfig.module.json +++ b/tsconfig.module.json @@ -1,7 +1,6 @@ { - "extends": "./tsconfig.base.json", - "compilerOptions": { - "module": "ESNext", - "outDir": "./dist/esm" - } + "extends": ["./tsconfig.base.json", "@tsparticles/tsconfig/tsconfig.module.json"], + "compilerOptions": { + "outDir": "./dist/esm" + } } diff --git a/tsconfig.types.json b/tsconfig.types.json index 6a5cc84..598ac84 100644 --- a/tsconfig.types.json +++ b/tsconfig.types.json @@ -1,9 +1,6 @@ { - "extends": "./tsconfig.base.json", - "compilerOptions": { - "target": "ESNext", - "module": "ESNext", - "declaration": true, - "emitDeclarationOnly": true - } + "extends": ["./tsconfig.base.json", "@tsparticles/tsconfig/tsconfig.types.json"], + "compilerOptions": { + "outDir": "./dist/types" + } } diff --git a/tsconfig.umd.json b/tsconfig.umd.json index c0d74a3..5ffd14b 100644 --- a/tsconfig.umd.json +++ b/tsconfig.umd.json @@ -1,8 +1,6 @@ { - "extends": "./tsconfig.base.json", - "compilerOptions": { - "module": "UMD", - "outDir": "./dist/umd", - "resolveJsonModule": false - } + "extends": ["./tsconfig.base.json", "@tsparticles/tsconfig/tsconfig.umd.json"], + "compilerOptions": { + "outDir": "./dist/umd" + } } diff --git a/typedoc.json b/typedoc.json index e0dd874..db76e26 100644 --- a/typedoc.json +++ b/typedoc.json @@ -0,0 +1,39 @@ +{ + "includes": "./markdown", + "entryPoints": [ + "./src/" + ], + "entryPointStrategy": "expand", + "name": "tsParticles Full Bundle", + "includeVersion": true, + "hideGenerator": true, + "out": "./docs", + "keywords": [ + "html", + "css", + "javascript", + "typescript", + "particles", + "js", + "ts", + "jsx", + "tsx", + "canvas", + "confetti", + "fireworks", + "animations", + "react", + "vue", + "angular", + "svelte", + "libraries", + "how", + "to", + "create", + "add" + ], + "validation": { + "invalidLink": true, + "notDocumented": true + } +}
fix: move "velocity" getter from FrameValue to SpringValue The Animated node(s) of an Interpolation object don't currently have their "lastVelocity" updated, so the "velocity" getter would return an incorrect value.	63f85533e63ff9fae624facd39dc203799e88a67	fix	https://github.com/pmndrs/react-spring/commit/63f85533e63ff9fae624facd39dc203799e88a67	move "velocity" getter from FrameValue to SpringValue The Animated node(s) of an Interpolation object don't currently have their "lastVelocity" updated, so the "velocity" getter would return an incorrect value.	[email protected]	diff --git a/FrameValue.ts b/FrameValue.ts index 722e442..a4fc5e7 100644 --- a/FrameValue.ts +++ b/FrameValue.ts @@ -1,10 +1,9 @@ import { each, InterpolatorArgs, FluidValue, FluidObserver } from 'shared' -import { getAnimated, AnimatedValue } from 'animated' +import { getAnimated } from 'animated' import { deprecateInterpolate } from 'shared/deprecations' import * as G from 'shared/globals' import { Interpolation } from './Interpolation' -import { Velocity } from './types/animated' export const isFrameValue = (value: any): value is FrameValue => value instanceof FrameValue @@ -37,13 +36,6 @@ export abstract class FrameValue<T = any> } } - get velocity() { - const node = getAnimated(this)! - return (node instanceof AnimatedValue - ? node.lastVelocity \|\| 0 - : node.getPayload().map(node => node.lastVelocity \|\| 0)) as Velocity<T> - } - /** Get the current value / get(): T { const node = getAnimated(this) diff --git a/SpringValue.ts b/SpringValue.ts index 9e46153..455135c 100644 --- a/SpringValue.ts +++ b/SpringValue.ts @@ -29,6 +29,7 @@ import { OnRest, AnimationEvents, EventProp, + Velocity, } from './types/animated' import { runAsync, @@ -100,6 +101,13 @@ export class SpringValue<T = any> extends FrameValue<T> { return !this.is(ACTIVE) } + get velocity() { + const node = getAnimated(this)! + return (node instanceof AnimatedValue + ? node.lastVelocity \|\| 0 + : node.getPayload().map(node => node.lastVelocity \|\| 0)) as Velocity<T> + } + /* Advance the current animation by a number of milliseconds */ advance(dt: number) { let idle = true
build: remove "installDistDeps" step in prepare script	e887c677fe016cdfc134f521d8c3405d2a3ae6de	build	https://github.com/pmndrs/react-spring/commit/e887c677fe016cdfc134f521d8c3405d2a3ae6de	remove "installDistDeps" step in prepare script	[email protected]	diff --git a/prepare.js b/prepare.js index 2e47ace..f67f213 100644 --- a/prepare.js +++ b/prepare.js @@ -75,7 +75,6 @@ async function prepare() { pkg.publishConfig = rootJson.publishConfig setHomepage(pkg) setEntryModules(pkg) - await installDistDeps(pkg) await rewriteLocalDeps(pkg) useOwnFiles(pkg, ['README.md', '@types']) useFiles(pkg, ['LICENSE', '.npmignore']) @@ -102,35 +101,6 @@ async function prepare() { } } - // For manually testing the "dist" directories - const installDistDeps = async pkg => { - const deps = pkg.dependencies - const distDeps = { ...deps } - if (deps) { - for (const [alias, value] of Object.entries(deps)) { - if (value.startsWith('link:')) { - const link = value.slice(5) - const target = resolve(pkg.dir, link) - const { name } = await fs.readJson(join(target, PJ)) - const distLink = relative(pkg.dir, join(target, DIST)) - distDeps[name] = 'link:../' + distLink - delete distDeps[alias] - } - } - pkg.dependencies = distDeps - savePackage(pkg) - } - try { - const cwd = join(pkg.dir, DIST) - await fs.remove(join(cwd, 'node_modules')) - await fs.remove(join(cwd, 'yarn.lock')) - await execa('yarn', ['--prod'], { cwd }) - } finally { - pkg.dependencies = deps - savePackage(pkg) - } - } - // Copy over "postinstall" scripts. const setScript = (pkg, name, script) => { if (!pkg.scripts) pkg.scripts = {}
docs: add missing space in footer	38344faa928fd312a4a03bf7e578b2750bf2d64a	docs	https://github.com/mikro-orm/mikro-orm/commit/38344faa928fd312a4a03bf7e578b2750bf2d64a	add missing space in footer	[email protected]	diff --git a/index.js b/index.js index dd0969d..bcc8941 100644 --- a/index.js +++ b/index.js @@ -134,7 +134,7 @@ function Footer() { )} </div> )} - {copyright} + {copyright}{' '} Icons made by <a href="https://www.flaticon.com/authors/surang" title="surang">surang</a> and <a href="https://www.flaticon.com/authors/skyclick" title="Skyclick">Skyclick</a>. </div> )}
chore(deps): bump ruff to 0.252	d50bec52001dc8218dd22e1058446ae1f0cf8333	chore	https://github.com/ibis-project/ibis/commit/d50bec52001dc8218dd22e1058446ae1f0cf8333	bump ruff to 0.252	[email protected]	diff --git a/poetry.lock b/poetry.lock index 1873a90..fe8a5d4 100644 --- a/poetry.lock +++ b/poetry.lock @@ -4534,29 +4534,29 @@ pyasn1 = ">=0.1.3" [[package]] name = "ruff" -version = "0.0.249" +version = "0.0.252" description = "An extremely fast Python linter, written in Rust." category = "dev" optional = false python-versions = ">=3.7" files = [ - {file = "ruff-0.0.249-py3-none-macosx_10_7_x86_64.whl", hash = "sha256:03a26f1cb5605508de49d921d0970895b9e3ad4021f776a53be18fa95a4fc25b"}, - {file = "ruff-0.0.249-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl", hash = "sha256:46537d960221e97adc6a3556159ab3ae4b722b9985de13c50b436732d4659af0"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6c2dcc1f3053092aeedef8e47704e301b74687fa480fe5e7ebef2b0eb2e4a0bd"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:855cfe47d146a1eb68347025c7b5ad651c083343de6cb7ccf90585bda3e381db"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bf3af16748c8539a48451edbcb687994eccc6a764c95f42de22195007ae13a24"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:2815e05ba168dee6708dbbdab8d0c145bb3b0085c91ee552839c1c18a52f6cb1"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6ab43389216cc8403db84992977e6f5e8fee83bd10aca05e1f2f262754cd8384"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7b67c44ab260d3a838ec237c7234be1098bf2ef1421036fbbb229698513d1fc3"}, - {file = "ruff-0.0.249-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3d859744e1cc95ad5e52c4642509b3abb5ea0833f0529c380c2731b8cab5726"}, - {file = "ruff-0.0.249-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:a6f494276ee281eb09c7026cc17df1bfc2fe59ab39a87196014ce093ff27f1a0"}, - {file = "ruff-0.0.249-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:be23c57b9551d8fcf559755e5bc56ac5bcbc3215fc8a3190ea6ed1bb9133d8dd"}, - {file = "ruff-0.0.249-py3-none-musllinux_1_2_i686.whl", hash = "sha256:980a3bce8ba38c9b47bc000915e80a672add9f7e9c5b128375486ec8cd8f860d"}, - {file = "ruff-0.0.249-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:f1e988e9365b11c6d7796c0d4a0556f6a26f0627fe57e9e7411ff91f421fb502"}, - {file = "ruff-0.0.249-py3-none-win32.whl", hash = "sha256:f4837a7e6d1ff81cb027695deb28793e0945cca8d88e87b46ff845ef38d52c82"}, - {file = "ruff-0.0.249-py3-none-win_amd64.whl", hash = "sha256:4cc437ab55a35088008dbe9db598cd8e240b5f70fb88eb8ab6fa1de529007f30"}, - {file = "ruff-0.0.249-py3-none-win_arm64.whl", hash = "sha256:3d2d11a7b750433f3acec30641faab673d101aa86a2ddfe4af8bcfa773b178e2"}, - {file = "ruff-0.0.249.tar.gz", hash = "sha256:b590689f08ecef971c45555cbda6854cdf48f3828fc326802828e851b1a14b3d"}, + {file = "ruff-0.0.252-py3-none-macosx_10_7_x86_64.whl", hash = "sha256:349367a227c4db7abbc3a9993efea8a608b5bea4bb4a1e5fc6f0d56819524f92"}, + {file = "ruff-0.0.252-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl", hash = "sha256:ce77f9106d96b4faf7865860fb5155b9deaf6f699d9c279118c5ad947739ecaf"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:edadb0b050293b4e60dab979ba6a4e734d9c899cbe316a0ee5b65e3cdd39c750"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:4efdae98937d1e4d23ab0b7fc7e8e6b6836cc7d2d42238ceeacbc793ef780542"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c8546d879f7d3f669379a03e7b103d90e11901976ab508aeda59c03dfd8a359e"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:83fdc7169b6c1fb5fe8d1cdf345697f558c1b433ef97df9ca11defa2a8f3ee9e"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:84ed9be1a17e2a556a571a5b959398633dd10910abd8dcf8b098061e746e892d"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6f5e77bd9ba4438cf2ee32154e2673afe22f538ef29f5d65ca47e3dc46c42cf8"}, + {file = "ruff-0.0.252-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3a5179b94b45c0f8512eaff3ab304c14714a46df2e9ca72a9d96084adc376b71"}, + {file = "ruff-0.0.252-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:92efd8a71157595df5bc46aaaa0613d8a2fbc5cddc53ae7b749c16025c324732"}, + {file = "ruff-0.0.252-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:fd350fc10832cfd28e681d829a8aa83ea3e653326e0ea9d98637dfb8d46177d2"}, + {file = "ruff-0.0.252-py3-none-musllinux_1_2_i686.whl", hash = "sha256:f119240c9631216e846166e06023b1d878e25fbac93bf20da50069e91cfbfaee"}, + {file = "ruff-0.0.252-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:5c5a49f89f5ede93d16eddfeeadd7e5739ec703e8f63ac95eac30236b9e49da3"}, + {file = "ruff-0.0.252-py3-none-win32.whl", hash = "sha256:89a897dc743f2fe063483ea666097e72e848f4bbe40493fe0533e61799959f6e"}, + {file = "ruff-0.0.252-py3-none-win_amd64.whl", hash = "sha256:cdc89ad6ff88519b1fb1816ac82a9ad910762c90ff5fd64dda7691b72d36aff7"}, + {file = "ruff-0.0.252-py3-none-win_arm64.whl", hash = "sha256:4b594a17cf53077165429486650658a0e1b2ac6ab88954f5afd50d2b1b5657a9"}, + {file = "ruff-0.0.252.tar.gz", hash = "sha256:6992611ab7bdbe7204e4831c95ddd3febfeece2e6f5e44bbed044454c7db0f63"}, ] [[package]] diff --git a/requirements.txt b/requirements.txt index f3afc0f..f35ae36 100644 --- a/requirements.txt +++ b/requirements.txt @@ -180,7 +180,7 @@ requests-oauthlib==1.3.1 ; python_version >= "3.8" and python_version < "4.0" requests==2.28.2 ; python_version >= "3.8" and python_version < "4" rich==13.3.1 ; python_version >= "3.8" and python_version < "4.0" rsa==4.9 ; python_version >= "3.8" and python_version < "4" -ruff==0.0.249 ; python_version >= "3.8" and python_version < "4.0" +ruff==0.0.252 ; python_version >= "3.8" and python_version < "4.0" semver==2.13.0 ; python_version >= "3.8" and python_full_version != "3.9.7" and python_version < "4.0" setuptools==67.3.2 ; python_version >= "3.8" and python_version < "4.0" shapely==2.0.1 ; python_version >= "3.8" and python_version < "4.0"
fix(clickhouse): do not render aliases when compiling aggregate expression components	46caf3b877a4c7e0457dd78a1085bfcff082a2d9	fix	https://github.com/rohankumardubey/ibis/commit/46caf3b877a4c7e0457dd78a1085bfcff082a2d9	do not render aliases when compiling aggregate expression components	[email protected]	diff --git a/relations.py b/relations.py index 73e5fa7..2b272ab 100644 --- a/relations.py +++ b/relations.py @@ -72,6 +72,7 @@ def _selection(op: ops.Selection, , table, needs_alias=False, kw): @translate_rel.register(ops.Aggregation) def _aggregation(op: ops.Aggregation, , table, kw): tr_val = partial(translate_val, kw) + tr_val_no_alias = partial(translate_val, render_aliases=False, *kw) by = tuple(map(tr_val, op.by)) metrics = tuple(map(tr_val, op.metrics)) @@ -82,13 +83,13 @@ def _aggregation(op: ops.Aggregation, , table, *kw): sel = sel.group_by(map(str, range(1, len(by) + 1)), dialect="clickhouse") if predicates := op.predicates: - sel = sel.where(map(tr_val, predicates), dialect="clickhouse") + sel = sel.where(map(tr_val_no_alias, predicates), dialect="clickhouse") if having := op.having: - sel = sel.having(map(tr_val, having), dialect="clickhouse") + sel = sel.having(map(tr_val_no_alias, having), dialect="clickhouse") if sort_keys := op.sort_keys: - sel = sel.order_by(map(tr_val, sort_keys), dialect="clickhouse") + sel = sel.order_by(map(tr_val_no_alias, sort_keys), dialect="clickhouse") return sel diff --git a/values.py b/values.py index 4edb13d..c44de7b 100644 --- a/values.py +++ b/values.py @@ -49,9 +49,11 @@ def _column(op, , aliases, _): @translate_val.register(ops.Alias) -def _alias(op, kw): - val = translate_val(op.arg, kw) - return sg.alias(val, op.name, dialect="clickhouse") +def _alias(op, render_aliases: bool = True, kw): + val = translate_val(op.arg, render_aliases=render_aliases, *kw) + if render_aliases: + return sg.alias(val, op.name, dialect="clickhouse") + return val _interval_cast_suffixes = {
docs(config): add notes regarding Redis and multitenancy [finish #ch519] Fixes #2609	0d2ba42c95d4f9860ae64adcdb91a3011e359481	docs	https://github.com/wzhiqing/cube/commit/0d2ba42c95d4f9860ae64adcdb91a3011e359481	add notes regarding Redis and multitenancy [finish #ch519] Fixes #2609	[email protected]	diff --git a/Environment-Variables-Reference.md b/Environment-Variables-Reference.md index d848721..96ad597 100644 --- a/Environment-Variables-Reference.md +++ b/Environment-Variables-Reference.md @@ -32,8 +32,8 @@ options][link-config]. \| `CUBEJS_REDIS_URL` \| The host URL for a Redis server \| A valid Redis host URL \| \| `CUBEJS_REDIS_PASSWORD` \| The password used to connect to the Redis server \| A valid Redis password \| \| `CUBEJS_REDIS_TLS` \| If `true`, then the connection to the Redis server is protected by TLS authentication. Defaults to `false` \| `true`, `false` \| -\| `CUBEJS_REDIS_POOL_MAX` \| The maximum number of connections to keep active in the Redis connection pool. Must be higher than `CUBEJS_REDIS_POOL_MIN`. Defaults to `1000` \| A valid number of connections. \| -\| `CUBEJS_REDIS_POOL_MIN` \| The minimum number of connections to keep active in the Redis connection pool. Must be lower than `CUBEJS_REDIS_POOL_MAX`. Defaults to `2` \| A valid number of connections \| +\| `CUBEJS_REDIS_POOL_MAX` \| The maximum number of connections to keep active in the Redis connection pool for a single `appId` (tenant). Must be higher than `CUBEJS_REDIS_POOL_MIN`. Defaults to `1000` \| A valid number of connections. \| +\| `CUBEJS_REDIS_POOL_MIN` \| The minimum number of connections to keep active in the Redis connection pool for a single `appId` (tenant). Must be lower than `CUBEJS_REDIS_POOL_MAX`. Defaults to `2` \| A valid number of connections \| \| `CUBEJS_REDIS_USE_IOREDIS` \| Use [`ioredis`][gh-ioredis] instead of[ `redis`][gh-node-redis]. Defaults to `false` \| `true`, `false` \| \| `CUBEJS_JWK_URL` \| A valid URL to a JSON Web Key Sets (JWKS) \| `https://<AUTH0-SUBDOMAIN>.auth0.com/.well-known/jwks.json` \| \| `CUBEJS_JWT_KEY` \| The secret key used to sign and verify JWTs. Similar to `CUBEJS_API_SECRET` \| A valid string \| diff --git a/Multitenancy-Setup.md b/Multitenancy-Setup.md index 29a0c17..57589f5 100644 --- a/Multitenancy-Setup.md +++ b/Multitenancy-Setup.md @@ -398,6 +398,13 @@ need to configure [`scheduledRefreshTimeZones`][ref-config-refresh-tz]. \| generate a context without the required input. <!-- prettier-ignore-end --> +## Connecting to Redis + +When configured for multitenancy, Cube.js uses a separate connection pool +for each configured tenant. This means that the `CUBEJS_REDIS_POOL_MIN` and +`CUBEJS_REDIS_POOL_MAX` environment variables specify the minimum and +maximum number of Redis connections per-tenant. + [npm-cubejs-sls-aws]: https://www.npmjs.com/package/@cubejs-backend/serverless-aws [ref-config]: /config
feat(datatypes): add decimal and basic geospatial support to the sqlglot type parser/generator	59783b99d304e5abbcb29484def169fcbb9cba59	feat	https://github.com/ibis-project/ibis/commit/59783b99d304e5abbcb29484def169fcbb9cba59	add decimal and basic geospatial support to the sqlglot type parser/generator	[email protected]	diff --git a/datatypes.py b/datatypes.py index 282a3ba..7845279 100644 --- a/datatypes.py +++ b/datatypes.py @@ -254,6 +254,18 @@ class SqlglotType(TypeMapper): return dt.Decimal(precision, scale, nullable=cls.default_nullable) + @classmethod + def _from_sqlglot_GEOMETRY(cls) -> sge.DataType: + return dt.GeoSpatial(geotype="geometry", nullable=cls.default_nullable) + + @classmethod + def _from_sqlglot_GEOGRAPHY(cls) -> sge.DataType: + return dt.GeoSpatial(geotype="geography", nullable=cls.default_nullable) + + @classmethod + def _from_ibis_Interval(cls, dtype: dt.Interval) -> sge.DataType: + return sge.DataType(this=typecode.INTERVAL) + @classmethod def _from_ibis_Array(cls, dtype: dt.Array) -> sge.DataType: value_type = cls.from_ibis(dtype.value_type) @@ -277,11 +289,17 @@ class SqlglotType(TypeMapper): @classmethod def _from_ibis_Decimal(cls, dtype: dt.Decimal) -> sge.DataType: + if (precision := dtype.precision) is None: + precision = cls.default_decimal_precision + + if (scale := dtype.scale) is None: + scale = cls.default_decimal_scale + return sge.DataType( this=typecode.DECIMAL, expressions=[ - sge.DataTypeParam(this=sge.Literal.number(dtype.precision)), - sge.DataTypeParam(this=sge.Literal.number(dtype.scale)), + sge.DataTypeParam(this=sge.Literal.number(precision)), + sge.DataTypeParam(this=sge.Literal.number(scale)), ], ) @@ -294,6 +312,20 @@ class SqlglotType(TypeMapper): else: return sge.DataType(this=code) + @classmethod + def _from_ibis_GeoSpatial(cls, dtype: dt.GeoSpatial): + if (geotype := dtype.geotype) is not None: + return sge.DataType(this=getattr(typecode, geotype.upper())) + return sge.DataType(this=typecode.GEOMETRY) + + _from_ibis_Point = ( + _from_ibis_LineString + ) = ( + _from_ibis_Polygon + ) = ( + _from_ibis_MultiLineString + ) = _from_ibis_MultiPoint = _from_ibis_MultiPolygon = _from_ibis_GeoSpatial + class PostgresType(SqlglotType): dialect = "postgres" diff --git a/test_datatypes.py b/test_datatypes.py index 5b3ed12..5b15b6a 100644 --- a/test_datatypes.py +++ b/test_datatypes.py @@ -39,6 +39,9 @@ roundtripable_types = st.deferred( \| its.array_dtypes(roundtripable_types, nullable=true) \| its.map_dtypes(roundtripable_types, roundtripable_types, nullable=true) \| its.struct_dtypes(roundtripable_types, nullable=true) + \| its.geometry_dtypes(nullable=true) + \| its.geography_dtypes(nullable=true) + \| its.decimal_dtypes(nullable=true) ) ) @@ -51,3 +54,13 @@ roundtripable_types = st.deferred( @h.given(roundtripable_types) def test_roundtripable_types(ibis_type): assert_dtype_roundtrip(ibis_type) + + [email protected](its.specific_geometry_dtypes(nullable=true)) +def test_specific_geometry_types(ibis_type): + sqlglot_result = SqlglotType.from_ibis(ibis_type) + assert isinstance(sqlglot_result, sge.DataType) + assert sqlglot_result == sge.DataType(this=sge.DataType.Type.GEOMETRY) + assert SqlglotType.to_ibis(sqlglot_result) == dt.GeoSpatial( + geotype="geometry", nullable=ibis_type.nullable + ) diff --git a/strategies.py b/strategies.py index 054e8a5..62cf6ee 100644 --- a/strategies.py +++ b/strategies.py @@ -186,7 +186,7 @@ def geography_dtypes(nullable=_nullable): return st.builds(dt.GeoSpatial, geotype=st.just("geography"), nullable=nullable) -def geospatial_dtypes(nullable=_nullable): +def specific_geometry_dtypes(nullable=_nullable): return st.one_of( st.builds(dt.Point, nullable=nullable), st.builds(dt.LineString, nullable=nullable), @@ -194,6 +194,12 @@ def geospatial_dtypes(nullable=_nullable): st.builds(dt.MultiPoint, nullable=nullable), st.builds(dt.MultiLineString, nullable=nullable), st.builds(dt.MultiPolygon, nullable=nullable), + ) + + +def geospatial_dtypes(nullable=_nullable): + return st.one_of( + specific_geometry_dtypes(nullable=nullable), geometry_dtypes(nullable=nullable), geography_dtypes(nullable=nullable), )
docs: fix incorrect -f argument for conda dev environment setup	a4a1572622c5766ce5ddb151be1b6fa16f2be341	docs	https://github.com/ibis-project/ibis/commit/a4a1572622c5766ce5ddb151be1b6fa16f2be341	fix incorrect -f argument for conda dev environment setup	[email protected]	diff --git a/environment.md b/environment.md index 500af2d..c565f85 100644 --- a/environment.md +++ b/environment.md @@ -75,10 +75,15 @@ There are two primary ways to setup a development environment. 1. Create a Conda environment from a lock file in the repo: - ```sh - cd ibis - conda create -n ibis-dev -f conda-lock/<platform-64-pyver>.lock - ``` + {% set platforms = {"Linux": "linux", "MacOS": "osx", "Windows": "win"} %} + {% for os, platform in platforms.items() %} + === "{{ os }}" + + ```sh + cd ibis + conda create -n ibis-dev --file=conda-lock/{{ platform }}-64-3.9.lock + ``` + {% endfor %} 1. Activate the environment
chore(deps): add `sqlalchemy-views` to `all` extra	5d1e3c208bb9b17ae574ef7ddb5587f1270d95a7	chore	https://github.com/rohankumardubey/ibis/commit/5d1e3c208bb9b17ae574ef7ddb5587f1270d95a7	add `sqlalchemy-views` to `all` extra	[email protected]	diff --git a/check-generated-files.yml b/check-generated-files.yml index d594847..91f5253 100644 --- a/check-generated-files.yml +++ b/check-generated-files.yml @@ -45,6 +45,21 @@ jobs: - name: check consistency with pyproject.toml run: poetry lock --check + - name: check that the `all` extra matches the current lock file + run: \| + set -euo pipefail + + js="$(mktemp --suffix=.pyproject.json)" + docker run --rm -i sclevine/yj -tj < pyproject.toml > "$js" + + old="$(mktemp --suffix=.old)" + jq -rM '.tool.poetry.extras.all \| unique \| sort' < "$js" > "$old" + + new="$(mktemp --suffix=.new)" + jq -rM '.tool.poetry.extras \| with_entries(select(.key != "all")) \| [.[]] \| add \| unique \| sort' < "$js" > "$new" + + diff --unified "$old" "$new" + - name: generate requirements.txt run: poetry export --extras all --with dev --with test --with docs --without-hashes --no-ansi > requirements.txt diff --git a/poetry.lock b/poetry.lock index d0e51f0..d87bba7 100644 --- a/poetry.lock +++ b/poetry.lock @@ -5268,7 +5268,7 @@ docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"] [extras] -all = ["black", "clickhouse-cityhash", "clickhouse-driver", "dask", "datafusion", "db-dtypes", "duckdb", "duckdb-engine", "fsspec", "GeoAlchemy2", "geopandas", "google-cloud-bigquery", "google-cloud-bigquery-storage", "graphviz", "impyla", "lz4", "polars", "psycopg2", "pyarrow", "pydata-google-auth", "pymssql", "pymysql", "pyspark", "regex", "requests", "shapely", "snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy", "trino"] +all = ["black", "clickhouse-cityhash", "clickhouse-driver", "dask", "datafusion", "db-dtypes", "duckdb", "duckdb-engine", "fsspec", "GeoAlchemy2", "geopandas", "google-cloud-bigquery", "google-cloud-bigquery-storage", "graphviz", "impyla", "lz4", "polars", "psycopg2", "pyarrow", "pydata-google-auth", "pymssql", "pymysql", "pyspark", "regex", "requests", "shapely", "snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy", "sqlalchemy-views", "trino"] bigquery = ["db-dtypes", "google-cloud-bigquery", "google-cloud-bigquery-storage", "pydata-google-auth"] clickhouse = ["clickhouse-driver", "clickhouse-cityhash", "lz4"] dask = ["dask", "pyarrow", "regex"] @@ -5291,4 +5291,4 @@ visualization = ["graphviz"] [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "d2abc3f09e8127a2a9362540fcdd73214f809aa5b09a045ca226407124084e1c" +content-hash = "a77a9e13988746750bba0bf92d3366bd2027f6cdec318f62331fbd05e43c1eee" diff --git a/pyproject.toml b/pyproject.toml index a155a23..d54e956 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -159,6 +159,7 @@ all = [ "snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy", + "sqlalchemy-views", "trino" ] bigquery = [ diff --git a/requirements.txt b/requirements.txt index c39c843..fe7cb58 100644 --- a/requirements.txt +++ b/requirements.txt @@ -190,6 +190,7 @@ snowflake-connector-python[pandas]==2.9.0 ; python_version >= "3.8" and python_v snowflake-sqlalchemy[pandas]==1.4.4 ; python_version >= "3.8" and python_version < "4.0" sortedcontainers==2.4.0 ; python_version >= "3.8" and python_version < "4.0" soupsieve==2.3.2.post1 ; python_version >= "3.8" and python_version < "4" +sqlalchemy-views==0.3.1 ; python_version >= "3.8" and python_version < "4.0" sqlalchemy==1.4.46 ; python_version >= "3.8" and python_version < "4.0" sqlglot==10.5.6 ; python_version >= "3.8" and python_version < "4.0" stack-data==0.6.2 ; python_version >= "3.8" and python_version < "4.0"
refactor(postgres): remove special random function	b9cbf5304f4ccae02d4c2ec1fc636d3626998518	refactor	https://github.com/rohankumardubey/ibis/commit/b9cbf5304f4ccae02d4c2ec1fc636d3626998518	remove special random function	[email protected]	diff --git a/registry.py b/registry.py index 25709e3..6c4c64f 100644 --- a/registry.py +++ b/registry.py @@ -606,10 +606,6 @@ def _literal(_, expr): return sa.literal(value) -def _random(t, expr): - return sa.func.random() - - def _day_of_week_index(t, expr): (sa_arg,) = map(t.translate, expr.op().args) return sa.cast( @@ -687,7 +683,7 @@ operation_registry.update( ops.ExtractMillisecond: _millisecond, ops.DayOfWeekIndex: _day_of_week_index, ops.DayOfWeekName: _day_of_week_name, - ops.RandomScalar: _random, + ops.RandomScalar: fixed_arity(sa.func.random, 0), # now is in the timezone of the server, but we want UTC ops.TimestampNow: lambda *_: sa.func.timezone('UTC', sa.func.now()), ops.TimeFromHMS: fixed_arity(sa.func.make_time, 3),
build: move molc to a separate repository	b14a00c7bb5b24328035d97c064be9b3367d979d	build	https://github.com/erg-lang/erg/commit/b14a00c7bb5b24328035d97c064be9b3367d979d	move molc to a separate repository	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 81095e6..02f0628 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -248,6 +248,8 @@ dependencies = [ [[package]] name = "molc" version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a19b669aab31ca7552fc43cb9ab08e325113aa090f7bf97a2112b3d6241ba898" dependencies = [ "lsp-types", "serde", diff --git a/Cargo.toml b/Cargo.toml index fbd9010..e703bf7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,19 +0,0 @@ -[package] -name = "molc" -version = "0.1.0" -description = "A mock language client for testing language servers" -authors.workspace = true -license.workspace = true -edition.workspace = true -repository.workspace = true -homepage.workspace = true - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - -[dependencies] -serde = { version = "1.0", features = ["derive"] } -serde_json = "1.0.85" -lsp-types = { version = "0.93.2", features = ["proposed"] } - -[path] -lib = "src/lib.rs" diff --git a/README.md b/README.md index 948fc61..cc37704 100644 --- a/README.md +++ b/README.md @@ -1,69 +0,0 @@ -# `molc` - -`molc` is a mock (fake) language client for testing language servers. - -## Usage - -You can see specific examples of molc use in [ELS](https://github.com/erg-lang/erg/tree/main/crates/els). - -```rust -use lsp_types::{Url, Value}; - -use molc::{FakeClient, LangServer, RedirectableStdout}; -use molc::oneline_range; - -pub struct Server { - stdout_redirect: Option<std::sync::mpsc::Sender<Value>>, - ... -} - -impl LangServer for Server { - fn dispatch(&mut self, msg: impl Into<Value>) -> Result<(), Box<dyn std::error::Error>> { - self.dispatch(msg) - } -} - -impl RedirectableStdout for Server { - fn sender(&self) -> Option<&std::sync::mpsc::Sender<Value>> { - self.stdout_redirect.as_ref() - } -} - -impl Server { - fn bind_fake_client() -> FakeClient<Self> { - // The server should send responses to this channel at least during testing. - let (sender, receiver) = std::sync::mpsc::channel(); - DummyClient::new( - Server::new(Some(sender)), - receiver, - ) - } - - fn init(&mut self, msg: &Value, id: i64) -> ELSResult<()> { - self.send_log("initializing the language server")?; - let result = InitializeResult { - ... - }; - self.init_services(); - self.send_stdout(&json!({ - "jsonrpc": "2.0", - "id": id, - "result": result, - })) - } - - ... -} - -#[test] -fn test_references() -> Result<(), Box<dyn std::error::Error>> { - let mut client = Server::bind_fake_client(); - client.request_initialize()?; - let uri = Url::from_file_path(Path::new(FILE_A).canonicalize()?).unwrap(); - client.notify_open(FILE_A)?; - let locations = client.request_references(uri, 1, 4)?.unwrap(); - assert_eq!(locations.len(), 1); - assert_eq!(&locations[0].range, &oneline_range(1, 4, 5)); - Ok(()) -} -``` diff --git a/lib.rs b/lib.rs index 823efd8..fb61734 100644 --- a/lib.rs +++ b/lib.rs @@ -1,466 +0,0 @@ -pub mod messages; - -use std::fs::File; -use std::io::{stdout, Read, Write}; -use std::path::Path; -use std::{collections::HashMap, sync::mpsc::Sender}; - -use lsp_types::{ - CompletionContext, CompletionParams, CompletionResponse, CompletionTriggerKind, - DidChangeTextDocumentParams, DidOpenTextDocumentParams, DocumentSymbolParams, - DocumentSymbolResponse, FoldingRange, FoldingRangeParams, GotoDefinitionParams, - GotoDefinitionResponse, Hover, HoverParams, InitializeResult, Location, Position, Range, - ReferenceContext, ReferenceParams, RenameParams, ServerCapabilities, SignatureHelp, - SignatureHelpContext, SignatureHelpParams, SignatureHelpTriggerKind, - TextDocumentContentChangeEvent, TextDocumentIdentifier, TextDocumentItem, - TextDocumentPositionParams, Url, VersionedTextDocumentIdentifier, WorkspaceEdit, -}; -use serde::de::Deserialize; -use serde::Serialize; -use serde_json::{json, Value}; - -use crate::messages::{ErrorMessage, LogMessage, ShowMessage}; - -fn safe_yield() { - std::thread::yield_now(); - std::thread::sleep(std::time::Duration::from_millis(10)); -} - -pub fn add_char(line: u32, character: u32, text: &str) -> TextDocumentContentChangeEvent { - TextDocumentContentChangeEvent { - range: Some(Range { - start: Position { line, character }, - end: Position { line, character }, - }), - range_length: None, - text: text.to_string(), - } -} - -pub fn abs_pos(uri: Url, line: u32, col: u32) -> TextDocumentPositionParams { - TextDocumentPositionParams { - text_document: TextDocumentIdentifier::new(uri), - position: Position { - line, - character: col, - }, - } -} - -pub fn oneline_range(line: u32, from: u32, to: u32) -> Range { - Range { - start: Position { - line, - character: from, - }, - end: Position { - line, - character: to, - }, - } -} - -pub fn parse_msgs(_input: &str) -> Vec<Value> { - let mut input = _input; - let mut msgs = Vec::new(); - loop { - if input.starts_with("Content-Length: ") { - let idx = "Content-Length: ".len(); - input = &input[idx..]; - } else { - break; - } - let dights = input.find("\\r\\n").unwrap(); - let len = input[..dights].parse::<usize>().unwrap(); - let idx = dights + "\\r\\n\\r\\n".len(); - input = &input[idx..]; - let msg = &input - .get(..len) - .unwrap_or_else(\|\| panic!("len: {len}, input: `{input}` -> _input: `{_input}`")); - input = &input[len..]; - msgs.push(serde_json::from_str(msg).unwrap()); - } - msgs -} - -pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>; - -pub trait RedirectableStdout { - fn sender(&self) -> Option<&Sender<Value>>; - - fn send_stdout<T: ?Sized + Serialize>(&self, message: &T) -> Result<()> { - if let Some(sender) = self.sender() { - sender.send(serde_json::to_value(message)?)?; - } else { - let msg = serde_json::to_string(message)?; - let mut stdout = stdout().lock(); - write!(stdout, "Content-Length: {}\\r\\n\\r\\n{}", msg.len(), msg)?; - stdout.flush()?; - } - Ok(()) - } - - fn send_log<S: Into<String>>(&self, msg: S) -> Result<()> { - if cfg!(debug_assertions) \|\| cfg!(feature = "debug") { - self.send_stdout(&LogMessage::new(msg)) - } else { - Ok(()) - } - } - - #[allow(unused)] - fn send_info<S: Into<String>>(&self, msg: S) -> Result<()> { - self.send_stdout(&ShowMessage::info(msg)) - } - - fn send_error_info<S: Into<String>>(&self, msg: S) -> Result<()> { - self.send_stdout(&ShowMessage::error(msg)) - } - - fn send_error<S: Into<String>>(&self, id: Option<i64>, code: i64, msg: S) -> Result<()> { - self.send_stdout(&ErrorMessage::new( - id, - json!({ "code": code, "message": msg.into() }), - )) - } - - fn send_invalid_req_error(&self) -> Result<()> { - self.send_error(None, -32601, "received an invalid request") - } -} - -pub trait LangServer { - fn dispatch(&mut self, msg: impl Into<Value>) -> Result<()>; -} - -pub struct FakeClient<LS: LangServer> { - server: LS, - receiver: std::sync::mpsc::Receiver<Value>, - server_capas: Option<ServerCapabilities>, - pub responses: Vec<Value>, - #[allow(clippy::complexity)] - request_handlers: HashMap<String, Box<dyn Fn(&Value, &mut LS) -> Result<()>>>, - ver: i32, - req_id: i64, -} - -impl<LS: LangServer> FakeClient<LS> { - /// The server should send responses to the channel at least during testing. - pub fn new(server: LS, receiver: std::sync::mpsc::Receiver<Value>) -> Self { - FakeClient { - receiver, - responses: Vec::new(), - ver: 0, - req_id: 0, - server_capas: None, - request_handlers: HashMap::new(), - server, - } - } - - pub fn add_request_handler( - &mut self, - method_name: impl Into<String>, - handler: impl Fn(&Value, &mut LS) -> Result<()> + 'static, - ) { - self.request_handlers - .insert(method_name.into(), Box::new(handler)); - } - - pub fn remove_request_handler(&mut self, method_name: &str) { - self.request_handlers.remove(method_name); - } - - /// Waits for `n` messages to be received. - /// When a request is received, the registered handler will be executed. - pub fn wait_messages(&mut self, n: usize) -> Result<()> { - for _ in 0..n { - if let Ok(msg) = self.receiver.recv() { - if msg.get("method").is_some_and(\|_\| msg.get("id").is_some()) { - self.handle_server_request(&msg); - } - self.responses.push(msg); - } - } - Ok(()) - } - - /// Waits for a response to the request, where its `id` is expected to be that of `req_id`, - /// and `req_id` will be incremented if the response is successfully received. - /// When a request is received, the registered handler will be executed. - fn wait_for<R>(&mut self) -> Result<R> - where - R: Deserialize<'static>, - { - loop { - if let Ok(msg) = self.receiver.recv() { - if msg.get("method").is_some_and(\|_\| msg.get("id").is_some()) { - self.handle_server_request(&msg); - } - self.responses.push(msg); - let msg = self.responses.last().unwrap(); - if msg.get("id").is_some_and(\|val\| val == self.req_id) { - if let Some(result) = msg - .get("result") - .cloned() - .and_then(\|res\| R::deserialize(res).ok()) - { - self.req_id += 1; - return Ok(result); - } - } - } - safe_yield(); - } - } - - fn handle_server_request(&mut self, msg: &Value) { - if let Some(method) = msg.get("method").and_then(\|val\| val.as_str()) { - if let Some(handler) = self.request_handlers.get(method) { - if let Err(err) = handler(msg, &mut self.server) { - eprintln!("error: {:?}", err); - } - } - } - } - - /// This will set the server capabilities - pub fn request_initialize(&mut self) -> Result<InitializeResult> { - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "initialize", - }); - self.server.dispatch(msg)?; - let res = self.wait_for::<InitializeResult>()?; - self.server_capas = Some(res.capabilities.clone()); - Ok(res) - } - - pub fn notify_open(&mut self, file: &str) -> Result<()> { - let uri = Url::from_file_path(Path::new(file).canonicalize().unwrap()).unwrap(); - let mut text = String::new(); - File::open(file).unwrap().read_to_string(&mut text)?; - let params = DidOpenTextDocumentParams { - text_document: TextDocumentItem::new(uri, "erg".to_string(), self.ver, text), - }; - self.ver += 1; - let msg = json!({ - "jsonrpc": "2.0", - "method": "textDocument/didOpen", - "params": params, - }); - self.server.dispatch(msg)?; - Ok(()) - } - - pub fn notify_change( - &mut self, - uri: Url, - change: TextDocumentContentChangeEvent, - ) -> Result<()> { - let params = DidChangeTextDocumentParams { - text_document: VersionedTextDocumentIdentifier::new(uri.clone(), self.ver), - content_changes: vec![change], - }; - self.ver += 1; - let msg = json!({ - "jsonrpc": "2.0", - "method": "textDocument/didChange", - "params": params, - }); - self.server.dispatch(msg)?; - Ok(()) - } - - fn is_trigger_char(&self, character: &str) -> bool { - self.server_capas.as_ref().is_some_and(\|cap\| { - cap.completion_provider.as_ref().is_some_and(\|comp\| { - comp.trigger_characters - .as_ref() - .is_some_and(\|chars\| chars.iter().any(\|c\| c == character)) - }) - }) - } - - pub fn request_completion( - &mut self, - uri: Url, - line: u32, - col: u32, - character: &str, - ) -> Result<Option<CompletionResponse>> { - let text_document_position = abs_pos(uri, line, col); - let trigger_kind = if self.is_trigger_char(character) { - CompletionTriggerKind::TRIGGER_CHARACTER - } else { - CompletionTriggerKind::INVOKED - }; - let trigger_character = self - .is_trigger_char(character) - .then_some(character.to_string()); - let context = Some(CompletionContext { - trigger_kind, - trigger_character, - }); - let params = CompletionParams { - text_document_position, - context, - work_done_progress_params: Default::default(), - partial_result_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/completion", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<CompletionResponse>>() - } - - pub fn request_rename( - &mut self, - uri: Url, - line: u32, - col: u32, - new_name: &str, - ) -> Result<Option<WorkspaceEdit>> { - let text_document_position = abs_pos(uri, line, col); - let params = RenameParams { - text_document_position, - new_name: new_name.to_string(), - work_done_progress_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/rename", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<WorkspaceEdit>>() - } - - pub fn request_signature_help( - &mut self, - uri: Url, - line: u32, - col: u32, - character: &str, - ) -> Result<Option<SignatureHelp>> { - let text_document_position_params = abs_pos(uri, line, col); - let context = SignatureHelpContext { - trigger_kind: SignatureHelpTriggerKind::TRIGGER_CHARACTER, - trigger_character: Some(character.to_string()), - is_retrigger: false, - active_signature_help: None, - }; - let params = SignatureHelpParams { - text_document_position_params, - context: Some(context), - work_done_progress_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/signatureHelp", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<SignatureHelp>>() - } - - pub fn request_hover(&mut self, uri: Url, line: u32, col: u32) -> Result<Option<Hover>> { - let params = HoverParams { - text_document_position_params: abs_pos(uri, line, col), - work_done_progress_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/hover", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<Hover>>() - } - - pub fn request_references( - &mut self, - uri: Url, - line: u32, - col: u32, - ) -> Result<Option<Vec<Location>>> { - let context = ReferenceContext { - include_declaration: false, - }; - let params = ReferenceParams { - text_document_position: abs_pos(uri, line, col), - context, - work_done_progress_params: Default::default(), - partial_result_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/references", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<Vec<Location>>>() - } - - pub fn request_goto_definition( - &mut self, - uri: Url, - line: u32, - col: u32, - ) -> Result<Option<GotoDefinitionResponse>> { - let params = GotoDefinitionParams { - text_document_position_params: abs_pos(uri, line, col), - work_done_progress_params: Default::default(), - partial_result_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/definition", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<GotoDefinitionResponse>>() - } - - pub fn request_folding_range(&mut self, uri: Url) -> Result<Option<Vec<FoldingRange>>> { - let params = FoldingRangeParams { - text_document: TextDocumentIdentifier::new(uri), - work_done_progress_params: Default::default(), - partial_result_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/foldingRange", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<Vec<FoldingRange>>>() - } - - pub fn request_document_symbols(&mut self, uri: Url) -> Result<Option<DocumentSymbolResponse>> { - let params = DocumentSymbolParams { - text_document: TextDocumentIdentifier::new(uri), - work_done_progress_params: Default::default(), - partial_result_params: Default::default(), - }; - let msg = json!({ - "jsonrpc": "2.0", - "id": self.req_id, - "method": "textDocument/documentSymbol", - "params": params, - }); - self.server.dispatch(msg)?; - self.wait_for::<Option<DocumentSymbolResponse>>() - } -} diff --git a/messages.rs b/messages.rs index 722e072..5932ad6 100644 --- a/messages.rs +++ b/messages.rs @@ -1,79 +0,0 @@ -use serde::{Deserialize, Serialize}; -use serde_json::json; -use serde_json::{Number, Value}; - -#[derive(Debug, Serialize, Deserialize)] -pub struct ErrorMessage { - jsonrpc: String, - id: Option<Number>, - error: Value, -} - -impl ErrorMessage { - #[allow(dead_code)] - pub fn new<N: Into<Number>>(id: Option<N>, error: Value) -> Self { - Self { - jsonrpc: "2.0".into(), - id: id.map(\|i\| i.into()), - error, - } - } -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct LogMessage { - jsonrpc: String, - method: String, - params: Value, -} - -impl LogMessage { - pub fn new<S: Into<String>>(message: S) -> Self { - Self { - jsonrpc: "2.0".into(), - method: "window/logMessage".into(), - params: json! { - { - "type": 3, - "message": message.into(), - } - }, - } - } -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct ShowMessage { - jsonrpc: String, - method: String, - params: Value, -} - -impl ShowMessage { - #[allow(unused)] - pub fn info<S: Into<String>>(message: S) -> Self { - Self { - jsonrpc: "2.0".into(), - method: "window/showMessage".into(), - params: json! { - { - "type": 3, - "message": message.into(), - } - }, - } - } - - pub fn error<S: Into<String>>(message: S) -> Self { - Self { - jsonrpc: "2.0".into(), - method: "window/showMessage".into(), - params: json! { - { - "type": 1, - "message": message.into(), - } - }, - } - } -}
chore: change `apifytech` to `apify` in changelog This is just to trigger docker image builds.	5ca0747ca34591db47392b297bc07dcacb810bf3	chore	https://github.com/Hardeepex/crawlee/commit/5ca0747ca34591db47392b297bc07dcacb810bf3	change `apifytech` to `apify` in changelog This is just to trigger docker image builds.	[email protected]	diff --git a/CHANGELOG.md b/CHANGELOG.md index f48cd0d..2808da7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -484,7 +484,7 @@ We fixed some bugs, improved a few things and bumped Puppeteer to match latest C 0.21.0 / 2020/06/06 ==================== This release comes with breaking changes that will affect most, -if not all of your projects. See the [migration guide](https://github.com/apifytech/apify-js/blob/master/MIGRATIONS.md) +if not all of your projects. See the [migration guide](https://github.com/apify/apify-js/blob/master/MIGRATIONS.md) for more information and examples. First large change is a redesigned proxy configuration. `Cheerio` and `Puppeteer` crawlers @@ -675,7 +675,7 @@ There are new options `body` and `contentType` in `handlePageFunction` for this ==================== - `Apify.launchPuppeteer()` now accepts `proxyUrl` with the `https`, `socks4` and `socks5` schemes, as long as it doesn't contain username or password. - This is to fix [Issue #420](https://github.com/apifytech/apify-js/issues/420). + This is to fix [Issue #420](https://github.com/apify/apify-js/issues/420). - Added `desiredConcurrency` option to `AutoscaledPool` constructor, removed unnecessary bound check from the setter property
docs: ship v4.5 of docs	fd68bb3fec2129298c5749cde19169f48905b6eb	docs	https://github.com/mikro-orm/mikro-orm/commit/fd68bb3fec2129298c5749cde19169f48905b6eb	ship v4.5 of docs	[email protected]	diff --git a/core.configuration.md b/core.configuration.md index c5ad1f5..8763257 100644 --- a/core.configuration.md +++ b/core.configuration.md @@ -0,0 +1,439 @@ +--- +id: "core.configuration" +title: "Class: Configuration<D>" +sidebar_label: "Configuration" +custom_edit_url: null +hide_title: true +--- + +# Class: Configuration<D\\> + +[core](../modules/core.md).Configuration + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| + +## Constructors + +### constructor + +\\+ new Configuration<D\\>(`options`: [Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `validate?`: boolean): [Configuration](core.configuration.md)<D\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`options` \| [Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| - \| +`validate` \| boolean \| true \| + +Returns: [Configuration](core.configuration.md)<D\\> + +Defined in: [packages/core/src/utils/Configuration.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L98) + +## Properties + +### cache + +• `Private` `Readonly` cache: [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/utils/Configuration.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L98) + +___ + +### driver + +• `Private` `Readonly` driver: D + +Defined in: [packages/core/src/utils/Configuration.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L96) + +___ + +### logger + +• `Private` `Readonly` logger: [Logger](core.logger.md) + +Defined in: [packages/core/src/utils/Configuration.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L95) + +___ + +### options + +• `Private` `Readonly` options: [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> + +Defined in: [packages/core/src/utils/Configuration.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L94) + +___ + +### platform + +• `Private` `Readonly` platform: [Platform](core.platform.md) + +Defined in: [packages/core/src/utils/Configuration.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L97) + +___ + +### DEFAULTS + +▪ `Readonly` `Static` DEFAULTS: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`autoJoinOneToOneOwner` \| boolean \| +`baseDir` \| string \| +`batchSize` \| number \| +`cache` \| object \| +`cache.adapter` \| typeof [FileCacheAdapter](core.filecacheadapter.md) \| +`cache.options` \| object \| +`cache.options.cacheDir` \| string \| +`cache.pretty` \| boolean \| +`context` \| (`name`: string) => undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| +`contextName` \| string \| +`debug` \| boolean \| +`discovery` \| object \| +`discovery.alwaysAnalyseProperties` \| boolean \| +`discovery.disableDynamicFileAccess` \| boolean \| +`discovery.requireEntitiesArray` \| boolean \| +`discovery.warnWhenNoEntities` \| boolean \| +`driverOptions` \| object \| +`ensureIndexes` \| boolean \| +`entities` \| never[] \| +`entitiesTs` \| never[] \| +`filters` \| object \| +`findOneOrFailHandler` \| (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>) => [NotFoundError](core.notfounderror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`forceEntityConstructor` \| boolean \| +`forceUndefined` \| boolean \| +`forceUtcTimezone` \| boolean \| +`highlighter` \| [NullHighlighter](core.nullhighlighter.md) \| +`hydrator` \| typeof [ObjectHydrator](core.objecthydrator.md) \| +`loadStrategy` \| [LoadStrategy](../enums/core.loadstrategy.md) \| +`logger` \| (...`data`: any[]) => void(`message?`: any, ...`optionalParams`: any[]) => void \| +`metadataProvider` \| typeof [ReflectMetadataProvider](core.reflectmetadataprovider.md) \| +`migrations` \| object \| +`migrations.allOrNothing` \| boolean \| +`migrations.disableForeignKeys` \| boolean \| +`migrations.dropTables` \| boolean \| +`migrations.emit` \| string \| +`migrations.fileName` \| (`timestamp`: string) => string \| +`migrations.path` \| string \| +`migrations.pattern` \| RegExp \| +`migrations.safe` \| boolean \| +`migrations.tableName` \| string \| +`migrations.transactional` \| boolean \| +`pool` \| object \| +`populateAfterFlush` \| boolean \| +`propagateToOneOwner` \| boolean \| +`resultCache` \| object \| +`resultCache.adapter` \| typeof [MemoryCacheAdapter](core.memorycacheadapter.md) \| +`resultCache.expiration` \| number \| +`resultCache.options` \| object \| +`strict` \| boolean \| +`subscribers` \| never[] \| +`validate` \| boolean \| +`verbose` \| boolean \| + +Defined in: [packages/core/src/utils/Configuration.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L27) + +___ + +### PLATFORMS + +▪ `Readonly` `Static` PLATFORMS: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`mariadb` \| object \| +`mariadb.className` \| string \| +`mariadb.module` \| () => any \| +`mongo` \| object \| +`mongo.className` \| string \| +`mongo.module` \| () => any \| +`mysql` \| object \| +`mysql.className` \| string \| +`mysql.module` \| () => any \| +`postgresql` \| object \| +`postgresql.className` \| string \| +`postgresql.module` \| () => any \| +`sqlite` \| object \| +`sqlite.className` \| string \| +`sqlite.module` \| () => any \| + +Defined in: [packages/core/src/utils/Configuration.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L86) + +## Methods + +### cached + +▸ `Private`cached<T\\>(`cls`: T, ...`args`: ConstructorParameters<T\\>): InstanceType<T\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| (...`args`: any[]) => InstanceType<T\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`cls` \| T \| +`...args` \| ConstructorParameters<T\\> \| + +Returns: InstanceType<T\\> + +Defined in: [packages/core/src/utils/Configuration.ts:277](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L277) + +___ + +### get + +▸ get<T, U\\>(`key`: T, `defaultValue?`: U): U + +Gets specific configuration option. Falls back to specified `defaultValue` if provided. + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| keyof [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> \| +`U` \| undefined \\\| string \\\| number \\\| boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \\\| [Highlighter](../interfaces/core.highlighter.md) \\\| () => [NamingStrategy](../interfaces/core.namingstrategy.md) \\\| [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> \\\| Partial<[ConnectionOptions](../interfaces/core.connectionoptions.md)\\>[] \\\| (string \\\| EntityClass<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| EntityClassGroup<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntitySchema](core.entityschema.md)<any, undefined\\>)[] \\\| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[] \\\| [Dictionary](../modules/core.md#dictionary)<{ `name?`: string } & Omit<FilterDef<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, name\\>\\> \\\| { `alwaysAnalyseProperties?`: boolean ; `disableDynamicFileAccess?`: boolean ; `requireEntitiesArray?`: boolean ; `warnWhenNoEntities?`: boolean } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => D \\\| (string \\\| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \\\| HydratorConstructor \\\| (`name`: string) => undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| (`message`: string) => void \\\| (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>) => Error \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] \\\| [MigrationsOptions](../modules/core.md#migrationsoptions) \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `enabled?`: boolean ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `pretty?`: boolean } \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `expiration?`: number ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => [MetadataProvider](core.metadataprovider.md) \\\| [PoolConfig](../interfaces/core.poolconfig.md) \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| T \| +`defaultValue?` \| U \| + +Returns: U + +Defined in: [packages/core/src/utils/Configuration.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L118) + +___ + +### getAll + +▸ getAll(): [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> + +Returns: [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> + +Defined in: [packages/core/src/utils/Configuration.ts:122](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L122) + +___ + +### getCacheAdapter + +▸ getCacheAdapter(): [CacheAdapter](../interfaces/core.cacheadapter.md) + +Gets instance of CacheAdapter. (cached) + +Returns: [CacheAdapter](../interfaces/core.cacheadapter.md) + +Defined in: [packages/core/src/utils/Configuration.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L189) + +___ + +### getClientUrl + +▸ getClientUrl(`hidePassword?`: boolean): string + +Gets current client URL (connection string). + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`hidePassword` \| boolean \| false \| + +Returns: string + +Defined in: [packages/core/src/utils/Configuration.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L150) + +___ + +### getDriver + +▸ getDriver(): D + +Gets current database driver instance. + +Returns: D + +Defined in: [packages/core/src/utils/Configuration.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L161) + +___ + +### getHydrator + +▸ getHydrator(`metadata`: [MetadataStorage](core.metadatastorage.md)): IHydrator + +Gets instance of Hydrator. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`metadata` \| [MetadataStorage](core.metadatastorage.md) \| + +Returns: IHydrator + +Defined in: [packages/core/src/utils/Configuration.ts:175](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L175) + +___ + +### getLogger + +▸ getLogger(): [Logger](core.logger.md) + +Gets Logger instance. + +Returns: [Logger](core.logger.md) + +Defined in: [packages/core/src/utils/Configuration.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L143) + +___ + +### getMetadataProvider + +▸ getMetadataProvider(): [MetadataProvider](core.metadataprovider.md) + +Gets instance of MetadataProvider. (cached) + +Returns: [MetadataProvider](core.metadataprovider.md) + +Defined in: [packages/core/src/utils/Configuration.ts:182](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L182) + +___ + +### getNamingStrategy + +▸ getNamingStrategy(): [NamingStrategy](../interfaces/core.namingstrategy.md) + +Gets instance of NamingStrategy. (cached) + +Returns: [NamingStrategy](../interfaces/core.namingstrategy.md) + +Defined in: [packages/core/src/utils/Configuration.ts:168](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L168) + +___ + +### getRepositoryClass + +▸ getRepositoryClass(`customRepository`: undefined \\\| () => [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\>): undefined \\\| [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> + +Gets EntityRepository class to be instantiated. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`customRepository` \| undefined \\\| () => [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> \| + +Returns: undefined \\\| [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> + +Defined in: [packages/core/src/utils/Configuration.ts:203](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L203) + +___ + +### getResultCacheAdapter + +▸ getResultCacheAdapter(): [CacheAdapter](../interfaces/core.cacheadapter.md) + +Gets instance of CacheAdapter for result cache. (cached) + +Returns: [CacheAdapter](../interfaces/core.cacheadapter.md) + +Defined in: [packages/core/src/utils/Configuration.ts:196](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L196) + +___ + +### init + +▸ `Private`init(): void + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:215](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L215) + +___ + +### initDriver + +▸ `Private`initDriver(): D + +Returns: D + +Defined in: [packages/core/src/utils/Configuration.ts:268](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L268) + +___ + +### reset + +▸ reset<T, U\\>(`key`: T): void + +Resets the configuration to its default value + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| keyof [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> \| +`U` \| undefined \\\| string \\\| number \\\| boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \\\| [Highlighter](../interfaces/core.highlighter.md) \\\| () => [NamingStrategy](../interfaces/core.namingstrategy.md) \\\| [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> \\\| Partial<[ConnectionOptions](../interfaces/core.connectionoptions.md)\\>[] \\\| (string \\\| EntityClass<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| EntityClassGroup<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntitySchema](core.entityschema.md)<any, undefined\\>)[] \\\| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[] \\\| [Dictionary](../modules/core.md#dictionary)<{ `name?`: string } & Omit<FilterDef<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, name\\>\\> \\\| { `alwaysAnalyseProperties?`: boolean ; `disableDynamicFileAccess?`: boolean ; `requireEntitiesArray?`: boolean ; `warnWhenNoEntities?`: boolean } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => D \\\| (string \\\| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \\\| HydratorConstructor \\\| (`name`: string) => undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| (`message`: string) => void \\\| (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>) => Error \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] \\\| [MigrationsOptions](../modules/core.md#migrationsoptions) \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `enabled?`: boolean ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `pretty?`: boolean } \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `expiration?`: number ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => [MetadataProvider](core.metadataprovider.md) \\\| [PoolConfig](../interfaces/core.poolconfig.md) \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| T \| + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L136) + +___ + +### set + +▸ set<T, U\\>(`key`: T, `value`: U): void + +Overrides specified configuration value. + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| keyof [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\> \| +`U` \| undefined \\\| string \\\| number \\\| boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \\\| [Highlighter](../interfaces/core.highlighter.md) \\\| () => [NamingStrategy](../interfaces/core.namingstrategy.md) \\\| [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<any\\>\\> \\\| Partial<[ConnectionOptions](../interfaces/core.connectionoptions.md)\\>[] \\\| (string \\\| EntityClass<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| EntityClassGroup<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntitySchema](core.entityschema.md)<any, undefined\\>)[] \\\| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[] \\\| [Dictionary](../modules/core.md#dictionary)<{ `name?`: string } & Omit<FilterDef<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, name\\>\\> \\\| { `alwaysAnalyseProperties?`: boolean ; `disableDynamicFileAccess?`: boolean ; `requireEntitiesArray?`: boolean ; `warnWhenNoEntities?`: boolean } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => D \\\| (string \\\| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \\\| HydratorConstructor \\\| (`name`: string) => undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| (`message`: string) => void \\\| (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>) => Error \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] \\\| [MigrationsOptions](../modules/core.md#migrationsoptions) \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `enabled?`: boolean ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `pretty?`: boolean } \\\| { `adapter?`: (...`params`: any[]) => [CacheAdapter](../interfaces/core.cacheadapter.md) ; `expiration?`: number ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> } \\\| (`config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>) => [MetadataProvider](core.metadataprovider.md) \\\| [PoolConfig](../interfaces/core.poolconfig.md) \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| T \| +`value` \| U \| + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:129](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L129) + +___ + +### validateOptions + +▸ `Private`validateOptions(): void + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:250](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L250) diff --git a/core.configurationloader.md b/core.configurationloader.md index 15fcce5..4fa4657 100644 --- a/core.configurationloader.md +++ b/core.configurationloader.md @@ -0,0 +1,126 @@ +--- +id: "core.configurationloader" +title: "Class: ConfigurationLoader" +sidebar_label: "ConfigurationLoader" +custom_edit_url: null +hide_title: true +--- + +# Class: ConfigurationLoader + +[core](../modules/core.md).ConfigurationLoader + +## Constructors + +### constructor + +\\+ new ConfigurationLoader(): [ConfigurationLoader](core.configurationloader.md) + +Returns: [ConfigurationLoader](core.configurationloader.md) + +## Methods + +### getConfigPaths + +▸ `Static`getConfigPaths(): Promise<string[]\\> + +Returns: Promise<string[]\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L47) + +___ + +### getConfiguration + +▸ `Static`getConfiguration<D\\>(`validate?`: boolean, `options?`: Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): Promise<[Configuration](core.configuration.md)<D\\>\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`validate` \| boolean \| true \| +`options?` \| Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| - \| + +Returns: Promise<[Configuration](core.configuration.md)<D\\>\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L12) + +___ + +### getPackageConfig + +▸ `Static`getPackageConfig(): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L34) + +___ + +### getSettings + +▸ `Static`getSettings(): Promise<[Settings](../interfaces/core.settings.md)\\> + +Returns: Promise<[Settings](../interfaces/core.settings.md)\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L42) + +___ + +### getTsConfig + +▸ `Static`getTsConfig(`tsConfigPath`: string): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tsConfigPath` \| string \| + +Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L89) + +___ + +### loadEnvironmentVars + +▸ `Static`loadEnvironmentVars<D\\>(`options?`: [Options](../modules/core.md#options)<D\\> \\\| [Configuration](core.configuration.md)<D\\>): Partial<[Options](../modules/core.md#options)<D\\>\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options?` \| [Options](../modules/core.md#options)<D\\> \\\| [Configuration](core.configuration.md)<D\\> \| + +Returns: Partial<[Options](../modules/core.md#options)<D\\>\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L94) + +___ + +### registerTsNode + +▸ `Static`registerTsNode(`configPath?`: string): Promise<void\\> + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`configPath` \| string \| 'tsconfig.json' \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L67) diff --git a/core.entityschema.md b/core.entityschema.md index 37ae645..5b610fd 100644 --- a/core.entityschema.md +++ b/core.entityschema.md @@ -0,0 +1,481 @@ +--- +id: "core.entityschema" +title: "Class: EntitySchema<T, U>" +sidebar_label: "EntitySchema" +custom_edit_url: null +hide_title: true +--- + +# Class: EntitySchema<T, U\\> + +[core](../modules/core.md).EntitySchema + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity) \| +`U` \| [AnyEntity](../modules/core.md#anyentity)<U\\> \\\| undefined \| undefined \| + +## Constructors + +### constructor + +\\+ new EntitySchema<T, U\\>(`meta`: Omit<Partial<[EntityMetadata](core.entitymetadata.md)<T\\>\\>, name \\\| properties\\> & { `name`: string } \\\| { `class`: [Constructor](../modules/core.md#constructor)<T\\> ; `name?`: string } & { `properties?`: { [K in string]-?: object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ManyToOneOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & OneToOneOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ReferenceOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> & object \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ManyToManyOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & EmbeddedOptions & PropertyOptions<T\\> \\\| object & EnumOptions<T\\> \\\| TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & PropertyOptions<T\\>} }): [EntitySchema](core.entityschema.md)<T, U\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`U` \| undefined \\\| [AnyEntity](../modules/core.md#anyentity)<U\\> \| undefined \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| Omit<Partial<[EntityMetadata](core.entitymetadata.md)<T\\>\\>, name \\\| properties\\> & { `name`: string } \\\| { `class`: [Constructor](../modules/core.md#constructor)<T\\> ; `name?`: string } & { `properties?`: { [K in string]-?: object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ManyToOneOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & OneToOneOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ReferenceOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> & object \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & ManyToManyOptions<ExpandProperty<NonNullable<T[K]\\>\\>, T\\> \\\| object & TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & EmbeddedOptions & PropertyOptions<T\\> \\\| object & EnumOptions<T\\> \\\| TypeDef<ExpandProperty<NonNullable<T[K]\\>\\>\\> & PropertyOptions<T\\>} } \| + +Returns: [EntitySchema](core.entityschema.md)<T, U\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L32) + +## Properties + +### \\_meta + +• `Private` `Readonly` \\_meta: [EntityMetadata](core.entitymetadata.md)<T\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L30) + +___ + +### initialized + +• `Private` initialized: boolean= false + +Defined in: [packages/core/src/metadata/EntitySchema.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L32) + +___ + +### internal + +• `Private` internal: boolean= false + +Defined in: [packages/core/src/metadata/EntitySchema.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L31) + +## Accessors + +### meta + +• get meta(): [EntityMetadata](core.entitymetadata.md)<T\\> + +Returns: [EntityMetadata](core.entitymetadata.md)<T\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:218](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L218) + +___ + +### name + +• get name(): [EntityName](../modules/core.md#entityname)<T\\> + +Returns: [EntityName](../modules/core.md#entityname)<T\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:222](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L222) + +## Methods + +### addEmbedded + +▸ addEmbedded<K\\>(`name`: string & keyof T, `options`: [EmbeddedOptions](../modules/core.md#embeddedoptions)): void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`K` \| unknown \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`options` \| [EmbeddedOptions](../modules/core.md#embeddedoptions) \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L119) + +___ + +### addEnum + +▸ addEnum(`name`: string & keyof T, `type?`: TypeType, `options?`: [EnumOptions](../interfaces/core.enumoptions.md)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type?` \| TypeType \| +`options` \| [EnumOptions](../interfaces/core.enumoptions.md)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L86) + +___ + +### addIndex + +▸ addIndex<T\\>(`options`: Required<Omit<[IndexOptions](../interfaces/core.indexoptions.md)<T\\>, name \\\| type \\\| options\\>\\> & { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `type?`: string }): void + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| Required<Omit<[IndexOptions](../interfaces/core.indexoptions.md)<T\\>, name \\\| type \\\| options\\>\\> & { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `type?`: string } \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:190](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L190) + +___ + +### addManyToMany + +▸ addManyToMany<K\\>(`name`: string & keyof T, `type`: TypeType, `options`: [ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<K, T\\>): void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`K` \| unknown \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<K, T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:149](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L149) + +___ + +### addManyToOne + +▸ addManyToOne<K\\>(`name`: string & keyof T, `type`: TypeType, `options`: [ManyToOneOptions](../interfaces/core.manytooneoptions.md)<K, T\\>): void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`K` \| unknown \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [ManyToOneOptions](../interfaces/core.manytooneoptions.md)<K, T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:134](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L134) + +___ + +### addOneToMany + +▸ addOneToMany<K\\>(`name`: string & keyof T, `type`: TypeType, `options`: [OneToManyOptions](../modules/core.md#onetomanyoptions)<K, T\\>): void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`K` \| unknown \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [OneToManyOptions](../modules/core.md#onetomanyoptions)<K, T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:164](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L164) + +___ + +### addOneToOne + +▸ addOneToOne<K\\>(`name`: string & keyof T, `type`: TypeType, `options`: [OneToOneOptions](../interfaces/core.onetooneoptions.md)<K, T\\>): void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`K` \| unknown \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [OneToOneOptions](../interfaces/core.onetooneoptions.md)<K, T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:169](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L169) + +___ + +### addPrimaryKey + +▸ addPrimaryKey(`name`: string & keyof T, `type`: TypeType, `options?`: [PrimaryKeyOptions](../interfaces/core.primarykeyoptions.md)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [PrimaryKeyOptions](../interfaces/core.primarykeyoptions.md)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L110) + +___ + +### addProperty + +▸ addProperty(`name`: string & keyof T, `type?`: TypeType, `options?`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type?` \| TypeType \| +`options` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L53) + +___ + +### addSerializedPrimaryKey + +▸ addSerializedPrimaryKey(`name`: string & keyof T, `type`: TypeType, `options?`: [SerializedPrimaryKeyOptions](../interfaces/core.serializedprimarykeyoptions.md)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [SerializedPrimaryKeyOptions](../interfaces/core.serializedprimarykeyoptions.md)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:114](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L114) + +___ + +### addUnique + +▸ addUnique<T\\>(`options`: Required<Omit<[UniqueOptions](../interfaces/core.uniqueoptions.md)<T\\>, name \\\| options\\>\\> & { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> }): void + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| Required<Omit<[UniqueOptions](../interfaces/core.uniqueoptions.md)<T\\>, name \\\| options\\>\\> & { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> } \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:194](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L194) + +___ + +### addVersion + +▸ addVersion(`name`: string & keyof T, `type`: TypeType, `options?`: [PropertyOptions](../modules/core.md#propertyoptions)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string & keyof T \| +`type` \| TypeType \| +`options` \| [PropertyOptions](../modules/core.md#propertyoptions)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L106) + +___ + +### createProperty + +▸ `Private`createProperty<T\\>(`reference`: [ReferenceType](../enums/core.referencetype.md), `options`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\>): [EntityProperty](../interfaces/core.entityproperty.md)<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`reference` \| [ReferenceType](../enums/core.referencetype.md) \| +`options` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\> \| + +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<T\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:330](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L330) + +___ + +### init + +▸ init(): [EntitySchema](core.entityschema.md)<T, U\\> + +`internal` + +Returns: [EntitySchema](core.entityschema.md)<T, U\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:229](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L229) + +___ + +### initPrimaryKeys + +▸ `Private`initPrimaryKeys(): void + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:290](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L290) + +___ + +### initProperties + +▸ `Private`initProperties(): void + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:254](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L254) + +___ + +### normalizeType + +▸ `Private`normalizeType(`options`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\>, `type?`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \\\| [PropertyOptions](../modules/core.md#propertyoptions)<T\\> \| +`type?` \| any \| + +Returns: any + +Defined in: [packages/core/src/metadata/EntitySchema.ts:310](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L310) + +___ + +### setClass + +▸ setClass(`proto`: [Constructor](../modules/core.md#constructor)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`proto` \| [Constructor](../modules/core.md#constructor)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:206](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L206) + +___ + +### setCustomRepository + +▸ setCustomRepository(`repository`: () => [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`repository` \| () => [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:198](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L198) + +___ + +### setExtends + +▸ setExtends(`base`: string): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`base` \| string \| + +Returns: void + +Defined in: [packages/core/src/metadata/EntitySchema.ts:202](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L202) + +___ + +### fromMetadata + +▸ `Static`fromMetadata<T, U\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\> \\\| [DeepPartial](../modules/core.md#deeppartial)<[EntityMetadata](core.entitymetadata.md)<T\\>\\>): [EntitySchema](core.entityschema.md)<T, U\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`U` \| undefined \\\| [AnyEntity](../modules/core.md#anyentity)<U\\> \| undefined \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \\\| [DeepPartial](../modules/core.md#deeppartial)<[EntityMetadata](core.entitymetadata.md)<T\\>\\> \| + +Returns: [EntitySchema](core.entityschema.md)<T, U\\> + +Defined in: [packages/core/src/metadata/EntitySchema.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/EntitySchema.ts#L46) diff --git a/core.metadataerror.md b/core.metadataerror.md index c345b6b..bc34d12 100644 --- a/core.metadataerror.md +++ b/core.metadataerror.md @@ -0,0 +1,705 @@ +--- +id: "core.metadataerror" +title: "Class: MetadataError<T>" +sidebar_label: "MetadataError" +custom_edit_url: null +hide_title: true +--- + +# Class: MetadataError<T\\> + +[core](../modules/core.md).MetadataError + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity) \| [AnyEntity](../modules/core.md#anyentity) \| + +## Hierarchy + +* [ValidationError](core.validationerror.md)<T\\> + + ↳ MetadataError + +## Constructors + +### constructor + +\\+ new MetadataError<T\\>(`message`: string, `entity?`: T): [MetadataError](core.metadataerror.md)<T\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`message` \| string \| +`entity?` \| T \| + +Returns: [MetadataError](core.metadataerror.md)<T\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L4) + +## Properties + +### message + +• message: string + +Inherited from: [ValidationError](core.validationerror.md).[message](core.validationerror.md#message) + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:974 + +___ + +### name + +• name: string + +Inherited from: [ValidationError](core.validationerror.md).[name](core.validationerror.md#name) + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973 + +___ + +### prepareStackTrace + +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any + +Optional override for formatting stack traces + +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 + +Inherited from: [ValidationError](core.validationerror.md).[prepareStackTrace](core.validationerror.md#preparestacktrace) + +Defined in: node_modules/@types/node/globals.d.ts:11 + +___ + +### stack + +• `Optional` stack: string + +Inherited from: [ValidationError](core.validationerror.md).[stack](core.validationerror.md#stack) + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975 + +___ + +### stackTraceLimit + +• stackTraceLimit: number + +Inherited from: [ValidationError](core.validationerror.md).[stackTraceLimit](core.validationerror.md#stacktracelimit) + +Defined in: node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ captureStackTrace(`targetObject`: object, `constructorOpt?`: Function): void + +Create .stack property on a target object + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`targetObject` \| object \| +`constructorOpt?` \| Function \| + +Returns: void + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: node_modules/@types/node/globals.d.ts:4 + +___ + +### getEntity + +▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> + +Gets instance of entity that caused this error. + +Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L17) + +___ + +### cannotCommit + +▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L96) + +___ + +### cannotModifyInverseCollection + +▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L79) + +___ + +### cannotModifyReadonlyCollection + +▸ `Static`cannotModifyReadonlyCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L88) + +___ + +### cannotUseOperatorsInsideEmbeddables + +▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`className` \| string \| +`propName` \| string \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L100) + +___ + +### conflictingPropertyName + +▸ `Static`conflictingPropertyName(`className`: string, `name`: string, `embeddedName`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`className` \| string \| +`name` \| string \| +`embeddedName` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:207](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L207) + +___ + +### duplicateEntityDiscovered + +▸ `Static`duplicateEntityDiscovered(`paths`: string[]): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`paths` \| string[] \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:195](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L195) + +___ + +### entityNotFound + +▸ `Static`entityNotFound(`name`: string, `path`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string \| +`path` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L166) + +___ + +### entityNotManaged + +▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L43) + +___ + +### fromCollectionNotInitialized + +▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L28) + +___ + +### fromMergeWithoutPK + +▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: void + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L35) + +___ + +### fromMessage + +▸ `Private` `Static`fromMessage(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `message`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`message` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L211) + +___ + +### fromMissingPrimaryKey + +▸ `Static`fromMissingPrimaryKey(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:134](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L134) + +___ + +### fromUnknownEntity + +▸ `Static`fromUnknownEntity(`className`: string, `source`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`className` \| string \| +`source` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L183) + +___ + +### fromWrongOwnership + +▸ `Static`fromWrongOwnership(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `key`: keyof [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`key` \| keyof [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:154](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L154) + +___ + +### fromWrongPropertyType + +▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| string \| +`expectedType` \| string \| +`givenType` \| string \| +`givenValue` \| string \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L21) + +___ + +### fromWrongReference + +▸ `Static`fromWrongReference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `key`: keyof [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owner?`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`key` \| keyof [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`owner?` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L138) + +___ + +### fromWrongReferenceType + +▸ `Static`fromWrongReferenceType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `owner`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`owner` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L161) + +___ + +### fromWrongTypeDefinition + +▸ `Static`fromWrongTypeDefinition(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L146) + +___ + +### invalidCompositeIdentifier + +▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L92) + +___ + +### invalidEmbeddableQuery + +▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`className` \| string \| +`propName` \| string \| +`embeddableType` \| string \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L104) + +___ + +### invalidPropertyName + +▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`invalid` \| string \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L65) + +___ + +### invalidType + +▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| +`value` \| any \| +`mode` \| string \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L69) + +___ + +### invalidVersionFieldType + +▸ `Static`invalidVersionFieldType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L178) + +___ + +### missingMetadata + +▸ `Static`missingMetadata(`entity`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:203](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L203) + +___ + +### multipleDecorators + +▸ `Static`multipleDecorators(`entityName`: string, `propertyName`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`propertyName` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:199](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L199) + +___ + +### multipleVersionFields + +▸ `Static`multipleVersionFields(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fields`: string[]): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`fields` \| string[] \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L174) + +___ + +### noEntityDiscovered + +▸ `Static`noEntityDiscovered(): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L187) + +___ + +### notDiscoveredEntity + +▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| any \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L52) + +___ + +### notEntity + +▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`data` \| any \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L47) + +___ + +### onlyAbstractEntitiesDiscovered + +▸ `Static`onlyAbstractEntitiesDiscovered(): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L191) + +___ + +### transactionRequired + +▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L39) + +___ + +### unknownIndexProperty + +▸ `Static`unknownIndexProperty(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: string, `type`: string): [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| string \| +`type` \| string \| + +Returns: [MetadataError](core.metadataerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L170) diff --git a/core.queryhelper.md b/core.queryhelper.md index 244f5f1..70764c0 100644 --- a/core.queryhelper.md +++ b/core.queryhelper.md @@ -0,0 +1,256 @@ +--- +id: "core.queryhelper" +title: "Class: QueryHelper" +sidebar_label: "QueryHelper" +custom_edit_url: null +hide_title: true +--- + +# Class: QueryHelper + +[core](../modules/core.md).QueryHelper + +## Constructors + +### constructor + +\\+ new QueryHelper(): [QueryHelper](core.queryhelper.md) + +Returns: [QueryHelper](core.queryhelper.md) + +## Properties + +### SUPPORTED\\_OPERATORS + +▪ `Readonly` `Static` SUPPORTED\\_OPERATORS: string[] + +Defined in: [packages/core/src/utils/QueryHelper.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L11) + +## Methods + +### getActiveFilters + +▸ `Static`getActiveFilters(`entityName`: string, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `filters`: [Dictionary](../modules/core.md#dictionary)<FilterDef<any\\>\\>): FilterDef<any\\>[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| +`filters` \| [Dictionary](../modules/core.md#dictionary)<FilterDef<any\\>\\> \| + +Returns: FilterDef<any\\>[] + +Defined in: [packages/core/src/utils/QueryHelper.ts:165](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L165) + +___ + +### inlinePrimaryKeyObjects + +▸ `Static`inlinePrimaryKeyObjects<T\\>(`where`: [Dictionary](../modules/core.md#dictionary)<any\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `metadata`: [MetadataStorage](core.metadatastorage.md), `key?`: string): boolean + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`where` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`metadata` \| [MetadataStorage](core.metadatastorage.md) \| +`key?` \| string \| + +Returns: boolean + +Defined in: [packages/core/src/utils/QueryHelper.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L45) + +___ + +### isFilterActive + +▸ `Static`isFilterActive(`entityName`: string, `filterName`: string, `filter`: FilterDef<any\\>, `options`: [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`filterName` \| string \| +`filter` \| FilterDef<any\\> \| +`options` \| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| + +Returns: boolean + +Defined in: [packages/core/src/utils/QueryHelper.ts:186](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L186) + +___ + +### isSupportedOperator + +▸ `Private` `Static`isSupportedOperator(`key`: string): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| + +Returns: boolean + +Defined in: [packages/core/src/utils/QueryHelper.ts:240](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L240) + +___ + +### processCustomType + +▸ `Static`processCustomType<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `cond`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `platform`: [Platform](core.platform.md), `key?`: string, `fromQuery?`: boolean): [FilterQuery](../modules/core.md#filterquery)<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`platform` \| [Platform](core.platform.md) \| +`key?` \| string \| +`fromQuery?` \| boolean \| + +Returns: [FilterQuery](../modules/core.md#filterquery)<T\\> + +Defined in: [packages/core/src/utils/QueryHelper.ts:198](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L198) + +___ + +### processEntity + +▸ `Private` `Static`processEntity(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `root?`: boolean): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`root?` \| boolean \| + +Returns: any + +Defined in: [packages/core/src/utils/QueryHelper.ts:218](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L218) + +___ + +### processExpression + +▸ `Private` `Static`processExpression<T\\>(`expr`: string, `value`: T): [Dictionary](../modules/core.md#dictionary)<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`expr` \| string \| +`value` \| T \| + +Returns: [Dictionary](../modules/core.md#dictionary)<T\\> + +Defined in: [packages/core/src/utils/QueryHelper.ts:228](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L228) + +___ + +### processJsonCondition + +▸ `Private` `Static`processJsonCondition<T\\>(`o`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `value`: [Dictionary](../modules/core.md#dictionary)<any\\>, `path`: string[], `platform`: [Platform](core.platform.md)): [FilterQuery](../modules/core.md#filterquery)<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`o` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`value` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`path` \| string[] \| +`platform` \| [Platform](core.platform.md) \| + +Returns: [FilterQuery](../modules/core.md#filterquery)<T\\> + +Defined in: [packages/core/src/utils/QueryHelper.ts:244](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L244) + +___ + +### processObjectParams + +▸ `Static`processObjectParams(`params?`: [Dictionary](../modules/core.md#dictionary)<any\\>): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`params` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: any + +Defined in: [packages/core/src/utils/QueryHelper.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L37) + +___ + +### processParams + +▸ `Static`processParams(`params`: any, `root?`: boolean): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`params` \| any \| +`root?` \| boolean \| + +Returns: any + +Defined in: [packages/core/src/utils/QueryHelper.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L13) + +___ + +### processWhere + +▸ `Static`processWhere<T\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `entityName`: string, `metadata`: [MetadataStorage](core.metadatastorage.md), `platform`: [Platform](core.platform.md), `convertCustomTypes?`: boolean, `root?`: boolean): [FilterQuery](../modules/core.md#filterquery)<T\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| +`entityName` \| string \| - \| +`metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| +`platform` \| [Platform](core.platform.md) \| - \| +`convertCustomTypes` \| boolean \| true \| +`root` \| boolean \| true \| + +Returns: [FilterQuery](../modules/core.md#filterquery)<T\\> + +Defined in: [packages/core/src/utils/QueryHelper.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L73) diff --git a/core.wrappedentity.md b/core.wrappedentity.md index c769254..f3af0cc 100644 --- a/core.wrappedentity.md +++ b/core.wrappedentity.md @@ -0,0 +1,333 @@ +--- +id: "core.wrappedentity" +title: "Class: WrappedEntity<T, PK>" +sidebar_label: "WrappedEntity" +custom_edit_url: null +hide_title: true +--- + +# Class: WrappedEntity<T, PK\\> + +[core](../modules/core.md).WrappedEntity + +## Type parameters + +Name \| Type \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| +`PK` \| keyof T \| + +## Constructors + +### constructor + +\\+ new WrappedEntity<T, PK\\>(`entity`: T, `pkGetter`: (`e`: T) => [Primary](../modules/core.md#primary)<T\\>, `pkSerializer`: (`e`: T) => string): [WrappedEntity](core.wrappedentity.md)<T, PK\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| +`PK` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`pkGetter` \| (`e`: T) => [Primary](../modules/core.md#primary)<T\\> \| +`pkSerializer` \| (`e`: T) => string \| + +Returns: [WrappedEntity](core.wrappedentity.md)<T, PK\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L25) + +## Properties + +### \\_\\_em + +• `Optional` \\_\\_em: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L18) + +___ + +### \\_\\_identifier + +• `Optional` \\_\\_identifier: [EntityIdentifier](core.entityidentifier.md) + +holds wrapped primary key so we can compute change set without eager commit + +Defined in: [packages/core/src/entity/WrappedEntity.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L25) + +___ + +### \\_\\_initialized + +• \\_\\_initialized: boolean= true + +Defined in: [packages/core/src/entity/WrappedEntity.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L14) + +___ + +### \\_\\_lazyInitialized + +• `Optional` \\_\\_lazyInitialized: boolean + +Defined in: [packages/core/src/entity/WrappedEntity.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L16) + +___ + +### \\_\\_managed + +• `Optional` \\_\\_managed: boolean + +Defined in: [packages/core/src/entity/WrappedEntity.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L17) + +___ + +### \\_\\_originalEntityData + +• `Optional` \\_\\_originalEntityData: [EntityData](../modules/core.md#entitydata)<T\\> + +holds last entity data snapshot so we can compute changes when persisting managed entities + +Defined in: [packages/core/src/entity/WrappedEntity.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L22) + +___ + +### \\_\\_populated + +• `Optional` \\_\\_populated: boolean + +Defined in: [packages/core/src/entity/WrappedEntity.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L15) + +___ + +### \\_\\_serializationContext + +• \\_\\_serializationContext: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`populate`? \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| +`root`? \| [SerializationContext](core.serializationcontext.md)<T\\> \| + +Defined in: [packages/core/src/entity/WrappedEntity.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L19) + +## Accessors + +### \\_\\_meta + +• get __meta(): [EntityMetadata](core.entitymetadata.md)<T\\> + +Returns: [EntityMetadata](core.entitymetadata.md)<T\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L94) + +___ + +### \\_\\_platform + +• get __platform(): [Platform](core.platform.md) + +Returns: [Platform](core.platform.md) + +Defined in: [packages/core/src/entity/WrappedEntity.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L98) + +___ + +### \\_\\_primaryKeyCond + +• get __primaryKeyCond(): null \\\| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] + +Returns: null \\\| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] + +Defined in: [packages/core/src/entity/WrappedEntity.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L106) + +___ + +### \\_\\_primaryKeys + +• get __primaryKeys(): [Primary](../modules/core.md#primary)<T\\>[] + +Returns: [Primary](../modules/core.md#primary)<T\\>[] + +Defined in: [packages/core/src/entity/WrappedEntity.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L102) + +## Methods + +### [custom] + +▸ [custom](): string + +Returns: string + +Defined in: [packages/core/src/entity/WrappedEntity.ts:114](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L114) + +___ + +### assign + +▸ assign(`data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [AssignOptions](../interfaces/core.assignoptions.md)): T + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options?` \| [AssignOptions](../interfaces/core.assignoptions.md) \| + +Returns: T + +Defined in: [packages/core/src/entity/WrappedEntity.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L57) + +___ + +### getPrimaryKey + +▸ getPrimaryKey(): null \\\| [Primary](../modules/core.md#primary)<T\\> + +Returns: null \\\| [Primary](../modules/core.md#primary)<T\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L82) + +___ + +### getSerializedPrimaryKey + +▸ getSerializedPrimaryKey(): string + +Returns: string + +Defined in: [packages/core/src/entity/WrappedEntity.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L90) + +___ + +### hasPrimaryKey + +▸ hasPrimaryKey(): boolean + +Returns: boolean + +Defined in: [packages/core/src/entity/WrappedEntity.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L77) + +___ + +### init + +▸ init<P\\>(`populated?`: boolean, `populate?`: P, `lockMode?`: [LockMode](../enums/core.lockmode.md)): Promise<T\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`populated` \| boolean \| true \| +`populate?` \| P \| - \| +`lockMode?` \| [LockMode](../enums/core.lockmode.md) \| - \| + +Returns: Promise<T\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:65](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L65) + +___ + +### isInitialized + +▸ isInitialized(): boolean + +Returns: boolean + +Defined in: [packages/core/src/entity/WrappedEntity.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L31) + +___ + +### populated + +▸ populated(`populated?`: boolean): void + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`populated` \| boolean \| true \| + +Returns: void + +Defined in: [packages/core/src/entity/WrappedEntity.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L35) + +___ + +### setPrimaryKey + +▸ setPrimaryKey(`id`: null \\\| [Primary](../modules/core.md#primary)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`id` \| null \\\| [Primary](../modules/core.md#primary)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/entity/WrappedEntity.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L86) + +___ + +### toJSON + +▸ toJSON(...`args`: any[]): { [P in string \\\| number \\\| symbol]?: any} & [Dictionary](../modules/core.md#dictionary)<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...args` \| any[] \| + +Returns: { [P in string \\\| number \\\| symbol]?: any} & [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L52) + +___ + +### toObject + +▸ toObject(`ignoreFields?`: string[]): [EntityData](../modules/core.md#entitydata)<T\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`ignoreFields` \| string[] \| + +Returns: [EntityData](../modules/core.md#entitydata)<T\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L44) + +___ + +### toPOJO + +▸ toPOJO(): [EntityData](../modules/core.md#entitydata)<T\\> + +Returns: [EntityData](../modules/core.md#entitydata)<T\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L48) + +___ + +### toReference + +▸ toReference(): [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> + +Returns: [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> + +Defined in: [packages/core/src/entity/WrappedEntity.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/WrappedEntity.ts#L40) diff --git a/knex.knex.querybuilder.md b/knex.knex.querybuilder.md index d41e39e..24f6995 100644 --- a/knex.knex.querybuilder.md +++ b/knex.knex.querybuilder.md @@ -1,2293 +0,0 @@ ---- -id: "knex.knex.querybuilder" -title: "Class: QueryBuilder<TRecord, TResult>" -sidebar_label: "QueryBuilder" -hide_title: true ---- - -# Class: QueryBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).QueryBuilder - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| any \| - -## Hierarchy - -* [QueryInterface](../interfaces/knex.knex.queryinterface.md)<TRecord, TResult\\> - -* [ChainableInterface](../interfaces/knex.knex.chainableinterface.md)<ResolveResult<TResult\\>\\> - - ↳ QueryBuilder - -## Constructors - -### constructor - -\\+ new QueryBuilder<TRecord, TResult\\>(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| any \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -## Properties - -### [Symbol.toStringTag] - -• `Readonly` [Symbol.toStringTag]: string - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md).[[Symbol.toStringTag]](../interfaces/knex.knex.chainableinterface.md#[symbol.tostringtag]) - -Defined in: node_modules/knex/types/index.d.ts:1639 - -___ - -### and - -• and: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1591 - -___ - -### andHaving - -• andHaving: [Having](../interfaces/knex.knex.having.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andHaving](../interfaces/knex.knex.queryinterface.md#andhaving) - -Defined in: node_modules/knex/types/index.d.ts:543 - -___ - -### andWhere - -• andWhere: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andWhere](../interfaces/knex.knex.queryinterface.md#andwhere) - -Defined in: node_modules/knex/types/index.d.ts:497 - -___ - -### andWhereBetween - -• andWhereBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andWhereBetween](../interfaces/knex.knex.queryinterface.md#andwherebetween) - -Defined in: node_modules/knex/types/index.d.ts:521 - -___ - -### andWhereNot - -• andWhereNot: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andWhereNot](../interfaces/knex.knex.queryinterface.md#andwherenot) - -Defined in: node_modules/knex/types/index.d.ts:500 - -___ - -### andWhereNotBetween - -• andWhereNotBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andWhereNotBetween](../interfaces/knex.knex.queryinterface.md#andwherenotbetween) - -Defined in: node_modules/knex/types/index.d.ts:524 - -___ - -### andWhereRaw - -• andWhereRaw: [WhereRaw](../interfaces/knex.knex.whereraw.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[andWhereRaw](../interfaces/knex.knex.queryinterface.md#andwhereraw) - -Defined in: node_modules/knex/types/index.d.ts:504 - -___ - -### as - -• as: [As](../interfaces/knex.knex.as.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[as](../interfaces/knex.knex.queryinterface.md#as) - -Defined in: node_modules/knex/types/index.d.ts:467 - -___ - -### avg - -• avg: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[avg](../interfaces/knex.knex.queryinterface.md#avg) - -Defined in: node_modules/knex/types/index.d.ts:586 - -___ - -### avgDistinct - -• avgDistinct: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[avgDistinct](../interfaces/knex.knex.queryinterface.md#avgdistinct) - -Defined in: node_modules/knex/types/index.d.ts:587 - -___ - -### client - -• client: [Client](knex.knex.client.md) - -Defined in: node_modules/knex/types/index.d.ts:1588 - -___ - -### column - -• column: [Select](../interfaces/knex.knex.select.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[column](../interfaces/knex.knex.queryinterface.md#column) - -Defined in: node_modules/knex/types/index.d.ts:469 - -___ - -### columns - -• columns: [Select](../interfaces/knex.knex.select.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[columns](../interfaces/knex.knex.queryinterface.md#columns) - -Defined in: node_modules/knex/types/index.d.ts:468 - -___ - -### count - -• count: [AsymmetricAggregation](../interfaces/knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[count](../interfaces/knex.knex.queryinterface.md#count) - -Defined in: node_modules/knex/types/index.d.ts:580 - -___ - -### countDistinct - -• countDistinct: [AsymmetricAggregation](../interfaces/knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[countDistinct](../interfaces/knex.knex.queryinterface.md#countdistinct) - -Defined in: node_modules/knex/types/index.d.ts:581 - -___ - -### crossJoin - -• crossJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[crossJoin](../interfaces/knex.knex.queryinterface.md#crossjoin) - -Defined in: node_modules/knex/types/index.d.ts:486 - -___ - -### distinct - -• distinct: [Distinct](../interfaces/knex.knex.distinct.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[distinct](../interfaces/knex.knex.queryinterface.md#distinct) - -Defined in: node_modules/knex/types/index.d.ts:473 - -___ - -### distinctOn - -• distinctOn: [DistinctOn](../interfaces/knex.knex.distincton.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[distinctOn](../interfaces/knex.knex.queryinterface.md#distincton) - -Defined in: node_modules/knex/types/index.d.ts:474 - -___ - -### first - -• first: [Select](../interfaces/knex.knex.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[first](../interfaces/knex.knex.queryinterface.md#first) - -Defined in: node_modules/knex/types/index.d.ts:608 - -___ - -### from - -• from: [Table](../interfaces/knex.knex.table.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[from](../interfaces/knex.knex.queryinterface.md#from) - -Defined in: node_modules/knex/types/index.d.ts:470 - -___ - -### fullOuterJoin - -• fullOuterJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[fullOuterJoin](../interfaces/knex.knex.queryinterface.md#fullouterjoin) - -Defined in: node_modules/knex/types/index.d.ts:485 - -___ - -### groupBy - -• groupBy: [GroupBy](../interfaces/knex.knex.groupby.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[groupBy](../interfaces/knex.knex.queryinterface.md#groupby) - -Defined in: node_modules/knex/types/index.d.ts:527 - -___ - -### groupByRaw - -• groupByRaw: [RawQueryBuilder](../interfaces/knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[groupByRaw](../interfaces/knex.knex.queryinterface.md#groupbyraw) - -Defined in: node_modules/knex/types/index.d.ts:528 - -___ - -### having - -• having: [Having](../interfaces/knex.knex.having.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[having](../interfaces/knex.knex.queryinterface.md#having) - -Defined in: node_modules/knex/types/index.d.ts:542 - -___ - -### havingBetween - -• havingBetween: [HavingRange](../interfaces/knex.knex.havingrange.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[havingBetween](../interfaces/knex.knex.queryinterface.md#havingbetween) - -Defined in: node_modules/knex/types/index.d.ts:551 - -___ - -### havingIn - -• havingIn: [HavingRange](../interfaces/knex.knex.havingrange.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[havingIn](../interfaces/knex.knex.queryinterface.md#havingin) - -Defined in: node_modules/knex/types/index.d.ts:547 - -___ - -### havingNotBetween - -• havingNotBetween: [HavingRange](../interfaces/knex.knex.havingrange.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[havingNotBetween](../interfaces/knex.knex.queryinterface.md#havingnotbetween) - -Defined in: node_modules/knex/types/index.d.ts:549 - -___ - -### havingRaw - -• havingRaw: [RawQueryBuilder](../interfaces/knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[havingRaw](../interfaces/knex.knex.queryinterface.md#havingraw) - -Defined in: node_modules/knex/types/index.d.ts:544 - -___ - -### havingWrapped - -• havingWrapped: [WhereWrapped](../interfaces/knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[havingWrapped](../interfaces/knex.knex.queryinterface.md#havingwrapped) - -Defined in: node_modules/knex/types/index.d.ts:506 - -___ - -### innerJoin - -• innerJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[innerJoin](../interfaces/knex.knex.queryinterface.md#innerjoin) - -Defined in: node_modules/knex/types/index.d.ts:479 - -___ - -### intersect - -• intersect: [Intersect](../interfaces/knex.knex.intersect.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[intersect](../interfaces/knex.knex.queryinterface.md#intersect) - -Defined in: node_modules/knex/types/index.d.ts:535 - -___ - -### into - -• into: [Table](../interfaces/knex.knex.table.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[into](../interfaces/knex.knex.queryinterface.md#into) - -Defined in: node_modules/knex/types/index.d.ts:471 - -___ - -### join - -• join: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[join](../interfaces/knex.knex.queryinterface.md#join) - -Defined in: node_modules/knex/types/index.d.ts:477 - -___ - -### joinRaw - -• joinRaw: [JoinRaw](../interfaces/knex.knex.joinraw.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[joinRaw](../interfaces/knex.knex.queryinterface.md#joinraw) - -Defined in: node_modules/knex/types/index.d.ts:478 - -___ - -### leftJoin - -• leftJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[leftJoin](../interfaces/knex.knex.queryinterface.md#leftjoin) - -Defined in: node_modules/knex/types/index.d.ts:480 - -___ - -### leftOuterJoin - -• leftOuterJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[leftOuterJoin](../interfaces/knex.knex.queryinterface.md#leftouterjoin) - -Defined in: node_modules/knex/types/index.d.ts:481 - -___ - -### max - -• max: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[max](../interfaces/knex.knex.queryinterface.md#max) - -Defined in: node_modules/knex/types/index.d.ts:583 - -___ - -### min - -• min: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[min](../interfaces/knex.knex.queryinterface.md#min) - -Defined in: node_modules/knex/types/index.d.ts:582 - -___ - -### not - -• not: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1590 - -___ - -### or - -• or: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1589 - -___ - -### orHaving - -• orHaving: [Having](../interfaces/knex.knex.having.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orHaving](../interfaces/knex.knex.queryinterface.md#orhaving) - -Defined in: node_modules/knex/types/index.d.ts:545 - -___ - -### orHavingBetween - -• orHavingBetween: [HavingRange](../interfaces/knex.knex.havingrange.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orHavingBetween](../interfaces/knex.knex.queryinterface.md#orhavingbetween) - -Defined in: node_modules/knex/types/index.d.ts:550 - -___ - -### orHavingNotBetween - -• orHavingNotBetween: [HavingRange](../interfaces/knex.knex.havingrange.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orHavingNotBetween](../interfaces/knex.knex.queryinterface.md#orhavingnotbetween) - -Defined in: node_modules/knex/types/index.d.ts:548 - -___ - -### orHavingRaw - -• orHavingRaw: [RawQueryBuilder](../interfaces/knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orHavingRaw](../interfaces/knex.knex.queryinterface.md#orhavingraw) - -Defined in: node_modules/knex/types/index.d.ts:546 - -___ - -### orWhere - -• orWhere: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhere](../interfaces/knex.knex.queryinterface.md#orwhere) - -Defined in: node_modules/knex/types/index.d.ts:498 - -___ - -### orWhereBetween - -• orWhereBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereBetween](../interfaces/knex.knex.queryinterface.md#orwherebetween) - -Defined in: node_modules/knex/types/index.d.ts:520 - -___ - -### orWhereExists - -• orWhereExists: [WhereExists](../interfaces/knex.knex.whereexists.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereExists](../interfaces/knex.knex.queryinterface.md#orwhereexists) - -Defined in: node_modules/knex/types/index.d.ts:508 - -___ - -### orWhereIn - -• orWhereIn: [WhereIn](../interfaces/knex.knex.wherein.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereIn](../interfaces/knex.knex.queryinterface.md#orwherein) - -Defined in: node_modules/knex/types/index.d.ts:512 - -___ - -### orWhereNot - -• orWhereNot: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNot](../interfaces/knex.knex.queryinterface.md#orwherenot) - -Defined in: node_modules/knex/types/index.d.ts:501 - -___ - -### orWhereNotBetween - -• orWhereNotBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNotBetween](../interfaces/knex.knex.queryinterface.md#orwherenotbetween) - -Defined in: node_modules/knex/types/index.d.ts:523 - -___ - -### orWhereNotExists - -• orWhereNotExists: [WhereExists](../interfaces/knex.knex.whereexists.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNotExists](../interfaces/knex.knex.queryinterface.md#orwherenotexists) - -Defined in: node_modules/knex/types/index.d.ts:510 - -___ - -### orWhereNotIn - -• orWhereNotIn: [WhereIn](../interfaces/knex.knex.wherein.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNotIn](../interfaces/knex.knex.queryinterface.md#orwherenotin) - -Defined in: node_modules/knex/types/index.d.ts:514 - -___ - -### orWhereNotNull - -• orWhereNotNull: [WhereNull](../interfaces/knex.knex.wherenull.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNotNull](../interfaces/knex.knex.queryinterface.md#orwherenotnull) - -Defined in: node_modules/knex/types/index.d.ts:518 - -___ - -### orWhereNull - -• orWhereNull: [WhereNull](../interfaces/knex.knex.wherenull.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereNull](../interfaces/knex.knex.queryinterface.md#orwherenull) - -Defined in: node_modules/knex/types/index.d.ts:516 - -___ - -### orWhereRaw - -• orWhereRaw: [WhereRaw](../interfaces/knex.knex.whereraw.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orWhereRaw](../interfaces/knex.knex.queryinterface.md#orwhereraw) - -Defined in: node_modules/knex/types/index.d.ts:503 - -___ - -### orderBy - -• orderBy: [OrderBy](../interfaces/knex.knex.orderby.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orderBy](../interfaces/knex.knex.queryinterface.md#orderby) - -Defined in: node_modules/knex/types/index.d.ts:531 - -___ - -### orderByRaw - -• orderByRaw: [RawQueryBuilder](../interfaces/knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[orderByRaw](../interfaces/knex.knex.queryinterface.md#orderbyraw) - -Defined in: node_modules/knex/types/index.d.ts:532 - -___ - -### outerJoin - -• outerJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[outerJoin](../interfaces/knex.knex.queryinterface.md#outerjoin) - -Defined in: node_modules/knex/types/index.d.ts:484 - -___ - -### rightJoin - -• rightJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[rightJoin](../interfaces/knex.knex.queryinterface.md#rightjoin) - -Defined in: node_modules/knex/types/index.d.ts:482 - -___ - -### rightOuterJoin - -• rightOuterJoin: [Join](../interfaces/knex.knex.join.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[rightOuterJoin](../interfaces/knex.knex.queryinterface.md#rightouterjoin) - -Defined in: node_modules/knex/types/index.d.ts:483 - -___ - -### select - -• select: [Select](../interfaces/knex.knex.select.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[select](../interfaces/knex.knex.queryinterface.md#select) - -Defined in: node_modules/knex/types/index.d.ts:466 - -___ - -### sum - -• sum: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[sum](../interfaces/knex.knex.queryinterface.md#sum) - -Defined in: node_modules/knex/types/index.d.ts:584 - -___ - -### sumDistinct - -• sumDistinct: [TypePreservingAggregation](../interfaces/knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[sumDistinct](../interfaces/knex.knex.queryinterface.md#sumdistinct) - -Defined in: node_modules/knex/types/index.d.ts:585 - -___ - -### table - -• table: [Table](../interfaces/knex.knex.table.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[table](../interfaces/knex.knex.queryinterface.md#table) - -Defined in: node_modules/knex/types/index.d.ts:472 - -___ - -### union - -• union: [Union](../interfaces/knex.knex.union.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[union](../interfaces/knex.knex.queryinterface.md#union) - -Defined in: node_modules/knex/types/index.d.ts:538 - -___ - -### unionAll - -• unionAll: [Union](../interfaces/knex.knex.union.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[unionAll](../interfaces/knex.knex.queryinterface.md#unionall) - -Defined in: node_modules/knex/types/index.d.ts:539 - -___ - -### where - -• where: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[where](../interfaces/knex.knex.queryinterface.md#where) - -Defined in: node_modules/knex/types/index.d.ts:496 - -___ - -### whereBetween - -• whereBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereBetween](../interfaces/knex.knex.queryinterface.md#wherebetween) - -Defined in: node_modules/knex/types/index.d.ts:519 - -___ - -### whereExists - -• whereExists: [WhereExists](../interfaces/knex.knex.whereexists.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereExists](../interfaces/knex.knex.queryinterface.md#whereexists) - -Defined in: node_modules/knex/types/index.d.ts:507 - -___ - -### whereIn - -• whereIn: [WhereIn](../interfaces/knex.knex.wherein.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereIn](../interfaces/knex.knex.queryinterface.md#wherein) - -Defined in: node_modules/knex/types/index.d.ts:511 - -___ - -### whereNot - -• whereNot: [Where](../interfaces/knex.knex.where.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNot](../interfaces/knex.knex.queryinterface.md#wherenot) - -Defined in: node_modules/knex/types/index.d.ts:499 - -___ - -### whereNotBetween - -• whereNotBetween: [WhereBetween](../interfaces/knex.knex.wherebetween.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNotBetween](../interfaces/knex.knex.queryinterface.md#wherenotbetween) - -Defined in: node_modules/knex/types/index.d.ts:522 - -___ - -### whereNotExists - -• whereNotExists: [WhereExists](../interfaces/knex.knex.whereexists.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNotExists](../interfaces/knex.knex.queryinterface.md#wherenotexists) - -Defined in: node_modules/knex/types/index.d.ts:509 - -___ - -### whereNotIn - -• whereNotIn: [WhereIn](../interfaces/knex.knex.wherein.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNotIn](../interfaces/knex.knex.queryinterface.md#wherenotin) - -Defined in: node_modules/knex/types/index.d.ts:513 - -___ - -### whereNotNull - -• whereNotNull: [WhereNull](../interfaces/knex.knex.wherenull.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNotNull](../interfaces/knex.knex.queryinterface.md#wherenotnull) - -Defined in: node_modules/knex/types/index.d.ts:517 - -___ - -### whereNull - -• whereNull: [WhereNull](../interfaces/knex.knex.wherenull.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereNull](../interfaces/knex.knex.queryinterface.md#wherenull) - -Defined in: node_modules/knex/types/index.d.ts:515 - -___ - -### whereRaw - -• whereRaw: [WhereRaw](../interfaces/knex.knex.whereraw.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereRaw](../interfaces/knex.knex.queryinterface.md#whereraw) - -Defined in: node_modules/knex/types/index.d.ts:502 - -___ - -### whereWrapped - -• whereWrapped: [WhereWrapped](../interfaces/knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[whereWrapped](../interfaces/knex.knex.queryinterface.md#wherewrapped) - -Defined in: node_modules/knex/types/index.d.ts:505 - -___ - -### with - -• with: [With](../interfaces/knex.knex.with.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[with](../interfaces/knex.knex.queryinterface.md#with) - -Defined in: node_modules/knex/types/index.d.ts:489 - -___ - -### withRaw - -• withRaw: [WithRaw](../interfaces/knex.knex.withraw.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[withRaw](../interfaces/knex.knex.queryinterface.md#withraw) - -Defined in: node_modules/knex/types/index.d.ts:491 - -___ - -### withRecursive - -• withRecursive: [With](../interfaces/knex.knex.with.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[withRecursive](../interfaces/knex.knex.queryinterface.md#withrecursive) - -Defined in: node_modules/knex/types/index.d.ts:490 - -___ - -### withSchema - -• withSchema: [WithSchema](../interfaces/knex.knex.withschema.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[withSchema](../interfaces/knex.knex.queryinterface.md#withschema) - -Defined in: node_modules/knex/types/index.d.ts:492 - -___ - -### withWrapped - -• withWrapped: [WithWrapped](../interfaces/knex.knex.withwrapped.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md).[withWrapped](../interfaces/knex.knex.queryinterface.md#withwrapped) - -Defined in: node_modules/knex/types/index.d.ts:493 - -## Methods - -### asCallback - -▸ asCallback(`callback`: Function): Promise<Resolve<TResult\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| Function \| - -Returns: Promise<Resolve<TResult\\>\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1657 - -___ - -### catch - -▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> - -Attaches a callback for only the rejection of the Promise. - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult` \| never \| - -#### Parameters: - -Name \| Type \| Description \| ------- \| ------ \| ------ \| -`onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| - -Returns: Promise<Resolve<TResult\\> \\\| TResult\\> - -A Promise for the completion of the callback. - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 - -___ - -### clear - -▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:573 - -___ - -### clearCounters - -▸ clearCounters(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:572 - -___ - -### clearGroup - -▸ clearGroup(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:569 - -___ - -### clearHaving - -▸ clearHaving(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:571 - -___ - -### clearOrder - -▸ clearOrder(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:570 - -___ - -### clearSelect - -▸ clearSelect(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:554 - -___ - -### clearWhere - -▸ clearWhere(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:568 - -___ - -### clone - -▸ clone(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1612 - -___ - -### columnInfo - -▸ columnInfo(`column?`: keyof TRecord): Promise<[ColumnInfo](../interfaces/knex.knex.columninfo.md)\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column?` \| keyof TRecord \| - -Returns: Promise<[ColumnInfo](../interfaces/knex.knex.columninfo.md)\\> - -Defined in: node_modules/knex/types/index.d.ts:1594 - -___ - -### connection - -▸ connection(`connection`: any): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`connection` \| any \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1644 - -___ - -### debug - -▸ debug(`enabled`: boolean): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`enabled` \| boolean \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1645 - -___ - -### decrement - -▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:598 - -▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:602 - -___ - -### del - -▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:832 - -▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:836 - -▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:847 - -▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:858 - -▸ del<TResult2\\>(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:862 - -___ - -### delete - -▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:864 - -▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:868 - -▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:879 - -▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:890 - -▸ delete<TResult2\\>(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:894 - -___ - -### finally - -▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> - -Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback. - -#### Parameters: - -Name \| Type \| Description \| ------- \| ------ \| ------ \| -`onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| - -Returns: Promise<Resolve<TResult\\>\\> - -A Promise for the completion of the callback. - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 - -___ - -### forShare - -▸ forShare(...`tableNames`: string[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...tableNames` \| string[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1599 - -▸ forShare(`tableNames`: readonly string[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableNames` \| readonly string[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1600 - -___ - -### forUpdate - -▸ forUpdate(...`tableNames`: string[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...tableNames` \| string[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1596 - -▸ forUpdate(`tableNames`: readonly string[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableNames` \| readonly string[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1597 - -___ - -### increment - -▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:589 - -▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:593 - -___ - -### insert - -▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| * \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:615 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:622 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:636 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:650 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:664 - -▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:678 - -___ - -### limit - -▸ limit(`limit`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`limit` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:577 - -___ - -### modify - -▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord2` \| {} \| any \| -`TResult2` \| {} \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| -`...args` \| any[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:684 - -___ - -### noWait - -▸ noWait(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1603 - -___ - -### offset - -▸ offset(`offset`: number): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`offset` \| number \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:576 - -___ - -### on - -▸ on(`event`: string, `callback`: Function): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \| -`callback` \| Function \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1607 - -___ - -### onConflict - -▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](../interfaces/knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| - -Returns: [OnConflictQueryBuilder](../interfaces/knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:812 - -▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](../interfaces/knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| - -Returns: [OnConflictQueryBuilder](../interfaces/knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:822 - -___ - -### options - -▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`options` \| Readonly<{ [key: string]: any; }\\> \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1643 - -___ - -### pipe - -▸ pipe<T\\>(`writable`: T, `options?`: Readonly<{ [key: string]: any; }\\>): PassThrough - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`T` \| WritableStream<T\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`writable` \| T \| -`options?` \| Readonly<{ [key: string]: any; }\\> \| - -Returns: PassThrough - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1653 - -___ - -### pluck - -▸ pluck<K\\>(`column`: K): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| K \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:610 - -▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`TResult2` \| {} \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:613 - -___ - -### queryContext - -▸ queryContext(`context`: any): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1609 - -▸ queryContext(): any - -Returns: any - -Defined in: node_modules/knex/types/index.d.ts:1610 - -___ - -### returning - -▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:785 - -▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:786 - -▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:797 - -▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:807 - -___ - -### skipLocked - -▸ skipLocked(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1602 - -___ - -### stream - -▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`handler` \| (`readable`: PassThrough) => any \| - -Returns: Promise<any\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1647 - -▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`options` \| Readonly<{ [key: string]: any; }\\> \| -`handler` \| (`readable`: PassThrough) => any \| - -Returns: Promise<any\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1648 - -▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`options?` \| Readonly<{ [key: string]: any; }\\> \| - -Returns: PassThrough - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1652 - -___ - -### then - -▸ then<TResult1, TResult2\\>(`onfulfilled?`: null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\>, `onrejected?`: null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\>): Promise<TResult1 \\\| TResult2\\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult1` \| Resolve<TResult\\\\> \| -`TResult2` \| never \| - -#### Parameters: - -Name \| Type \| Description \| ------- \| ------ \| ------ \| -`onfulfilled?` \| null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| -`onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| - -Returns: Promise<TResult1 \\\| TResult2\\> - -A Promise for the completion of which ever callback is executed. - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 - -___ - -### timeout - -▸ timeout(`ms`: number, `options?`: { `cancel?`: undefined \\\| boolean }): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`ms` \| number \| -`options?` \| { `cancel?`: undefined \\\| boolean } \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1613 - -___ - -### toQuery - -▸ toQuery(): string - -Returns: string - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1642 - -___ - -### toSQL - -▸ toSQL(): [Sql](../interfaces/knex.knex.sql.md) - -Returns: [Sql](../interfaces/knex.knex.sql.md) - -Defined in: node_modules/knex/types/index.d.ts:1605 - -___ - -### transacting - -▸ transacting(`trx`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> - -Inherited from: [ChainableInterface](../interfaces/knex.knex.chainableinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:1646 - -___ - -### truncate - -▸ truncate(): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, void\\> - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, void\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:896 - -___ - -### update - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| K2 \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:688 - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| readonly K2[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:702 - -▸ update<K\\>(`columnName`: K, `value`: Readonly<TRecord[K]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<TRecord[K]\\>\\>): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`value` \| Readonly<TRecord[K]\\> \\\| Readonly<[Raw](../interfaces/knex.knex.raw.md)<TRecord[K]\\>\\> \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, number\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:716 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:720 - -▸ update(`data`: Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:726 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:731 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:743 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| string \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \\\| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:755 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:767 - -▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[]): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:779 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Inherited from: [QueryInterface](../interfaces/knex.knex.queryinterface.md) - -Defined in: node_modules/knex/types/index.d.ts:783 - -___ - -### extend - -▸ `Static`extend(`methodName`: string, `fn`: <TRecord, TResult\\>(...`args`: any[]) => [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\>): void - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`methodName` \| string \| -`fn` \| <TRecord, TResult\\>(...`args`: any[]) => [QueryBuilder](knex.knex.querybuilder.md)<TRecord, TResult\\> \| - -Returns: void - -Defined in: node_modules/knex/types/index.d.ts:2230 diff --git a/knex.knex.seeder.md b/knex.knex.seeder.md index d5b37a2..39a413f 100644 --- a/knex.knex.seeder.md +++ b/knex.knex.seeder.md @@ -1,79 +0,0 @@ ---- -id: "knex.knex.seeder" -title: "Class: Seeder" -sidebar_label: "Seeder" -hide_title: true ---- - -# Class: Seeder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Seeder - -## Hierarchy - -* Seeder - -## Constructors - -### constructor - -\\+ new Seeder(`knex`: Knex<any, unknown[]\\>): [Seeder](knex.knex.seeder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`knex` \| Knex<any, unknown[]\\> \| - -Returns: [Seeder](knex.knex.seeder.md) - -Defined in: node_modules/knex/types/index.d.ts:2152 - -## Methods - -### make - -▸ make(`name`: string, `config?`: [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\>): Promise<string\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`name` \| string \| -`config?` \| [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\> \| - -Returns: Promise<string\\> - -Defined in: node_modules/knex/types/index.d.ts:2156 - -___ - -### run - -▸ run(`config?`: [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\>): Promise<[string[]]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\> \| - -Returns: Promise<[string[]]\\> - -Defined in: node_modules/knex/types/index.d.ts:2155 - -___ - -### setConfig - -▸ setConfig(`config`: [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\>): [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config` \| [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\> \| - -Returns: [SeederConfig](../interfaces/knex.knex.seederconfig.md)<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2154 diff --git a/knex.querybuilderhelper.md b/knex.querybuilderhelper.md index 91f4ef1..c705ff8 100644 --- a/knex.querybuilderhelper.md +++ b/knex.querybuilderhelper.md @@ -0,0 +1,617 @@ +--- +id: "knex.querybuilderhelper" +title: "Class: QueryBuilderHelper" +sidebar_label: "QueryBuilderHelper" +custom_edit_url: null +hide_title: true +--- + +# Class: QueryBuilderHelper + +[knex](../modules/knex.md).QueryBuilderHelper + +## Constructors + +### constructor + +\\+ new QueryBuilderHelper(`entityName`: string, `alias`: string, `aliasMap`: [Dictionary](../modules/core.md#dictionary)<string\\>, `subQueries`: [Dictionary](../modules/core.md#dictionary)<string\\>, `metadata`: [MetadataStorage](core.metadatastorage.md), `knex`: Knex<any, unknown[]\\>, `platform`: [Platform](core.platform.md)): [QueryBuilderHelper](knex.querybuilderhelper.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`alias` \| string \| +`aliasMap` \| [Dictionary](../modules/core.md#dictionary)<string\\> \| +`subQueries` \| [Dictionary](../modules/core.md#dictionary)<string\\> \| +`metadata` \| [MetadataStorage](core.metadatastorage.md) \| +`knex` \| Knex<any, unknown[]\\> \| +`platform` \| [Platform](core.platform.md) \| + +Returns: [QueryBuilderHelper](knex.querybuilderhelper.md) + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L20) + +## Methods + +### appendGroupCondition + +▸ `Private`appendGroupCondition(`type`: [QueryType](../enums/knex.querytype.md), `qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `operator`: $and \\\| $or, `method`: having \\\| where, `subCondition`: any[]): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| [QueryType](../enums/knex.querytype.md) \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`operator` \| $and \\\| $or \| +`method` \| having \\\| where \| +`subCondition` \| any[] \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:525](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L525) + +___ + +### appendJoinClause + +▸ `Private`appendJoinClause(`clause`: [JoinClause](../interfaces/knex.knex-1.joinclause.md), `cond`: [Dictionary](../modules/core.md#dictionary)<any\\>, `operator?`: $and \\\| $or): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`clause` \| [JoinClause](../interfaces/knex.knex-1.joinclause.md) \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`operator?` \| $and \\\| $or \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:369](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L369) + +___ + +### appendJoinSubClause + +▸ `Private`appendJoinSubClause(`clause`: [JoinClause](../interfaces/knex.knex-1.joinclause.md), `cond`: [Dictionary](../modules/core.md#dictionary)<any\\>, `key`: string, `operator?`: $and \\\| $or): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`clause` \| [JoinClause](../interfaces/knex.knex-1.joinclause.md) \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`key` \| string \| +`operator?` \| $and \\\| $or \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:387](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L387) + +___ + +### appendQueryCondition + +▸ appendQueryCondition(`type`: [QueryType](../enums/knex.querytype.md), `cond`: any, `qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `operator?`: $and \\\| $or, `method?`: having \\\| where): void + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`type` \| [QueryType](../enums/knex.querytype.md) \| - \| +`cond` \| any \| - \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| - \| +`operator?` \| $and \\\| $or \| - \| +`method` \| having \\\| where \| 'where' \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:260](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L260) + +___ + +### appendQuerySubCondition + +▸ `Private`appendQuerySubCondition(`qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `type`: [QueryType](../enums/knex.querytype.md), `method`: having \\\| where, `cond`: any, `key`: string, `operator?`: $and \\\| $or): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`type` \| [QueryType](../enums/knex.querytype.md) \| +`method` \| having \\\| where \| +`cond` \| any \| +`key` \| string \| +`operator?` \| $and \\\| $or \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:281](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L281) + +___ + +### fieldName + +▸ `Private`fieldName(`field`: string, `alias?`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`alias?` \| string \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:549](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L549) + +___ + +### finalize + +▸ finalize(`type`: [QueryType](../enums/knex.querytype.md), `qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| [QueryType](../enums/knex.querytype.md) \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:453](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L453) + +___ + +### getLockSQL + +▸ getLockSQL(`qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `lockMode?`: [LockMode](../enums/core.lockmode.md)): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`lockMode?` \| [LockMode](../enums/core.lockmode.md) \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:470](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L470) + +___ + +### getOperatorReplacement + +▸ `Private`getOperatorReplacement(`op`: string, `value`: [Dictionary](../modules/core.md#dictionary)<any\\>): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`op` \| string \| +`value` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L355) + +___ + +### getProperty + +▸ `Private`getProperty(`field`: string, `alias?`: string): undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`alias?` \| string \| + +Returns: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:564](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L564) + +___ + +### getQueryOrder + +▸ getQueryOrder(`type`: [QueryType](../enums/knex.querytype.md), `orderBy`: [FlatQueryOrderMap](../interfaces/core.flatqueryordermap.md), `populate`: [Dictionary](../modules/core.md#dictionary)<string\\>): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| [QueryType](../enums/knex.querytype.md) \| +`orderBy` \| [FlatQueryOrderMap](../interfaces/core.flatqueryordermap.md) \| +`populate` \| [Dictionary](../modules/core.md#dictionary)<string\\> \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:425](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L425) + +___ + +### getRegExpParam + +▸ getRegExpParam(`re`: RegExp): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`re` \| RegExp \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:237](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L237) + +___ + +### getTableName + +▸ getTableName(`entityName`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:220](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L220) + +___ + +### isOneToOneInverse + +▸ isOneToOneInverse(`field`: string): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| + +Returns: boolean + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:213](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L213) + +___ + +### isPrefixed + +▸ `Private`isPrefixed(`field`: string): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| + +Returns: boolean + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:545](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L545) + +___ + +### isSimpleRegExp + +▸ isSimpleRegExp(`re`: any): boolean + +Checks whether the RE can be rewritten to simple LIKE query + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`re` \| any \| + +Returns: boolean + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:228](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L228) + +___ + +### joinManyToManyReference + +▸ joinManyToManyReference(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `ownerAlias`: string, `alias`: string, `pivotAlias`: string, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `cond`: [Dictionary](../modules/core.md#dictionary)<any\\>, `path`: string): [Dictionary](../modules/core.md#dictionary)<[JoinOptions](../interfaces/knex.joinoptions.md)\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`ownerAlias` \| string \| +`alias` \| string \| +`pivotAlias` \| string \| +`type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`path` \| string \| + +Returns: [Dictionary](../modules/core.md#dictionary)<[JoinOptions](../interfaces/knex.joinoptions.md)\\> + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L146) + +___ + +### joinManyToOneReference + +▸ joinManyToOneReference(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `ownerAlias`: string, `alias`: string, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `cond?`: [Dictionary](../modules/core.md#dictionary)<any\\>): [JoinOptions](../interfaces/knex.joinoptions.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`ownerAlias` \| string \| +`alias` \| string \| +`type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: [JoinOptions](../interfaces/knex.joinoptions.md) + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:137](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L137) + +___ + +### joinOneToReference + +▸ joinOneToReference(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `ownerAlias`: string, `alias`: string, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `cond?`: [Dictionary](../modules/core.md#dictionary)<any\\>): [JoinOptions](../interfaces/knex.joinoptions.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`ownerAlias` \| string \| +`alias` \| string \| +`type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: [JoinOptions](../interfaces/knex.joinoptions.md) + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L123) + +___ + +### joinPivotTable + +▸ joinPivotTable(`field`: string, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `ownerAlias`: string, `alias`: string, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `cond?`: [Dictionary](../modules/core.md#dictionary)<any\\>): [JoinOptions](../interfaces/knex.joinoptions.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`ownerAlias` \| string \| +`alias` \| string \| +`type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: [JoinOptions](../interfaces/knex.joinoptions.md) + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L172) + +___ + +### mapJoinColumns + +▸ mapJoinColumns(`type`: [QueryType](../enums/knex.querytype.md), `join`: [JoinOptions](../interfaces/knex.joinoptions.md)): (string \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>)[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| [QueryType](../enums/knex.querytype.md) \| +`join` \| [JoinOptions](../interfaces/knex.joinoptions.md) \| + +Returns: (string \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>)[] + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:200](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L200) + +___ + +### mapper + +▸ mapper(`field`: string, `type?`: [QueryType](../enums/knex.querytype.md)): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`type?` \| [QueryType](../enums/knex.querytype.md) \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L30) + +▸ mapper(`field`: string, `type?`: [QueryType](../enums/knex.querytype.md), `value?`: any, `alias?`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`type?` \| [QueryType](../enums/knex.querytype.md) \| +`value?` \| any \| +`alias?` \| string \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L31) + +___ + +### prefix + +▸ `Private`prefix(`field`: string, `always?`: boolean, `quote?`: boolean): string + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`field` \| string \| - \| +`always` \| boolean \| false \| +`quote` \| boolean \| false \| + +Returns: string + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:507](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L507) + +___ + +### processCustomExpression + +▸ `Private`processCustomExpression<T\\>(`clause`: any, `m`: string, `key`: string, `cond`: any, `type?`: [QueryType](../enums/knex.querytype.md)): void + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| any[] \| any[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`clause` \| any \| +`m` \| string \| +`key` \| string \| +`cond` \| any \| +`type` \| [QueryType](../enums/knex.querytype.md) \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:305](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L305) + +___ + +### processData + +▸ processData(`data`: [Dictionary](../modules/core.md#dictionary)<any\\>, `convertCustomTypes`: boolean, `multi?`: boolean): any + +#### Parameters: + +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`data` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| - \| +`convertCustomTypes` \| boolean \| - \| +`multi` \| boolean \| false \| + +Returns: any + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:74](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L74) + +___ + +### processJoins + +▸ processJoins(`qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `joins`: [Dictionary](../modules/core.md#dictionary)<[JoinOptions](../interfaces/knex.joinoptions.md)\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`joins` \| [Dictionary](../modules/core.md#dictionary)<[JoinOptions](../interfaces/knex.joinoptions.md)\\> \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:184](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L184) + +___ + +### processObjectSubClause + +▸ `Private`processObjectSubClause(`cond`: any, `key`: string, `clause`: [JoinClause](../interfaces/knex.knex-1.joinclause.md), `m`: andOn \\\| orOn): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`cond` \| any \| +`key` \| string \| +`clause` \| [JoinClause](../interfaces/knex.knex-1.joinclause.md) \| +`m` \| andOn \\\| orOn \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:406](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L406) + +___ + +### processObjectSubCondition + +▸ `Private`processObjectSubCondition(`cond`: any, `key`: string, `qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `method`: having \\\| where, `m`: having \\\| where \\\| orWhere, `type`: [QueryType](../enums/knex.querytype.md)): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`cond` \| any \| +`key` \| string \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`method` \| having \\\| where \| +`m` \| having \\\| where \\\| orWhere \| +`type` \| [QueryType](../enums/knex.querytype.md) \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:320](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L320) + +___ + +### splitField + +▸ splitField(`field`: string): [string, string] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| + +Returns: [string, string] + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:462](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L462) + +___ + +### updateVersionProperty + +▸ updateVersionProperty(`qb`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `data`: [Dictionary](../modules/core.md#dictionary)<any\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`qb` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| +`data` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: void + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:486](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L486) + +___ + +### isCustomExpression + +▸ `Static`isCustomExpression(`field`: string): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`field` \| string \| + +Returns: boolean + +Defined in: [packages/knex/src/query/QueryBuilderHelper.ts:503](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilderHelper.ts#L503) diff --git a/core.assignoptions.md b/core.assignoptions.md index 87cfea5..2114ac7 100644 --- a/core.assignoptions.md +++ b/core.assignoptions.md @@ -0,0 +1,59 @@ +--- +id: "core.assignoptions" +title: "Interface: AssignOptions" +sidebar_label: "AssignOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: AssignOptions + +[core](../modules/core.md).AssignOptions + +## Properties + +### convertCustomTypes + +• `Optional` convertCustomTypes: boolean + +Defined in: [packages/core/src/entity/EntityAssigner.ts:188](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L188) + +___ + +### em + +• `Optional` em: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> + +Defined in: [packages/core/src/entity/EntityAssigner.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L191) + +___ + +### merge + +• `Optional` merge: boolean + +Defined in: [packages/core/src/entity/EntityAssigner.ts:190](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L190) + +___ + +### mergeObjects + +• `Optional` mergeObjects: boolean + +Defined in: [packages/core/src/entity/EntityAssigner.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L189) + +___ + +### onlyProperties + +• `Optional` onlyProperties: boolean + +Defined in: [packages/core/src/entity/EntityAssigner.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L187) + +___ + +### updateNestedEntities + +• `Optional` updateNestedEntities: boolean + +Defined in: [packages/core/src/entity/EntityAssigner.ts:186](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L186) diff --git a/core.connectionoptions.md b/core.connectionoptions.md index 93016e8..21bb4aa 100644 --- a/core.connectionoptions.md +++ b/core.connectionoptions.md @@ -0,0 +1,105 @@ +--- +id: "core.connectionoptions" +title: "Interface: ConnectionOptions" +sidebar_label: "ConnectionOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: ConnectionOptions + +[core](../modules/core.md).ConnectionOptions + +## Hierarchy + +* ConnectionOptions + + ↳ [MikroORMOptions](core.mikroormoptions.md) + +## Properties + +### charset + +• `Optional` charset: string + +Defined in: [packages/core/src/utils/Configuration.ts:296](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L296) + +___ + +### clientUrl + +• `Optional` clientUrl: string + +Defined in: [packages/core/src/utils/Configuration.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L291) + +___ + +### collate + +• `Optional` collate: string + +Defined in: [packages/core/src/utils/Configuration.ts:297](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L297) + +___ + +### dbName + +• `Optional` dbName: string + +Defined in: [packages/core/src/utils/Configuration.ts:289](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L289) + +___ + +### host + +• `Optional` host: string + +Defined in: [packages/core/src/utils/Configuration.ts:292](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L292) + +___ + +### multipleStatements + +• `Optional` multipleStatements: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:298](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L298) + +___ + +### name + +• `Optional` name: string + +Defined in: [packages/core/src/utils/Configuration.ts:290](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L290) + +___ + +### password + +• `Optional` password: string + +Defined in: [packages/core/src/utils/Configuration.ts:295](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L295) + +___ + +### pool + +• `Optional` pool: [PoolConfig](core.poolconfig.md) + +Defined in: [packages/core/src/utils/Configuration.ts:299](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L299) + +___ + +### port + +• `Optional` port: number + +Defined in: [packages/core/src/utils/Configuration.ts:293](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L293) + +___ + +### user + +• `Optional` user: string + +Defined in: [packages/core/src/utils/Configuration.ts:294](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L294) diff --git a/core.countoptions.md b/core.countoptions.md index aaea710..a29222f 100644 --- a/core.countoptions.md +++ b/core.countoptions.md @@ -0,0 +1,57 @@ +--- +id: "core.countoptions" +title: "Interface: CountOptions<T>" +sidebar_label: "CountOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: CountOptions<T\\> + +[core](../modules/core.md).CountOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Properties + +### cache + +• `Optional` cache: number \\\| boolean \\\| [string, number] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:114](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L114) + +___ + +### filters + +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L110) + +___ + +### groupBy + +• `Optional` groupBy: string \\\| string[] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L112) + +___ + +### having + +• `Optional` having: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:113](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L113) + +___ + +### schema + +• `Optional` schema: string + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:111](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L111) diff --git a/core.entityproperty.md b/core.entityproperty.md index 473e1e4..2209451 100644 --- a/core.entityproperty.md +++ b/core.entityproperty.md @@ -0,0 +1,571 @@ +--- +id: "core.entityproperty" +title: "Interface: EntityProperty<T>" +sidebar_label: "EntityProperty" +custom_edit_url: null +hide_title: true +--- + +# Interface: EntityProperty<T\\> + +[core](../modules/core.md).EntityProperty + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| + +## Properties + +### array + +• `Optional` array: boolean + +Defined in: [packages/core/src/typings.ts:135](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L135) + +___ + +### cascade + +• cascade: [Cascade](../enums/core.cascade.md)[] + +Defined in: [packages/core/src/typings.ts:164](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L164) + +___ + +### columnTypes + +• columnTypes: string[] + +Defined in: [packages/core/src/typings.ts:130](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L130) + +___ + +### comment + +• `Optional` comment: string + +Defined in: [packages/core/src/typings.ts:185](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L185) + +___ + +### customType + +• customType: [Type](../classes/core.type.md)<any, any\\> + +Defined in: [packages/core/src/typings.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L131) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean + +Defined in: [packages/core/src/typings.ts:141](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L141) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Defined in: [packages/core/src/typings.ts:142](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L142) + +___ + +### eager + +• `Optional` eager: boolean + +Defined in: [packages/core/src/typings.ts:160](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L160) + +___ + +### embeddable + +• embeddable: [Constructor](../modules/core.md#constructor)<T\\> + +Defined in: [packages/core/src/typings.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L146) + +___ + +### embedded + +• `Optional` embedded: [string, string] + +Defined in: [packages/core/src/typings.ts:145](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L145) + +___ + +### embeddedProps + +• embeddedProps: [Dictionary](../modules/core.md#dictionary)<[EntityProperty](core.entityproperty.md)<any\\>\\> + +Defined in: [packages/core/src/typings.ts:147](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L147) + +___ + +### entity + +• entity: () => [EntityName](../modules/core.md#entityname)<T\\> + +#### Type declaration: + +▸ (): [EntityName](../modules/core.md#entityname)<T\\> + +Returns: [EntityName](../modules/core.md#entityname)<T\\> + +Defined in: [packages/core/src/typings.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L127) + +Defined in: [packages/core/src/typings.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L127) + +___ + +### enum + +• `Optional` enum: boolean + +Defined in: [packages/core/src/typings.ts:157](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L157) + +___ + +### fieldNameRaw + +• `Optional` fieldNameRaw: string + +Defined in: [packages/core/src/typings.ts:140](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L140) + +___ + +### fieldNames + +• fieldNames: string[] + +Defined in: [packages/core/src/typings.ts:139](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L139) + +___ + +### fixedOrder + +• `Optional` fixedOrder: boolean + +Defined in: [packages/core/src/typings.ts:175](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L175) + +___ + +### fixedOrderColumn + +• `Optional` fixedOrderColumn: string + +Defined in: [packages/core/src/typings.ts:176](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L176) + +___ + +### formula + +• `Optional` formula: (`alias`: string) => string + +#### Type declaration: + +▸ (`alias`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| + +Returns: string + +Defined in: [packages/core/src/typings.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L143) + +Defined in: [packages/core/src/typings.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L143) + +___ + +### getter + +• `Optional` getter: boolean + +Defined in: [packages/core/src/typings.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L162) + +___ + +### getterName + +• `Optional` getterName: keyof T + +Defined in: [packages/core/src/typings.ts:163](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L163) + +___ + +### hidden + +• `Optional` hidden: boolean + +Defined in: [packages/core/src/typings.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L156) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Defined in: [packages/core/src/typings.ts:149](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L149) + +___ + +### inherited + +• `Optional` inherited: boolean + +Defined in: [packages/core/src/typings.ts:152](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L152) + +___ + +### inverseJoinColumns + +• inverseJoinColumns: string[] + +Defined in: [packages/core/src/typings.ts:179](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L179) + +___ + +### inversedBy + +• inversedBy: string + +Defined in: [packages/core/src/typings.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L172) + +___ + +### items + +• `Optional` items: (string \\\| number)[] + +Defined in: [packages/core/src/typings.ts:158](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L158) + +___ + +### joinColumns + +• joinColumns: string[] + +Defined in: [packages/core/src/typings.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L178) + +___ + +### lazy + +• `Optional` lazy: boolean + +Defined in: [packages/core/src/typings.ts:134](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L134) + +___ + +### length + +• `Optional` length: any + +Defined in: [packages/core/src/typings.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L136) + +___ + +### mapToPk + +• `Optional` mapToPk: boolean + +Defined in: [packages/core/src/typings.ts:154](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L154) + +___ + +### mappedBy + +• mappedBy: string + +Defined in: [packages/core/src/typings.ts:173](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L173) + +___ + +### name + +• name: string & keyof T + +Defined in: [packages/core/src/typings.ts:126](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L126) + +___ + +### nullable + +• `Optional` nullable: boolean + +Defined in: [packages/core/src/typings.ts:151](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L151) + +___ + +### object + +• `Optional` object: boolean + +Defined in: [packages/core/src/typings.ts:148](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L148) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/typings.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L166) + +Defined in: [packages/core/src/typings.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L166) + +___ + +### onDelete + +• `Optional` onDelete: string + +Defined in: [packages/core/src/typings.ts:168](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L168) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/typings.ts:167](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L167) + +Defined in: [packages/core/src/typings.ts:167](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L167) + +___ + +### onUpdateIntegrity + +• `Optional` onUpdateIntegrity: string + +Defined in: [packages/core/src/typings.ts:169](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L169) + +___ + +### orderBy + +• `Optional` orderBy: object + +#### Type declaration: + +Defined in: [packages/core/src/typings.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L174) + +___ + +### orphanRemoval + +• `Optional` orphanRemoval: boolean + +Defined in: [packages/core/src/typings.ts:165](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L165) + +___ + +### owner + +• owner: boolean + +Defined in: [packages/core/src/typings.ts:171](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L171) + +___ + +### persist + +• `Optional` persist: boolean + +Defined in: [packages/core/src/typings.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L155) + +___ + +### pivotTable + +• pivotTable: string + +Defined in: [packages/core/src/typings.ts:177](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L177) + +___ + +### prefix + +• `Optional` prefix: string \\\| boolean + +Defined in: [packages/core/src/typings.ts:144](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L144) + +___ + +### primary + +• primary: boolean + +Defined in: [packages/core/src/typings.ts:132](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L132) + +___ + +### reference + +• reference: [ReferenceType](../enums/core.referencetype.md) + +Defined in: [packages/core/src/typings.ts:137](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L137) + +___ + +### referencedColumnNames + +• referencedColumnNames: string[] + +Defined in: [packages/core/src/typings.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L180) + +___ + +### referencedPKs + +• referencedPKs: string[] + +Defined in: [packages/core/src/typings.ts:182](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L182) + +___ + +### referencedTableName + +• referencedTableName: string + +Defined in: [packages/core/src/typings.ts:181](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L181) + +___ + +### serializedName + +• `Optional` serializedName: string + +Defined in: [packages/core/src/typings.ts:184](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L184) + +___ + +### serializedPrimaryKey + +• serializedPrimaryKey: boolean + +Defined in: [packages/core/src/typings.ts:133](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L133) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/typings.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L183) + +Defined in: [packages/core/src/typings.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L183) + +___ + +### setter + +• `Optional` setter: boolean + +Defined in: [packages/core/src/typings.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L161) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Defined in: [packages/core/src/typings.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L170) + +___ + +### targetMeta + +• `Optional` targetMeta: [EntityMetadata](../classes/core.entitymetadata.md)<any\\> + +Defined in: [packages/core/src/typings.ts:129](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L129) + +___ + +### type + +• type: string + +Defined in: [packages/core/src/typings.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L128) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Defined in: [packages/core/src/typings.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L150) + +___ + +### unsigned + +• unsigned: boolean + +Defined in: [packages/core/src/typings.ts:153](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L153) + +___ + +### userDefined + +• `Optional` userDefined: boolean + +Defined in: [packages/core/src/typings.ts:186](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L186) + +___ + +### version + +• `Optional` version: boolean + +Defined in: [packages/core/src/typings.ts:159](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L159) + +___ + +### wrappedReference + +• `Optional` wrappedReference: boolean + +Defined in: [packages/core/src/typings.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L138) diff --git a/core.enumoptions.md b/core.enumoptions.md index 812341e..43c28d6 100644 --- a/core.enumoptions.md +++ b/core.enumoptions.md @@ -0,0 +1,331 @@ +--- +id: "core.enumoptions" +title: "Interface: EnumOptions<T>" +sidebar_label: "EnumOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: EnumOptions<T\\> + +[core](../modules/core.md).EnumOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Hierarchy + +* [PropertyOptions](../modules/core.md#propertyoptions)<T\\> + + ↳ EnumOptions + +## Properties + +### array + +• `Optional` array: boolean + +Defined in: [packages/core/src/decorators/Enum.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Enum.ts#L19) + +___ + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### items + +• `Optional` items: (string \\\| number)[] \\\| () => [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/decorators/Enum.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Enum.ts#L18) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### type + +• `Optional` type: unknown + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.eventsubscriber.md b/core.eventsubscriber.md index 8263663..3d7e8a7 100644 --- a/core.eventsubscriber.md +++ b/core.eventsubscriber.md @@ -0,0 +1,283 @@ +--- +id: "core.eventsubscriber" +title: "Interface: EventSubscriber<T>" +sidebar_label: "EventSubscriber" +custom_edit_url: null +hide_title: true +--- + +# Interface: EventSubscriber<T\\> + +[core](../modules/core.md).EventSubscriber + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`T` \| any \| + +## Methods + +### afterCreate + +▸ `Optional`afterCreate(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L25) + +___ + +### afterDelete + +▸ `Optional`afterDelete(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L29) + +___ + +### afterFlush + +▸ `Optional`afterFlush(`args`: [FlushEventArgs](core.flusheventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [FlushEventArgs](core.flusheventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L32) + +___ + +### afterTransactionCommit + +▸ `Optional`afterTransactionCommit(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L37) + +___ + +### afterTransactionRollback + +▸ `Optional`afterTransactionRollback(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L39) + +___ + +### afterTransactionStart + +▸ `Optional`afterTransactionStart(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L35) + +___ + +### afterUpdate + +▸ `Optional`afterUpdate(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L27) + +___ + +### beforeCreate + +▸ `Optional`beforeCreate(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L24) + +___ + +### beforeDelete + +▸ `Optional`beforeDelete(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L28) + +___ + +### beforeFlush + +▸ `Optional`beforeFlush(`args`: [FlushEventArgs](core.flusheventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [FlushEventArgs](core.flusheventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L30) + +___ + +### beforeTransactionCommit + +▸ `Optional`beforeTransactionCommit(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L36) + +___ + +### beforeTransactionRollback + +▸ `Optional`beforeTransactionRollback(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L38) + +___ + +### beforeTransactionStart + +▸ `Optional`beforeTransactionStart(`args`: [TransactionEventArgs](core.transactioneventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [TransactionEventArgs](core.transactioneventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L34) + +___ + +### beforeUpdate + +▸ `Optional`beforeUpdate(`args`: [EventArgs](core.eventargs.md)<T\\>): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L26) + +___ + +### getSubscribedEntities + +▸ `Optional`getSubscribedEntities(): [EntityName](../modules/core.md#entityname)<T\\>[] + +Returns: [EntityName](../modules/core.md#entityname)<T\\>[] + +Defined in: [packages/core/src/events/EventSubscriber.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L22) + +___ + +### onFlush + +▸ `Optional`onFlush(`args`: [FlushEventArgs](core.flusheventargs.md)): Promise<void\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [FlushEventArgs](core.flusheventargs.md) \| + +Returns: Promise<void\\> + +Defined in: [packages/core/src/events/EventSubscriber.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L31) + +___ + +### onInit + +▸ `Optional`onInit(`args`: [EventArgs](core.eventargs.md)<T\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`args` \| [EventArgs](core.eventargs.md)<T\\> \| + +Returns: void + +Defined in: [packages/core/src/events/EventSubscriber.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L23) diff --git a/core.findoneoptions.md b/core.findoneoptions.md index 85a5a8a..c0f4f0f 100644 --- a/core.findoneoptions.md +++ b/core.findoneoptions.md @@ -0,0 +1,172 @@ +--- +id: "core.findoneoptions" +title: "Interface: FindOneOptions<T, P>" +sidebar_label: "FindOneOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: FindOneOptions<T, P\\> + +[core](../modules/core.md).FindOneOptions + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| - \| - \| +`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\> \| + +## Hierarchy + +* Omit<[FindOptions](core.findoptions.md)<T, P\\>, limit \\\| offset\\> + + ↳ FindOneOptions + + ↳↳ [FindOneOrFailOptions](core.findoneorfailoptions.md) + +## Properties + +### cache + +• `Optional` cache: number \\\| boolean \\\| [string, number] + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L85) + +___ + +### convertCustomTypes + +• `Optional` convertCustomTypes: boolean + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L89) + +___ + +### disableIdentityMap + +• `Optional` disableIdentityMap: boolean + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L90) + +___ + +### fields + +• `Optional` fields: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L91) + +___ + +### filters + +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L97) + +___ + +### flags + +• `Optional` flags: [QueryFlag](../enums/core.queryflag.md)[] + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L93) + +___ + +### groupBy + +• `Optional` groupBy: string \\\| string[] + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L94) + +___ + +### having + +• `Optional` having: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L95) + +___ + +### lockMode + +• `Optional` lockMode: [LockMode](../enums/core.lockmode.md) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L101) + +___ + +### lockVersion + +• `Optional` lockVersion: number \\\| Date + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L102) + +___ + +### orderBy + +• `Optional` orderBy: [QueryOrderMap](core.queryordermap.md) + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L84) + +___ + +### populate + +• `Optional` populate: P + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L83) + +___ + +### refresh + +• `Optional` refresh: boolean + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L88) + +___ + +### schema + +• `Optional` schema: string + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L92) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Inherited from: void + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L96) diff --git a/core.findoptions.md b/core.findoptions.md index 354ec59..0851255 100644 --- a/core.findoptions.md +++ b/core.findoptions.md @@ -0,0 +1,144 @@ +--- +id: "core.findoptions" +title: "Interface: FindOptions<T, P>" +sidebar_label: "FindOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: FindOptions<T, P\\> + +[core](../modules/core.md).FindOptions + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| - \| - \| +`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\> \| + +## Hierarchy + +* FindOptions + + ↳ [MatchingOptions](core.matchingoptions.md) + +## Properties + +### cache + +• `Optional` cache: number \\\| boolean \\\| [string, number] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L85) + +___ + +### convertCustomTypes + +• `Optional` convertCustomTypes: boolean + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L89) + +___ + +### disableIdentityMap + +• `Optional` disableIdentityMap: boolean + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L90) + +___ + +### fields + +• `Optional` fields: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L91) + +___ + +### filters + +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L97) + +___ + +### flags + +• `Optional` flags: [QueryFlag](../enums/core.queryflag.md)[] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L93) + +___ + +### groupBy + +• `Optional` groupBy: string \\\| string[] + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L94) + +___ + +### having + +• `Optional` having: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L95) + +___ + +### limit + +• `Optional` limit: number + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L86) + +___ + +### offset + +• `Optional` offset: number + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L87) + +___ + +### orderBy + +• `Optional` orderBy: [QueryOrderMap](core.queryordermap.md) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L84) + +___ + +### populate + +• `Optional` populate: P + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L83) + +___ + +### refresh + +• `Optional` refresh: boolean + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L88) + +___ + +### schema + +• `Optional` schema: string + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L92) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L96) diff --git a/core.formulaoptions.md b/core.formulaoptions.md index 8eb39f0..fc2dbc8 100644 --- a/core.formulaoptions.md +++ b/core.formulaoptions.md @@ -0,0 +1,315 @@ +--- +id: "core.formulaoptions" +title: "Interface: FormulaOptions<T>" +sidebar_label: "FormulaOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: FormulaOptions<T\\> + +[core](../modules/core.md).FormulaOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Hierarchy + +* [PropertyOptions](../modules/core.md#propertyoptions)<T\\> + + ↳ FormulaOptions + +## Properties + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### type + +• `Optional` type: unknown + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.initoptions.md b/core.initoptions.md index 9f8d8f0..0883f0f 100644 --- a/core.initoptions.md +++ b/core.initoptions.md @@ -0,0 +1,41 @@ +--- +id: "core.initoptions" +title: "Interface: InitOptions<T>" +sidebar_label: "InitOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: InitOptions<T\\> + +[core](../modules/core.md).InitOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Properties + +### orderBy + +• `Optional` orderBy: [QueryOrderMap](core.queryordermap.md) + +Defined in: [packages/core/src/entity/Collection.ts:378](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L378) + +___ + +### populate + +• `Optional` populate: readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> + +Defined in: [packages/core/src/entity/Collection.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L377) + +___ + +### where + +• `Optional` where: [FilterQuery](../modules/core.md#filterquery)<T\\> + +Defined in: [packages/core/src/entity/Collection.ts:379](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L379) diff --git a/core.mikroormoptions.md b/core.mikroormoptions.md index 5d0cb10..3213d98 100644 --- a/core.mikroormoptions.md +++ b/core.mikroormoptions.md @@ -0,0 +1,556 @@ +--- +id: "core.mikroormoptions" +title: "Interface: MikroORMOptions<D>" +sidebar_label: "MikroORMOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: MikroORMOptions<D\\> + +[core](../modules/core.md).MikroORMOptions + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](core.idatabasedriver.md) \| [IDatabaseDriver](core.idatabasedriver.md) \| + +## Hierarchy + +* [ConnectionOptions](core.connectionoptions.md) + + ↳ MikroORMOptions + +## Properties + +### autoJoinOneToOneOwner + +• autoJoinOneToOneOwner: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:356](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L356) + +___ + +### baseDir + +• baseDir: string + +Defined in: [packages/core/src/utils/Configuration.ts:380](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L380) + +___ + +### batchSize + +• batchSize: number + +Defined in: [packages/core/src/utils/Configuration.ts:366](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L366) + +___ + +### cache + +• cache: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`adapter`? \| (...`params`: any[]) => [CacheAdapter](core.cacheadapter.md) \| +`enabled`? \| boolean \| +`options`? \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`pretty`? \| boolean \| + +Defined in: [packages/core/src/utils/Configuration.ts:382](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L382) + +___ + +### charset + +• `Optional` charset: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[charset](core.connectionoptions.md#charset) + +Defined in: [packages/core/src/utils/Configuration.ts:296](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L296) + +___ + +### clientUrl + +• `Optional` clientUrl: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[clientUrl](core.connectionoptions.md#clienturl) + +Defined in: [packages/core/src/utils/Configuration.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L291) + +___ + +### collate + +• `Optional` collate: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[collate](core.connectionoptions.md#collate) + +Defined in: [packages/core/src/utils/Configuration.ts:297](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L297) + +___ + +### context + +• context: (`name`: string) => undefined \\\| [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> + +#### Type declaration: + +▸ (`name`: string): undefined \\\| [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string \| + +Returns: undefined \\\| [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> + +Defined in: [packages/core/src/utils/Configuration.ts:373](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L373) + +Defined in: [packages/core/src/utils/Configuration.ts:373](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L373) + +___ + +### contextName + +• contextName: string + +Defined in: [packages/core/src/utils/Configuration.ts:374](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L374) + +___ + +### dbName + +• `Optional` dbName: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[dbName](core.connectionoptions.md#dbname) + +Defined in: [packages/core/src/utils/Configuration.ts:289](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L289) + +___ + +### debug + +• debug: boolean \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] + +Defined in: [packages/core/src/utils/Configuration.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L377) + +___ + +### discovery + +• discovery: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`alwaysAnalyseProperties`? \| boolean \| +`disableDynamicFileAccess`? \| boolean \| +`requireEntitiesArray`? \| boolean \| +`warnWhenNoEntities`? \| boolean \| + +Defined in: [packages/core/src/utils/Configuration.ts:345](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L345) + +___ + +### driver + +• `Optional` driver: (`config`: [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\>) => D + +#### Type declaration: + +\\+ new MikroORMOptions(`config`: [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\>): D + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config` \| [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> \| + +Returns: D + +Inherited from: void + +Defined in: [packages/core/src/utils/Configuration.ts:352](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L352) + +Defined in: [packages/core/src/utils/Configuration.ts:352](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L352) + +___ + +### driverOptions + +• driverOptions: [Dictionary](../modules/core.md#dictionary)<any\\> + +Defined in: [packages/core/src/utils/Configuration.ts:353](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L353) + +___ + +### ensureIndexes + +• ensureIndexes: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:363](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L363) + +___ + +### entities + +• entities: (string \\\| EntityClass<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| EntityClassGroup<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntitySchema](../classes/core.entityschema.md)<any, undefined\\>)[] + +Defined in: [packages/core/src/utils/Configuration.ts:341](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L341) + +___ + +### entitiesTs + +• entitiesTs: (string \\\| EntityClass<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| EntityClassGroup<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntitySchema](../classes/core.entityschema.md)<any, undefined\\>)[] + +Defined in: [packages/core/src/utils/Configuration.ts:342](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L342) + +___ + +### entityRepository + +• `Optional` entityRepository: [Constructor](../modules/core.md#constructor)<[EntityRepository](../classes/core.entityrepository.md)<any\\>\\> + +Defined in: [packages/core/src/utils/Configuration.ts:369](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L369) + +___ + +### filters + +• filters: [Dictionary](../modules/core.md#dictionary)<{ `name?`: string } & Omit<FilterDef<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, name\\>\\> + +Defined in: [packages/core/src/utils/Configuration.ts:344](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L344) + +___ + +### findOneOrFailHandler + +• findOneOrFailHandler: (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>) => Error + +#### Type declaration: + +▸ (`entityName`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>): Error + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`where` \| IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: Error + +Defined in: [packages/core/src/utils/Configuration.ts:376](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L376) + +Defined in: [packages/core/src/utils/Configuration.ts:376](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L376) + +___ + +### forceEntityConstructor + +• forceEntityConstructor: boolean \\\| (string \\\| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] + +Defined in: [packages/core/src/utils/Configuration.ts:359](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L359) + +___ + +### forceUndefined + +• forceUndefined: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:360](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L360) + +___ + +### forceUtcTimezone + +• forceUtcTimezone: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:361](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L361) + +___ + +### highlighter + +• highlighter: [Highlighter](core.highlighter.md) + +Defined in: [packages/core/src/utils/Configuration.ts:378](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L378) + +___ + +### host + +• `Optional` host: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[host](core.connectionoptions.md#host) + +Defined in: [packages/core/src/utils/Configuration.ts:292](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L292) + +___ + +### hydrator + +• hydrator: HydratorConstructor + +Defined in: [packages/core/src/utils/Configuration.ts:367](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L367) + +___ + +### implicitTransactions + +• `Optional` implicitTransactions: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L355) + +___ + +### loadStrategy + +• loadStrategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Defined in: [packages/core/src/utils/Configuration.ts:368](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L368) + +___ + +### logger + +• logger: (`message`: string) => void + +#### Type declaration: + +▸ (`message`: string): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`message` \| string \| + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:375](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L375) + +Defined in: [packages/core/src/utils/Configuration.ts:375](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L375) + +___ + +### metadataProvider + +• metadataProvider: (`config`: [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\>) => [MetadataProvider](../classes/core.metadataprovider.md) + +#### Type declaration: + +\\+ new MikroORMOptions(`config`: [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\>): [MetadataProvider](../classes/core.metadataprovider.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config` \| [Configuration](../classes/core.configuration.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> \| + +Returns: [MetadataProvider](../classes/core.metadataprovider.md) + +Inherited from: void + +Defined in: [packages/core/src/utils/Configuration.ts:393](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L393) + +Defined in: [packages/core/src/utils/Configuration.ts:393](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L393) + +___ + +### migrations + +• migrations: [MigrationsOptions](../modules/core.md#migrationsoptions) + +Defined in: [packages/core/src/utils/Configuration.ts:381](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L381) + +___ + +### multipleStatements + +• `Optional` multipleStatements: boolean + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[multipleStatements](core.connectionoptions.md#multiplestatements) + +Defined in: [packages/core/src/utils/Configuration.ts:298](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L298) + +___ + +### name + +• `Optional` name: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[name](core.connectionoptions.md#name) + +Defined in: [packages/core/src/utils/Configuration.ts:290](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L290) + +___ + +### namingStrategy + +• `Optional` namingStrategy: () => [NamingStrategy](core.namingstrategy.md) + +#### Type declaration: + +\\+ new MikroORMOptions(): [NamingStrategy](core.namingstrategy.md) + +Returns: [NamingStrategy](core.namingstrategy.md) + +Inherited from: void + +Defined in: [packages/core/src/utils/Configuration.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L354) + +Defined in: [packages/core/src/utils/Configuration.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L354) + +___ + +### password + +• `Optional` password: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[password](core.connectionoptions.md#password) + +Defined in: [packages/core/src/utils/Configuration.ts:295](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L295) + +___ + +### pool + +• `Optional` pool: [PoolConfig](core.poolconfig.md) + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[pool](core.connectionoptions.md#pool) + +Defined in: [packages/core/src/utils/Configuration.ts:299](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L299) + +___ + +### populateAfterFlush + +• populateAfterFlush: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:358](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L358) + +___ + +### port + +• `Optional` port: number + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[port](core.connectionoptions.md#port) + +Defined in: [packages/core/src/utils/Configuration.ts:293](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L293) + +___ + +### propagateToOneOwner + +• propagateToOneOwner: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:357](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L357) + +___ + +### replicas + +• `Optional` replicas: Partial<[ConnectionOptions](core.connectionoptions.md)\\>[] + +Defined in: [packages/core/src/utils/Configuration.ts:370](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L370) + +___ + +### resultCache + +• resultCache: object + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`adapter`? \| (...`params`: any[]) => [CacheAdapter](core.cacheadapter.md) \| +`expiration`? \| number \| +`options`? \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Defined in: [packages/core/src/utils/Configuration.ts:388](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L388) + +___ + +### strict + +• strict: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:371](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L371) + +___ + +### subscribers + +• subscribers: [EventSubscriber](core.eventsubscriber.md)<any\\>[] + +Defined in: [packages/core/src/utils/Configuration.ts:343](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L343) + +___ + +### timezone + +• `Optional` timezone: string + +Defined in: [packages/core/src/utils/Configuration.ts:362](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L362) + +___ + +### tsNode + +• `Optional` tsNode: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:379](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L379) + +___ + +### type + +• `Optional` type: mongo \\\| mysql \\\| mariadb \\\| postgresql \\\| sqlite + +Defined in: [packages/core/src/utils/Configuration.ts:351](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L351) + +___ + +### useBatchInserts + +• `Optional` useBatchInserts: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:364](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L364) + +___ + +### useBatchUpdates + +• `Optional` useBatchUpdates: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:365](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L365) + +___ + +### user + +• `Optional` user: string + +Inherited from: [ConnectionOptions](core.connectionoptions.md).[user](core.connectionoptions.md#user) + +Defined in: [packages/core/src/utils/Configuration.ts:294](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L294) + +___ + +### validate + +• validate: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:372](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L372) diff --git a/core.onetooneoptions.md b/core.onetooneoptions.md index 49cff67..53ba0c8 100644 --- a/core.onetooneoptions.md +++ b/core.onetooneoptions.md @@ -0,0 +1,474 @@ +--- +id: "core.onetooneoptions" +title: "Interface: OneToOneOptions<T, O>" +sidebar_label: "OneToOneOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: OneToOneOptions<T, O\\> + +[core](../modules/core.md).OneToOneOptions + +## Type parameters + +Name \| +:------ \| +`T` \| +`O` \| + +## Hierarchy + +* Partial<Omit<[OneToManyOptions](../modules/core.md#onetomanyoptions)<T, O\\>, orderBy\\>\\> + + ↳ OneToOneOptions + +## Properties + +### cascade + +• `Optional` cascade: [Cascade](../enums/core.cascade.md)[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L67) + +___ + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### eager + +• `Optional` eager: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L68) + +___ + +### entity + +• `Optional` entity: string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> & string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L66) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### inverseJoinColumn + +• `Optional` inverseJoinColumn: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L46) + +___ + +### inverseJoinColumns + +• `Optional` inverseJoinColumns: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L47) + +___ + +### inversedBy + +• `Optional` inversedBy: string & keyof T \\\| (`e`: T) => any + +Defined in: [packages/core/src/decorators/OneToOne.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L15) + +___ + +### joinColumn + +• `Optional` joinColumn: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L44) + +___ + +### joinColumns + +• `Optional` joinColumns: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L45) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### mapToPk + +• `Optional` mapToPk: boolean + +Defined in: [packages/core/src/decorators/OneToOne.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L18) + +___ + +### mappedBy + +• `Optional` mappedBy: string & keyof T \\\| (`e`: T) => any + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L49) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onDelete + +• `Optional` onDelete: string + +Defined in: [packages/core/src/decorators/OneToOne.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L19) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### onUpdateIntegrity + +• `Optional` onUpdateIntegrity: string + +Defined in: [packages/core/src/decorators/OneToOne.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L20) + +___ + +### orphanRemoval + +• `Optional` orphanRemoval: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L42) + +___ + +### owner + +• `Optional` owner: boolean + +Defined in: [packages/core/src/decorators/OneToOne.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L14) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Overrides: void + +Defined in: [packages/core/src/decorators/OneToOne.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L17) + +___ + +### referenceColumnName + +• `Optional` referenceColumnName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/OneToMany.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L48) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L69) + +___ + +### type + +• `Optional` type: unknown + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) + +___ + +### wrappedReference + +• `Optional` wrappedReference: boolean + +Defined in: [packages/core/src/decorators/OneToOne.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L16) diff --git a/core.poolconfig.md b/core.poolconfig.md index bf072af..06b96d6 100644 --- a/core.poolconfig.md +++ b/core.poolconfig.md @@ -0,0 +1,192 @@ +--- +id: "core.poolconfig" +title: "Interface: PoolConfig" +sidebar_label: "PoolConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: PoolConfig + +[core](../modules/core.md).PoolConfig + +## Properties + +### Promise + +• `Optional` Promise: any + +Defined in: [packages/core/src/utils/Configuration.ts:337](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L337) + +___ + +### acquireTimeoutMillis + +• `Optional` acquireTimeoutMillis: number + +Defined in: [packages/core/src/utils/Configuration.ts:331](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L331) + +___ + +### afterCreate + +• `Optional` afterCreate: (...`a`: unknown[]) => unknown + +#### Type declaration: + +▸ (...`a`: unknown[]): unknown + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...a` \| unknown[] \| + +Returns: unknown + +Defined in: [packages/core/src/utils/Configuration.ts:318](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L318) + +Defined in: [packages/core/src/utils/Configuration.ts:318](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L318) + +___ + +### autostart + +• `Optional` autostart: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:333](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L333) + +___ + +### evictionRunIntervalMillis + +• `Optional` evictionRunIntervalMillis: number + +Defined in: [packages/core/src/utils/Configuration.ts:334](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L334) + +___ + +### fifo + +• `Optional` fifo: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:332](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L332) + +___ + +### idleTimeoutMillis + +• `Optional` idleTimeoutMillis: number + +Defined in: [packages/core/src/utils/Configuration.ts:322](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L322) + +___ + +### log + +• `Optional` log: (`message`: string, `logLevel`: string) => void + +#### Type declaration: + +▸ (`message`: string, `logLevel`: string): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`message` \| string \| +`logLevel` \| string \| + +Returns: void + +Defined in: [packages/core/src/utils/Configuration.ts:326](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L326) + +Defined in: [packages/core/src/utils/Configuration.ts:326](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L326) + +___ + +### max + +• `Optional` max: number + +Defined in: [packages/core/src/utils/Configuration.ts:320](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L320) + +___ + +### maxWaitingClients + +• `Optional` maxWaitingClients: number + +Defined in: [packages/core/src/utils/Configuration.ts:329](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L329) + +___ + +### min + +• `Optional` min: number + +Defined in: [packages/core/src/utils/Configuration.ts:319](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L319) + +___ + +### name + +• `Optional` name: string + +Defined in: [packages/core/src/utils/Configuration.ts:317](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L317) + +___ + +### numTestsPerRun + +• `Optional` numTestsPerRun: number + +Defined in: [packages/core/src/utils/Configuration.ts:335](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L335) + +___ + +### priorityRange + +• `Optional` priorityRange: number + +Defined in: [packages/core/src/utils/Configuration.ts:325](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L325) + +___ + +### reapIntervalMillis + +• `Optional` reapIntervalMillis: number + +Defined in: [packages/core/src/utils/Configuration.ts:323](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L323) + +___ + +### refreshIdle + +• `Optional` refreshIdle: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:321](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L321) + +___ + +### returnToHead + +• `Optional` returnToHead: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:324](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L324) + +___ + +### softIdleTimeoutMillis + +• `Optional` softIdleTimeoutMillis: number + +Defined in: [packages/core/src/utils/Configuration.ts:336](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L336) + +___ + +### testOnBorrow + +• `Optional` testOnBorrow: boolean + +Defined in: [packages/core/src/utils/Configuration.ts:330](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L330) diff --git a/core.primarykeyoptions.md b/core.primarykeyoptions.md index ce5dfd6..7e22ef4 100644 --- a/core.primarykeyoptions.md +++ b/core.primarykeyoptions.md @@ -0,0 +1,315 @@ +--- +id: "core.primarykeyoptions" +title: "Interface: PrimaryKeyOptions<T>" +sidebar_label: "PrimaryKeyOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: PrimaryKeyOptions<T\\> + +[core](../modules/core.md).PrimaryKeyOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Hierarchy + +* [PropertyOptions](../modules/core.md#propertyoptions)<T\\> + + ↳ PrimaryKeyOptions + +## Properties + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### type + +• `Optional` type: unknown + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.referenceoptions.md b/core.referenceoptions.md index c77d62d..79386ec 100644 --- a/core.referenceoptions.md +++ b/core.referenceoptions.md @@ -0,0 +1,352 @@ +--- +id: "core.referenceoptions" +title: "Interface: ReferenceOptions<T, O>" +sidebar_label: "ReferenceOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: ReferenceOptions<T, O\\> + +[core](../modules/core.md).ReferenceOptions + +## Type parameters + +Name \| +:------ \| +`T` \| +`O` \| + +## Hierarchy + +* [PropertyOptions](../modules/core.md#propertyoptions)<O\\> + + ↳ ReferenceOptions + + ↳↳ [ManyToOneOptions](core.manytooneoptions.md) + + ↳↳ [ManyToManyOptions](core.manytomanyoptions.md) + +## Properties + +### cascade + +• `Optional` cascade: [Cascade](../enums/core.cascade.md)[] + +Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L67) + +___ + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### eager + +• `Optional` eager: boolean + +Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L68) + +___ + +### entity + +• `Optional` entity: string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> + +Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L66) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L69) + +___ + +### type + +• `Optional` type: unknown + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.serializedprimarykeyoptions.md b/core.serializedprimarykeyoptions.md index 815bf2e..2a6be06 100644 --- a/core.serializedprimarykeyoptions.md +++ b/core.serializedprimarykeyoptions.md @@ -0,0 +1,315 @@ +--- +id: "core.serializedprimarykeyoptions" +title: "Interface: SerializedPrimaryKeyOptions<T>" +sidebar_label: "SerializedPrimaryKeyOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: SerializedPrimaryKeyOptions<T\\> + +[core](../modules/core.md).SerializedPrimaryKeyOptions + +## Type parameters + +Name \| +:------ \| +`T` \| + +## Hierarchy + +* [PropertyOptions](../modules/core.md#propertyoptions)<T\\> + + ↳ SerializedPrimaryKeyOptions + +## Properties + +### columnType + +• `Optional` columnType: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) + +___ + +### comment + +• `Optional` comment: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) + +___ + +### customType + +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) + +___ + +### default + +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) + +___ + +### defaultRaw + +• `Optional` defaultRaw: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) + +___ + +### fieldName + +• `Optional` fieldName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) + +___ + +### fieldNames + +• `Optional` fieldNames: string[] + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) + +___ + +### formula + +• `Optional` formula: string \\\| (`alias`: string) => string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) + +___ + +### hidden + +• `Optional` hidden: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) + +___ + +### index + +• `Optional` index: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) + +___ + +### lazy + +• `Optional` lazy: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) + +___ + +### length + +• `Optional` length: number + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) + +___ + +### name + +• `Optional` name: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) + +___ + +### nullable + +• `Optional` nullable: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) + +___ + +### onCreate + +• `Optional` onCreate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) + +___ + +### onUpdate + +• `Optional` onUpdate: (`entity`: T) => any + +#### Type declaration: + +▸ (`entity`: T): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) + +___ + +### persist + +• `Optional` persist: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) + +___ + +### primary + +• `Optional` primary: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) + +___ + +### serializedName + +• `Optional` serializedName: string + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) + +___ + +### serializedPrimaryKey + +• `Optional` serializedPrimaryKey: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) + +___ + +### serializer + +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) + +___ + +### type + +• `Optional` type: any + +Overrides: void + +Defined in: [packages/core/src/decorators/PrimaryKey.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/PrimaryKey.ts#L30) + +___ + +### unique + +• `Optional` unique: string \\\| boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) + +___ + +### unsigned + +• `Optional` unsigned: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) + +___ + +### version + +• `Optional` version: boolean + +Inherited from: void + +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.settings.md b/core.settings.md index ffe9d43..2e8765b 100644 --- a/core.settings.md +++ b/core.settings.md @@ -0,0 +1,35 @@ +--- +id: "core.settings" +title: "Interface: Settings" +sidebar_label: "Settings" +custom_edit_url: null +hide_title: true +--- + +# Interface: Settings + +[core](../modules/core.md).Settings + +## Properties + +### configPaths + +• `Optional` configPaths: string[] + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:168](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L168) + +___ + +### tsConfigPath + +• `Optional` tsConfigPath: string + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:167](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L167) + +___ + +### useTsNode + +• `Optional` useTsNode: boolean + +Defined in: [packages/core/src/utils/ConfigurationLoader.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/ConfigurationLoader.ts#L166) diff --git a/knex.issame.md b/knex.issame.md index bc542c3..41bbac5 100644 --- a/knex.issame.md +++ b/knex.issame.md @@ -0,0 +1,59 @@ +--- +id: "knex.issame" +title: "Interface: IsSame" +sidebar_label: "IsSame" +custom_edit_url: null +hide_title: true +--- + +# Interface: IsSame + +[knex](../modules/knex.md).IsSame + +## Properties + +### all + +• `Optional` all: boolean + +Defined in: [packages/knex/src/typings.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L77) + +___ + +### sameDefault + +• `Optional` sameDefault: boolean + +Defined in: [packages/knex/src/typings.ts:80](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L80) + +___ + +### sameEnums + +• `Optional` sameEnums: boolean + +Defined in: [packages/knex/src/typings.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L82) + +___ + +### sameIndex + +• `Optional` sameIndex: boolean + +Defined in: [packages/knex/src/typings.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L81) + +___ + +### sameNullable + +• `Optional` sameNullable: boolean + +Defined in: [packages/knex/src/typings.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L79) + +___ + +### sameTypes + +• `Optional` sameTypes: boolean + +Defined in: [packages/knex/src/typings.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L78) diff --git a/knex.knex-2.md b/knex.knex-2.md index e15f164..7bb52d4 100644 --- a/knex.knex-2.md +++ b/knex.knex-2.md @@ -0,0 +1,2356 @@ +--- +id: "knex.knex-2" +title: "Interface: Knex<TRecord, TResult>" +sidebar_label: "Knex" +custom_edit_url: null +hide_title: true +--- + +# Interface: Knex<TRecord, TResult\\> + +[knex](../modules/knex.md).Knex + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| unknown[] \| + +## Hierarchy + +* [QueryInterface](knex.knex-1.queryinterface.md)<TRecord, TResult\\> + +* EventEmitter + + ↳ Knex + +## Callable + +▸ Knex<TTable\\>(`tableName`: TTable, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TTable` \| never \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:332 + +▸ Knex<TRecord2, TResult2\\>(`tableName?`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md), `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| DeferredKeySelection<TRecord2, never, false, {}, false, {}, never\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName?` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:336 + +## Constructors + +### constructor + +• constructor: object + +Inherited from: void + +## Properties + +### RefMemberTag + +• RefMemberTag: typeof [RefMemberTag](../modules/knex.knex-1.md#refmembertag) + +___ + +### VERSION + +• VERSION: string + +Defined in: node_modules/knex/types/index.d.ts:341 + +___ + +### \\_\\_knex\\_\\_ + +• \\_\\_knex\\_\\_: string + +Defined in: node_modules/knex/types/index.d.ts:342 + +___ + +### andHaving + +• andHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andHaving](knex.knex-1.queryinterface.md#andhaving) + +Defined in: node_modules/knex/types/index.d.ts:544 + +___ + +### andWhere + +• andWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andWhere](knex.knex-1.queryinterface.md#andwhere) + +Defined in: node_modules/knex/types/index.d.ts:498 + +___ + +### andWhereBetween + +• andWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andWhereBetween](knex.knex-1.queryinterface.md#andwherebetween) + +Defined in: node_modules/knex/types/index.d.ts:522 + +___ + +### andWhereNot + +• andWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andWhereNot](knex.knex-1.queryinterface.md#andwherenot) + +Defined in: node_modules/knex/types/index.d.ts:501 + +___ + +### andWhereNotBetween + +• andWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andWhereNotBetween](knex.knex-1.queryinterface.md#andwherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:525 + +___ + +### andWhereRaw + +• andWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[andWhereRaw](knex.knex-1.queryinterface.md#andwhereraw) + +Defined in: node_modules/knex/types/index.d.ts:505 + +___ + +### as + +• as: [As](knex.knex-1.as.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[as](knex.knex-1.queryinterface.md#as) + +Defined in: node_modules/knex/types/index.d.ts:467 + +___ + +### avg + +• avg: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[avg](knex.knex-1.queryinterface.md#avg) + +Defined in: node_modules/knex/types/index.d.ts:587 + +___ + +### avgDistinct + +• avgDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[avgDistinct](knex.knex-1.queryinterface.md#avgdistinct) + +Defined in: node_modules/knex/types/index.d.ts:588 + +___ + +### client + +• client: any + +Defined in: node_modules/knex/types/index.d.ts:375 + +___ + +### column + +• column: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[column](knex.knex-1.queryinterface.md#column) + +Defined in: node_modules/knex/types/index.d.ts:469 + +___ + +### columns + +• columns: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[columns](knex.knex-1.queryinterface.md#columns) + +Defined in: node_modules/knex/types/index.d.ts:468 + +___ + +### count + +• count: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[count](knex.knex-1.queryinterface.md#count) + +Defined in: node_modules/knex/types/index.d.ts:581 + +___ + +### countDistinct + +• countDistinct: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[countDistinct](knex.knex-1.queryinterface.md#countdistinct) + +Defined in: node_modules/knex/types/index.d.ts:582 + +___ + +### crossJoin + +• crossJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[crossJoin](knex.knex-1.queryinterface.md#crossjoin) + +Defined in: node_modules/knex/types/index.d.ts:487 + +___ + +### distinct + +• distinct: [Distinct](knex.knex-1.distinct.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[distinct](knex.knex-1.queryinterface.md#distinct) + +Defined in: node_modules/knex/types/index.d.ts:474 + +___ + +### distinctOn + +• distinctOn: [DistinctOn](knex.knex-1.distincton.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[distinctOn](knex.knex-1.queryinterface.md#distincton) + +Defined in: node_modules/knex/types/index.d.ts:475 + +___ + +### first + +• first: [Select](knex.knex-1.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[first](knex.knex-1.queryinterface.md#first) + +Defined in: node_modules/knex/types/index.d.ts:609 + +___ + +### fn + +• fn: [FunctionHelper](knex.knex-1.functionhelper.md) + +Defined in: node_modules/knex/types/index.d.ts:378 + +___ + +### from + +• from: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[from](knex.knex-1.queryinterface.md#from) + +Defined in: node_modules/knex/types/index.d.ts:471 + +___ + +### fullOuterJoin + +• fullOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[fullOuterJoin](knex.knex-1.queryinterface.md#fullouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:486 + +___ + +### groupBy + +• groupBy: [GroupBy](knex.knex-1.groupby.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[groupBy](knex.knex-1.queryinterface.md#groupby) + +Defined in: node_modules/knex/types/index.d.ts:528 + +___ + +### groupByRaw + +• groupByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[groupByRaw](knex.knex-1.queryinterface.md#groupbyraw) + +Defined in: node_modules/knex/types/index.d.ts:529 + +___ + +### having + +• having: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[having](knex.knex-1.queryinterface.md#having) + +Defined in: node_modules/knex/types/index.d.ts:543 + +___ + +### havingBetween + +• havingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[havingBetween](knex.knex-1.queryinterface.md#havingbetween) + +Defined in: node_modules/knex/types/index.d.ts:552 + +___ + +### havingIn + +• havingIn: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[havingIn](knex.knex-1.queryinterface.md#havingin) + +Defined in: node_modules/knex/types/index.d.ts:548 + +___ + +### havingNotBetween + +• havingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[havingNotBetween](knex.knex-1.queryinterface.md#havingnotbetween) + +Defined in: node_modules/knex/types/index.d.ts:550 + +___ + +### havingRaw + +• havingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[havingRaw](knex.knex-1.queryinterface.md#havingraw) + +Defined in: node_modules/knex/types/index.d.ts:545 + +___ + +### havingWrapped + +• havingWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[havingWrapped](knex.knex-1.queryinterface.md#havingwrapped) + +Defined in: node_modules/knex/types/index.d.ts:507 + +___ + +### hintComment + +• hintComment: [HintComment](knex.knex-1.hintcomment.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[hintComment](knex.knex-1.queryinterface.md#hintcomment) + +Defined in: node_modules/knex/types/index.d.ts:470 + +___ + +### innerJoin + +• innerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[innerJoin](knex.knex-1.queryinterface.md#innerjoin) + +Defined in: node_modules/knex/types/index.d.ts:480 + +___ + +### intersect + +• intersect: [Intersect](knex.knex-1.intersect.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[intersect](knex.knex-1.queryinterface.md#intersect) + +Defined in: node_modules/knex/types/index.d.ts:536 + +___ + +### into + +• into: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[into](knex.knex-1.queryinterface.md#into) + +Defined in: node_modules/knex/types/index.d.ts:472 + +___ + +### join + +• join: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[join](knex.knex-1.queryinterface.md#join) + +Defined in: node_modules/knex/types/index.d.ts:478 + +___ + +### joinRaw + +• joinRaw: [JoinRaw](knex.knex-1.joinraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[joinRaw](knex.knex-1.queryinterface.md#joinraw) + +Defined in: node_modules/knex/types/index.d.ts:479 + +___ + +### leftJoin + +• leftJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[leftJoin](knex.knex-1.queryinterface.md#leftjoin) + +Defined in: node_modules/knex/types/index.d.ts:481 + +___ + +### leftOuterJoin + +• leftOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[leftOuterJoin](knex.knex-1.queryinterface.md#leftouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:482 + +___ + +### max + +• max: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[max](knex.knex-1.queryinterface.md#max) + +Defined in: node_modules/knex/types/index.d.ts:584 + +___ + +### migrate + +• migrate: [Migrator](knex.knex-1.migrator.md) + +Defined in: node_modules/knex/types/index.d.ts:376 + +___ + +### min + +• min: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[min](knex.knex-1.queryinterface.md#min) + +Defined in: node_modules/knex/types/index.d.ts:583 + +___ + +### orHaving + +• orHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orHaving](knex.knex-1.queryinterface.md#orhaving) + +Defined in: node_modules/knex/types/index.d.ts:546 + +___ + +### orHavingBetween + +• orHavingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orHavingBetween](knex.knex-1.queryinterface.md#orhavingbetween) + +Defined in: node_modules/knex/types/index.d.ts:551 + +___ + +### orHavingNotBetween + +• orHavingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orHavingNotBetween](knex.knex-1.queryinterface.md#orhavingnotbetween) + +Defined in: node_modules/knex/types/index.d.ts:549 + +___ + +### orHavingRaw + +• orHavingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orHavingRaw](knex.knex-1.queryinterface.md#orhavingraw) + +Defined in: node_modules/knex/types/index.d.ts:547 + +___ + +### orWhere + +• orWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhere](knex.knex-1.queryinterface.md#orwhere) + +Defined in: node_modules/knex/types/index.d.ts:499 + +___ + +### orWhereBetween + +• orWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereBetween](knex.knex-1.queryinterface.md#orwherebetween) + +Defined in: node_modules/knex/types/index.d.ts:521 + +___ + +### orWhereExists + +• orWhereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereExists](knex.knex-1.queryinterface.md#orwhereexists) + +Defined in: node_modules/knex/types/index.d.ts:509 + +___ + +### orWhereIn + +• orWhereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereIn](knex.knex-1.queryinterface.md#orwherein) + +Defined in: node_modules/knex/types/index.d.ts:513 + +___ + +### orWhereNot + +• orWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNot](knex.knex-1.queryinterface.md#orwherenot) + +Defined in: node_modules/knex/types/index.d.ts:502 + +___ + +### orWhereNotBetween + +• orWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNotBetween](knex.knex-1.queryinterface.md#orwherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:524 + +___ + +### orWhereNotExists + +• orWhereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNotExists](knex.knex-1.queryinterface.md#orwherenotexists) + +Defined in: node_modules/knex/types/index.d.ts:511 + +___ + +### orWhereNotIn + +• orWhereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNotIn](knex.knex-1.queryinterface.md#orwherenotin) + +Defined in: node_modules/knex/types/index.d.ts:515 + +___ + +### orWhereNotNull + +• orWhereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNotNull](knex.knex-1.queryinterface.md#orwherenotnull) + +Defined in: node_modules/knex/types/index.d.ts:519 + +___ + +### orWhereNull + +• orWhereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereNull](knex.knex-1.queryinterface.md#orwherenull) + +Defined in: node_modules/knex/types/index.d.ts:517 + +___ + +### orWhereRaw + +• orWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orWhereRaw](knex.knex-1.queryinterface.md#orwhereraw) + +Defined in: node_modules/knex/types/index.d.ts:504 + +___ + +### orderBy + +• orderBy: [OrderBy](knex.knex-1.orderby.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orderBy](knex.knex-1.queryinterface.md#orderby) + +Defined in: node_modules/knex/types/index.d.ts:532 + +___ + +### orderByRaw + +• orderByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[orderByRaw](knex.knex-1.queryinterface.md#orderbyraw) + +Defined in: node_modules/knex/types/index.d.ts:533 + +___ + +### outerJoin + +• outerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[outerJoin](knex.knex-1.queryinterface.md#outerjoin) + +Defined in: node_modules/knex/types/index.d.ts:485 + +___ + +### raw + +• raw: [RawBuilder](knex.knex-1.rawbuilder.md)<TRecord, any\\> + +Defined in: node_modules/knex/types/index.d.ts:344 + +___ + +### ref + +• ref: [RefBuilder](knex.knex-1.refbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:379 + +___ + +### rightJoin + +• rightJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[rightJoin](knex.knex-1.queryinterface.md#rightjoin) + +Defined in: node_modules/knex/types/index.d.ts:483 + +___ + +### rightOuterJoin + +• rightOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[rightOuterJoin](knex.knex-1.queryinterface.md#rightouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:484 + +___ + +### schema + +• schema: [SchemaBuilder](knex.knex-1.schemabuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:369 + +___ + +### seed + +• seed: [Seeder](../classes/knex.knex-1.seeder.md) + +Defined in: node_modules/knex/types/index.d.ts:377 + +___ + +### select + +• select: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[select](knex.knex-1.queryinterface.md#select) + +Defined in: node_modules/knex/types/index.d.ts:466 + +___ + +### sum + +• sum: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[sum](knex.knex-1.queryinterface.md#sum) + +Defined in: node_modules/knex/types/index.d.ts:585 + +___ + +### sumDistinct + +• sumDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[sumDistinct](knex.knex-1.queryinterface.md#sumdistinct) + +Defined in: node_modules/knex/types/index.d.ts:586 + +___ + +### table + +• table: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[table](knex.knex-1.queryinterface.md#table) + +Defined in: node_modules/knex/types/index.d.ts:473 + +___ + +### union + +• union: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[union](knex.knex-1.queryinterface.md#union) + +Defined in: node_modules/knex/types/index.d.ts:539 + +___ + +### unionAll + +• unionAll: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[unionAll](knex.knex-1.queryinterface.md#unionall) + +Defined in: node_modules/knex/types/index.d.ts:540 + +___ + +### userParams + +• userParams: Record<string, any\\> + +Defined in: node_modules/knex/types/index.d.ts:380 + +___ + +### where + +• where: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[where](knex.knex-1.queryinterface.md#where) + +Defined in: node_modules/knex/types/index.d.ts:497 + +___ + +### whereBetween + +• whereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereBetween](knex.knex-1.queryinterface.md#wherebetween) + +Defined in: node_modules/knex/types/index.d.ts:520 + +___ + +### whereExists + +• whereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereExists](knex.knex-1.queryinterface.md#whereexists) + +Defined in: node_modules/knex/types/index.d.ts:508 + +___ + +### whereIn + +• whereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereIn](knex.knex-1.queryinterface.md#wherein) + +Defined in: node_modules/knex/types/index.d.ts:512 + +___ + +### whereNot + +• whereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNot](knex.knex-1.queryinterface.md#wherenot) + +Defined in: node_modules/knex/types/index.d.ts:500 + +___ + +### whereNotBetween + +• whereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNotBetween](knex.knex-1.queryinterface.md#wherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:523 + +___ + +### whereNotExists + +• whereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNotExists](knex.knex-1.queryinterface.md#wherenotexists) + +Defined in: node_modules/knex/types/index.d.ts:510 + +___ + +### whereNotIn + +• whereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNotIn](knex.knex-1.queryinterface.md#wherenotin) + +Defined in: node_modules/knex/types/index.d.ts:514 + +___ + +### whereNotNull + +• whereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNotNull](knex.knex-1.queryinterface.md#wherenotnull) + +Defined in: node_modules/knex/types/index.d.ts:518 + +___ + +### whereNull + +• whereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereNull](knex.knex-1.queryinterface.md#wherenull) + +Defined in: node_modules/knex/types/index.d.ts:516 + +___ + +### whereRaw + +• whereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereRaw](knex.knex-1.queryinterface.md#whereraw) + +Defined in: node_modules/knex/types/index.d.ts:503 + +___ + +### whereWrapped + +• whereWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[whereWrapped](knex.knex-1.queryinterface.md#wherewrapped) + +Defined in: node_modules/knex/types/index.d.ts:506 + +___ + +### with + +• with: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[with](knex.knex-1.queryinterface.md#with) + +Defined in: node_modules/knex/types/index.d.ts:490 + +___ + +### withRaw + +• withRaw: [WithRaw](knex.knex-1.withraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[withRaw](knex.knex-1.queryinterface.md#withraw) + +Defined in: node_modules/knex/types/index.d.ts:492 + +___ + +### withRecursive + +• withRecursive: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[withRecursive](knex.knex-1.queryinterface.md#withrecursive) + +Defined in: node_modules/knex/types/index.d.ts:491 + +___ + +### withSchema + +• withSchema: [WithSchema](knex.knex-1.withschema.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[withSchema](knex.knex-1.queryinterface.md#withschema) + +Defined in: node_modules/knex/types/index.d.ts:493 + +___ + +### withWrapped + +• withWrapped: [WithWrapped](knex.knex-1.withwrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md).[withWrapped](knex.knex-1.queryinterface.md#withwrapped) + +Defined in: node_modules/knex/types/index.d.ts:494 + +## Methods + +### addListener + +▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:62 + +___ + +### batchInsert + +▸ batchInsert<TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor), `data`: TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord2\\>[], `chunkSize?`: number): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \| +`data` \| TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord2\\>[] \| +`chunkSize?` \| number \| + +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:361 + +___ + +### clear + +▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:574 + +___ + +### clearCounters + +▸ clearCounters(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:573 + +___ + +### clearGroup + +▸ clearGroup(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:570 + +___ + +### clearHaving + +▸ clearHaving(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:572 + +___ + +### clearOrder + +▸ clearOrder(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:571 + +___ + +### clearSelect + +▸ clearSelect(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:555 + +___ + +### clearWhere + +▸ clearWhere(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:569 + +___ + +### decrement + +▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:599 + +▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:603 + +___ + +### del + +▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:833 + +▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:837 + +▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:848 + +▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:859 + +▸ del<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:863 + +___ + +### delete + +▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:865 + +▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:869 + +▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:880 + +▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:891 + +▸ delete<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:895 + +___ + +### destroy + +▸ destroy(`callback`: Function): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| Function \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:358 + +▸ destroy(): Promise<void\\> + +Returns: Promise<void\\> + +Defined in: node_modules/knex/types/index.d.ts:359 + +___ + +### emit + +▸ emit(`event`: string \\\| symbol, ...`args`: any[]): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`...args` \| any[] \| + +Returns: boolean + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:72 + +___ + +### eventNames + +▸ eventNames(): (string \\\| symbol)[] + +Returns: (string \\\| symbol)[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:77 + +___ + +### getMaxListeners + +▸ getMaxListeners(): number + +Returns: number + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:69 + +___ + +### increment + +▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:590 + +▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:594 + +___ + +### initialize + +▸ initialize(`config?`: [Config](knex.knex-1.config.md)<any\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [Config](knex.knex-1.config.md)<any\\> \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:357 + +___ + +### insert + +▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| * \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:616 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:623 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:637 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:651 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:665 + +▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:679 + +___ + +### limit + +▸ limit(`limit`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`limit` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:578 + +___ + +### listenerCount + +▸ listenerCount(`event`: string \\\| symbol): number + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: number + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:73 + +___ + +### listeners + +▸ listeners(`event`: string \\\| symbol): Function[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: Function[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:70 + +___ + +### modify + +▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord2` \| object \| any \| +`TResult2` \| object \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| +`...args` \| any[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:685 + +___ + +### off + +▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:66 + +___ + +### offset + +▸ offset(`offset`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`offset` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:577 + +___ + +### on + +▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:63 + +___ + +### onConflict + +▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:813 + +▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:823 + +___ + +### once + +▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:64 + +___ + +### pluck + +▸ pluck<K\\>(`column`: K): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| K \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:611 + +▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TResult2` \| object \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:614 + +___ + +### prependListener + +▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:75 + +___ + +### prependOnceListener + +▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:76 + +___ + +### queryBuilder + +▸ queryBuilder<TRecord2, TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| TResult \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:370 + +___ + +### rawListeners + +▸ rawListeners(`event`: string \\\| symbol): Function[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: Function[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:71 + +___ + +### removeAllListeners + +▸ removeAllListeners(`event?`: string \\\| symbol): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event?` \| string \\\| symbol \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:67 + +___ + +### removeListener + +▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:65 + +___ + +### returning + +▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:786 + +▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:787 + +▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:798 + +▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:808 + +___ + +### setMaxListeners + +▸ setMaxListeners(`n`: number): [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`n` \| number \| + +Returns: [Knex](../modules/knex.md#knex)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:68 + +___ + +### transaction + +▸ transaction(`transactionScope?`: null, `config?`: any): Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`transactionScope?` \| null \| +`config?` \| any \| + +Returns: Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:349 + +▸ transaction<T\\>(`transactionScope`: (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => void \\\| Promise<T\\>, `config?`: any): Promise<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`transactionScope` \| (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => void \\\| Promise<T\\> \| +`config?` \| any \| + +Returns: Promise<T\\> + +Defined in: node_modules/knex/types/index.d.ts:353 + +___ + +### transactionProvider + +▸ transactionProvider(`config?`: any): function + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| any \| + +Returns: () => Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:346 + +___ + +### truncate + +▸ truncate(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:897 + +___ + +### update + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| K2 \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:689 + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| readonly K2[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:703 + +▸ update<K\\>(`columnName`: K, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:717 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:721 + +▸ update(`data`: [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:727 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:732 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:744 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| string \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \\\| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:756 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:768 + +▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:780 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:784 + +___ + +### withUserParams + +▸ withUserParams(`params`: Record<string, any\\>): Knex<any, unknown[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`params` \| Record<string, any\\> \| + +Returns: Knex<any, unknown[]\\> + +Defined in: node_modules/knex/types/index.d.ts:381 diff --git a/knex.knex.aliasquerybuilder.md b/knex.knex.aliasquerybuilder.md index c2a16db..51ef041 100644 --- a/knex.knex.aliasquerybuilder.md +++ b/knex.knex.aliasquerybuilder.md @@ -1,101 +0,0 @@ ---- -id: "knex.knex.aliasquerybuilder" -title: "Interface: AliasQueryBuilder<TRecord, TResult>" -sidebar_label: "AliasQueryBuilder" -hide_title: true ---- - -# Interface: AliasQueryBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AliasQueryBuilder - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| unknown[] \| - -## Hierarchy - -* AliasQueryBuilder - - ↳ [Select](knex.knex.select.md) - -## Callable - -▸ AliasQueryBuilder<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:917 - -▸ AliasQueryBuilder<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:928 - -▸ AliasQueryBuilder<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:940 - -▸ AliasQueryBuilder<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:952 diff --git a/knex.knex.altercolumnbuilder.md b/knex.knex.altercolumnbuilder.md index ce4f2da..84d661f 100644 --- a/knex.knex.altercolumnbuilder.md +++ b/knex.knex.altercolumnbuilder.md @@ -1,276 +0,0 @@ ---- -id: "knex.knex.altercolumnbuilder" -title: "Interface: AlterColumnBuilder" -sidebar_label: "AlterColumnBuilder" -hide_title: true ---- - -# Interface: AlterColumnBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AlterColumnBuilder - -## Hierarchy - -* [ColumnBuilder](knex.knex.columnbuilder.md) - - ↳ AlterColumnBuilder - - ↳↳ [MySqlAlterColumnBuilder](knex.knex.mysqlaltercolumnbuilder.md) - -## Methods - -### after - -▸ after(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1811 - -___ - -### alter - -▸ alter(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1808 - -___ - -### comment - -▸ comment(`value`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1807 - -___ - -### defaultTo - -▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1803 - -___ - -### first - -▸ first(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1812 - -___ - -### index - -▸ index(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1797 - -___ - -### notNullable - -▸ notNullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1805 - -___ - -### nullable - -▸ nullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1806 - -___ - -### onDelete - -▸ onDelete(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1801 - -___ - -### onUpdate - -▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1802 - -___ - -### primary - -▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1798 - -___ - -### queryContext - -▸ queryContext(`context`: any): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1809 - -___ - -### references - -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1800 - -___ - -### unique - -▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1799 - -___ - -### unsigned - -▸ unsigned(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1804 - -___ - -### withKeyName - -▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`keyName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1810 diff --git a/knex.knex.altertablebuilder.md b/knex.knex.altertablebuilder.md index 0bc1a0b..9b80276 100644 --- a/knex.knex.altertablebuilder.md +++ b/knex.knex.altertablebuilder.md @@ -1,718 +0,0 @@ ---- -id: "knex.knex.altertablebuilder" -title: "Interface: AlterTableBuilder" -sidebar_label: "AlterTableBuilder" -hide_title: true ---- - -# Interface: AlterTableBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AlterTableBuilder - -## Hierarchy - -* [TableBuilder](knex.knex.tablebuilder.md) - - ↳ AlterTableBuilder - -## Methods - -### bigIncrements - -▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1717 - -___ - -### bigInteger - -▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1722 - -___ - -### binary - -▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1751 - -___ - -### boolean - -▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1740 - -___ - -### comment - -▸ comment(`val`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1765 - -___ - -### date - -▸ date(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1741 - -___ - -### dateTime - -▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1742 - -___ - -### decimal - -▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| null \\\| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1735 - -___ - -### double - -▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1730 - -___ - -### dropColumn - -▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1718 - -___ - -### dropColumns - -▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| string[] \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1719 - -___ - -### dropForeign - -▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`foreignKeyName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1779 - -___ - -### dropIndex - -▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1782 - -___ - -### dropPrimary - -▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1781 - -___ - -### dropTimestamps - -▸ dropTimestamps(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1783 - -___ - -### dropUnique - -▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1780 - -___ - -### enu - -▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1757 - -___ - -### enum - -▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1752 - -___ - -### float - -▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1725 - -___ - -### foreign - -▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \| -`foreignKeyName?` \| string \| - -Returns: [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1774 - -▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly string[] \| -`foreignKeyName?` \| string \| - -Returns: [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1775 - -___ - -### increments - -▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1716 - -___ - -### index - -▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| -`indexType?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1768 - -___ - -### integer - -▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1721 - -___ - -### json - -▸ json(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1762 - -___ - -### jsonb - -▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1763 - -___ - -### primary - -▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`constraintName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1767 - -___ - -### queryContext - -▸ queryContext(`context`: any): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1784 - -___ - -### renameColumn - -▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`from` \| string \| -`to` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1720 - -___ - -### specificType - -▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`type` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1766 - -___ - -### string - -▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1724 - -___ - -### text - -▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`textType?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1723 - -___ - -### time - -▸ time(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1743 - -___ - -### timestamp - -▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1744 - -▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -`deprecated` - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`withoutTz?` \| boolean \| -`precision?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1746 - -___ - -### timestamps - -▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`useTimestampType?` \| boolean \| -`makeDefaultNow?` \| boolean \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1747 - -___ - -### unique - -▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1773 - -___ - -### uuid - -▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1764 diff --git a/knex.knex.asymmetricaggregation.md b/knex.knex.asymmetricaggregation.md index 7593e77..7467a3f 100644 --- a/knex.knex.asymmetricaggregation.md +++ b/knex.knex.asymmetricaggregation.md @@ -1,79 +0,0 @@ ---- -id: "knex.knex.asymmetricaggregation" -title: "Interface: AsymmetricAggregation<TRecord, TResult, TValue>" -sidebar_label: "AsymmetricAggregation" -hide_title: true ---- - -# Interface: AsymmetricAggregation<TRecord, TResult, TValue\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AsymmetricAggregation - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| -`TValue` \| any \| - -## Hierarchy - -* AsymmetricAggregation - -## Callable - -▸ AsymmetricAggregation<TResult2\\>(...`columnNames`: readonly keyof [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\\\>, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\\\>, never\\\\> : Dict<TValue\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly keyof [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1324 - -▸ AsymmetricAggregation<TAliases, TResult2\\>(`aliases`: TAliases): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TAliases` \| {} \| Record<string, string \\\\\| string[] \\\\\| [Raw](knex.knex.raw.md)<any\\\\>\\\\> \| -`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & { [k in string \\\\\| number \\\\\| symbol]?: TValue}, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, { [k in string \\\\\| number \\\\\| symbol]?: TValue}, never\\\\> : { [k in string \\\\\| number \\\\\| symbol]?: TValue}\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| TAliases \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1327 - -▸ AsymmetricAggregation<TResult2\\>(...`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| string[] \\\| [Raw](knex.knex.raw.md)<any\\>\\>\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\\\>, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\\\>, never\\\\> : Dict<TValue\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| string[] \\\| [Raw](knex.knex.raw.md)<any\\>\\>\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1331 diff --git a/knex.knex.columnbuilder.md b/knex.knex.columnbuilder.md index 50f8b27..8821caf 100644 --- a/knex.knex.columnbuilder.md +++ b/knex.knex.columnbuilder.md @@ -1,246 +0,0 @@ ---- -id: "knex.knex.columnbuilder" -title: "Interface: ColumnBuilder" -sidebar_label: "ColumnBuilder" -hide_title: true ---- - -# Interface: ColumnBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ColumnBuilder - -## Hierarchy - -* ColumnBuilder - - ↳ [PostgreSqlColumnBuilder](knex.knex.postgresqlcolumnbuilder.md) - - ↳ [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - - ↳ [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -## Methods - -### after - -▸ after(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1811 - -___ - -### alter - -▸ alter(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1808 - -___ - -### comment - -▸ comment(`value`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1807 - -___ - -### defaultTo - -▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1803 - -___ - -### first - -▸ first(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1812 - -___ - -### index - -▸ index(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1797 - -___ - -### notNullable - -▸ notNullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1805 - -___ - -### nullable - -▸ nullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1806 - -___ - -### onDelete - -▸ onDelete(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1801 - -___ - -### onUpdate - -▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1802 - -___ - -### primary - -▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1798 - -___ - -### queryContext - -▸ queryContext(`context`: any): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1809 - -___ - -### references - -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1800 - -___ - -### unique - -▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1799 - -___ - -### unsigned - -▸ unsigned(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1804 - -___ - -### withKeyName - -▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`keyName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1810 diff --git a/knex.knex.columnnamequerybuilder.md b/knex.knex.columnnamequerybuilder.md index 4ee6e78..7a1ca0c 100644 --- a/knex.knex.columnnamequerybuilder.md +++ b/knex.knex.columnnamequerybuilder.md @@ -1,115 +0,0 @@ ---- -id: "knex.knex.columnnamequerybuilder" -title: "Interface: ColumnNameQueryBuilder<TRecord, TResult>" -sidebar_label: "ColumnNameQueryBuilder" -hide_title: true ---- - -# Interface: ColumnNameQueryBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ColumnNameQueryBuilder - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* ColumnNameQueryBuilder - - ↳ [Select](knex.knex.select.md) - - ↳ [Distinct](knex.knex.distinct.md) - - ↳ [GroupBy](knex.knex.groupby.md) - -## Callable - -▸ ColumnNameQueryBuilder(`columnName`: **): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:1428 - -▸ ColumnNameQueryBuilder<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1434 - -▸ ColumnNameQueryBuilder<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1445 - -▸ ColumnNameQueryBuilder<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1456 - -▸ ColumnNameQueryBuilder<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1468 diff --git a/knex.knex.config.md b/knex.knex.config.md index da2d33e..3cfeb0c 100644 --- a/knex.knex.config.md +++ b/knex.knex.config.md @@ -1,140 +0,0 @@ ---- -id: "knex.knex.config" -title: "Interface: Config<SV>" -sidebar_label: "Config" -hide_title: true ---- - -# Interface: Config<SV\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Config - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`SV` \| {} \| any \| - -## Hierarchy - -* Config - -## Properties - -### acquireConnectionTimeout - -• `Optional` acquireConnectionTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1864 - -___ - -### asyncStackTraces - -• `Optional` asyncStackTraces: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1867 - -___ - -### client - -• `Optional` client: undefined \\\| string \\\| typeof [Client](../classes/knex.knex.client.md) - -Defined in: node_modules/knex/types/index.d.ts:1851 - -___ - -### connection - -• `Optional` connection: undefined \\\| string \\\| [ConnectionConfig](knex.knex.connectionconfig.md) \\\| [MariaSqlConnectionConfig](knex.knex.mariasqlconnectionconfig.md) \\\| [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md) \\\| [MySql2ConnectionConfig](knex.knex.mysql2connectionconfig.md) \\\| [MsSqlConnectionConfig](knex.knex.mssqlconnectionconfig.md) \\\| [OracleDbConnectionConfig](knex.knex.oracledbconnectionconfig.md) \\\| [PgConnectionConfig](knex.knex.pgconnectionconfig.md) \\\| [Sqlite3ConnectionConfig](knex.knex.sqlite3connectionconfig.md) \\\| [SocketConnectionConfig](knex.knex.socketconnectionconfig.md) \\\| [SyncConnectionConfigProvider](../modules/knex.knex-1.md#syncconnectionconfigprovider) \\\| [AsyncConnectionConfigProvider](../modules/knex.knex-1.md#asyncconnectionconfigprovider) - -Defined in: node_modules/knex/types/index.d.ts:1854 - -___ - -### debug - -• `Optional` debug: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1850 - -___ - -### dialect - -• `Optional` dialect: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1852 - -___ - -### log - -• `Optional` log: undefined \\\| [Logger](knex.knex.logger.md) - -Defined in: node_modules/knex/types/index.d.ts:1868 - -___ - -### migrations - -• `Optional` migrations: undefined \\\| [MigratorConfig](knex.knex.migratorconfig.md) - -Defined in: node_modules/knex/types/index.d.ts:1856 - -___ - -### pool - -• `Optional` pool: undefined \\\| [PoolConfig](knex.knex.poolconfig.md) - -Defined in: node_modules/knex/types/index.d.ts:1855 - -___ - -### postProcessResponse - -• `Optional` postProcessResponse: undefined \\\| (`result`: any, `queryContext`: any) => any - -Defined in: node_modules/knex/types/index.d.ts:1857 - -___ - -### searchPath - -• `Optional` searchPath: undefined \\\| string \\\| readonly string[] - -Defined in: node_modules/knex/types/index.d.ts:1866 - -___ - -### seeds - -• `Optional` seeds: undefined \\\| [SeederConfig](knex.knex.seederconfig.md)<SV\\> - -Defined in: node_modules/knex/types/index.d.ts:1863 - -___ - -### useNullAsDefault - -• `Optional` useNullAsDefault: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1865 - -___ - -### version - -• `Optional` version: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1853 - -___ - -### wrapIdentifier - -• `Optional` wrapIdentifier: undefined \\\| (`value`: string, `origImpl`: (`value`: string) => string, `queryContext`: any) => string - -Defined in: node_modules/knex/types/index.d.ts:1858 diff --git a/knex.knex.connectionconfig.md b/knex.knex.connectionconfig.md index c4d5fcf..5ab86c2 100644 --- a/knex.knex.connectionconfig.md +++ b/knex.knex.connectionconfig.md @@ -1,78 +0,0 @@ ---- -id: "knex.knex.connectionconfig" -title: "Interface: ConnectionConfig" -sidebar_label: "ConnectionConfig" -hide_title: true ---- - -# Interface: ConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ConnectionConfig - -## Hierarchy - -* ConnectionConfig - -## Properties - -### database - -• database: string - -Defined in: node_modules/knex/types/index.d.ts:1891 - -___ - -### debug - -• `Optional` debug: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1894 - -___ - -### domain - -• `Optional` domain: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1892 - -___ - -### host - -• host: string - -Defined in: node_modules/knex/types/index.d.ts:1888 - -___ - -### instanceName - -• `Optional` instanceName: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1893 - -___ - -### password - -• password: string - -Defined in: node_modules/knex/types/index.d.ts:1890 - -___ - -### requestTimeout - -• `Optional` requestTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1895 - -___ - -### user - -• user: string - -Defined in: node_modules/knex/types/index.d.ts:1889 diff --git a/knex.knex.createtablebuilder.md b/knex.knex.createtablebuilder.md index e5cdcf1..e429b8a 100644 --- a/knex.knex.createtablebuilder.md +++ b/knex.knex.createtablebuilder.md @@ -1,782 +0,0 @@ ---- -id: "knex.knex.createtablebuilder" -title: "Interface: CreateTableBuilder" -sidebar_label: "CreateTableBuilder" -hide_title: true ---- - -# Interface: CreateTableBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).CreateTableBuilder - -## Hierarchy - -* [TableBuilder](knex.knex.tablebuilder.md) - - ↳ CreateTableBuilder - -## Methods - -### bigIncrements - -▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1717 - -___ - -### bigInteger - -▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1722 - -___ - -### binary - -▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1751 - -___ - -### boolean - -▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1740 - -___ - -### charset - -▸ charset(`val`: string): [CreateTableBuilder](knex.knex.createtablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [CreateTableBuilder](knex.knex.createtablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1789 - -___ - -### collate - -▸ collate(`val`: string): [CreateTableBuilder](knex.knex.createtablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [CreateTableBuilder](knex.knex.createtablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1790 - -___ - -### comment - -▸ comment(`val`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1765 - -___ - -### date - -▸ date(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1741 - -___ - -### dateTime - -▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1742 - -___ - -### decimal - -▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| null \\\| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1735 - -___ - -### double - -▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1730 - -___ - -### dropColumn - -▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1718 - -___ - -### dropColumns - -▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| string[] \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1719 - -___ - -### dropForeign - -▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`foreignKeyName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1779 - -___ - -### dropIndex - -▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1782 - -___ - -### dropPrimary - -▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1781 - -___ - -### dropTimestamps - -▸ dropTimestamps(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1783 - -___ - -### dropUnique - -▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1780 - -___ - -### engine - -▸ engine(`val`: string): [CreateTableBuilder](knex.knex.createtablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [CreateTableBuilder](knex.knex.createtablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1788 - -___ - -### enu - -▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1757 - -___ - -### enum - -▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1752 - -___ - -### float - -▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`precision?` \| number \| -`scale?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1725 - -___ - -### foreign - -▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \| -`foreignKeyName?` \| string \| - -Returns: [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1774 - -▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly string[] \| -`foreignKeyName?` \| string \| - -Returns: [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1775 - -___ - -### increments - -▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1716 - -___ - -### index - -▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| -`indexType?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1768 - -___ - -### inherits - -▸ inherits(`val`: string): [CreateTableBuilder](knex.knex.createtablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`val` \| string \| - -Returns: [CreateTableBuilder](knex.knex.createtablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1791 - -___ - -### integer - -▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1721 - -___ - -### json - -▸ json(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1762 - -___ - -### jsonb - -▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1763 - -___ - -### primary - -▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`constraintName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1767 - -___ - -### queryContext - -▸ queryContext(`context`: any): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1784 - -___ - -### renameColumn - -▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`from` \| string \| -`to` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1720 - -___ - -### specificType - -▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`type` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1766 - -___ - -### string - -▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`length?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1724 - -___ - -### text - -▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`textType?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1723 - -___ - -### time - -▸ time(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1743 - -___ - -### timestamp - -▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1744 - -▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) - -`deprecated` - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`withoutTz?` \| boolean \| -`precision?` \| number \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1746 - -___ - -### timestamps - -▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`useTimestampType?` \| boolean \| -`makeDefaultNow?` \| boolean \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1747 - -___ - -### unique - -▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| -`indexName?` \| string \| - -Returns: [TableBuilder](knex.knex.tablebuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1773 - -___ - -### uuid - -▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [TableBuilder](knex.knex.tablebuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1764 diff --git a/knex.knex.distinct.md b/knex.knex.distinct.md index 32f69b5..904484a 100644 --- a/knex.knex.distinct.md +++ b/knex.knex.distinct.md @@ -1,111 +0,0 @@ ---- -id: "knex.knex.distinct" -title: "Interface: Distinct<TRecord, TResult>" -sidebar_label: "Distinct" -hide_title: true ---- - -# Interface: Distinct<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Distinct - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| - \| -`TResult` \| - \| {}[] \| - -## Hierarchy - -* [ColumnNameQueryBuilder](knex.knex.columnnamequerybuilder.md)<TRecord, TResult\\> - - ↳ Distinct - -## Callable - -▸ Distinct(`columnName`: **): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:1428 - -▸ Distinct<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1434 - -▸ Distinct<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1445 - -▸ Distinct<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1456 - -▸ Distinct<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1468 diff --git a/knex.knex.enumoptions.md b/knex.knex.enumoptions.md index bebedde..40e3c94 100644 --- a/knex.knex.enumoptions.md +++ b/knex.knex.enumoptions.md @@ -1,46 +0,0 @@ ---- -id: "knex.knex.enumoptions" -title: "Interface: EnumOptions" -sidebar_label: "EnumOptions" -hide_title: true ---- - -# Interface: EnumOptions - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).EnumOptions - -## Hierarchy - -* EnumOptions - -## Properties - -### enumName - -• enumName: string - -Defined in: node_modules/knex/types/index.d.ts:2167 - -___ - -### existingType - -• `Optional` existingType: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2165 - -___ - -### schemaName - -• `Optional` schemaName: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2166 - -___ - -### useNative - -• useNative: boolean - -Defined in: node_modules/knex/types/index.d.ts:2164 diff --git a/knex.knex.groupby.md b/knex.knex.groupby.md index 00bb035..81e5d51 100644 --- a/knex.knex.groupby.md +++ b/knex.knex.groupby.md @@ -1,150 +0,0 @@ ---- -id: "knex.knex.groupby" -title: "Interface: GroupBy<TRecord, TResult>" -sidebar_label: "GroupBy" -hide_title: true ---- - -# Interface: GroupBy<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).GroupBy - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -* [ColumnNameQueryBuilder](knex.knex.columnnamequerybuilder.md)<TRecord, TResult\\> - - ↳ GroupBy - -## Callable - -▸ GroupBy<TResult2\\>(`sql`: string, `bindings?`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`bindings?` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1483 - -▸ GroupBy<TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<TResult2\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1487 - -▸ GroupBy(`columnName`: **): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:1428 - -▸ GroupBy<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1434 - -▸ GroupBy<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1445 - -▸ GroupBy<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1456 - -▸ GroupBy<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1468 diff --git a/knex.knex.having.md b/knex.knex.having.md index b3bae08..1025fdc 100644 --- a/knex.knex.having.md +++ b/knex.knex.having.md @@ -1,83 +0,0 @@ ---- -id: "knex.knex.having" -title: "Interface: Having<TRecord, TResult>" -sidebar_label: "Having" -hide_title: true ---- - -# Interface: Having<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Having - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - - ↳ Having - -## Callable - -▸ Having<K\\>(`column`: K, `operator`: ComparisonOperator, `value`: Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| K \| -`operator` \| ComparisonOperator \| -`value` \| Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1399 - -▸ Having(`column`: string \\\| [Raw](knex.knex.raw.md)<any\\>, `operator`: string, `value`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \| -`operator` \| string \| -`value` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1404 - -▸ Having(`raw`: [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1410 - -▸ Having(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1261 diff --git a/knex.knex.havingrange.md b/knex.knex.havingrange.md index 231162c..4ce31b4 100644 --- a/knex.knex.havingrange.md +++ b/knex.knex.havingrange.md @@ -1,55 +0,0 @@ ---- -id: "knex.knex.havingrange" -title: "Interface: HavingRange<TRecord, TResult>" -sidebar_label: "HavingRange" -hide_title: true ---- - -# Interface: HavingRange<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).HavingRange - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* HavingRange - -## Callable - -▸ HavingRange<K\\>(`columnName`: K, `values`: readonly (Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`values` \| readonly (Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1418 - -▸ HavingRange(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1422 diff --git a/knex.knex.intersect.md b/knex.knex.intersect.md index 7825593..427657d 100644 --- a/knex.knex.intersect.md +++ b/knex.knex.intersect.md @@ -1,50 +0,0 @@ ---- -id: "knex.knex.intersect" -title: "Interface: Intersect<TRecord, TResult>" -sidebar_label: "Intersect" -hide_title: true ---- - -# Interface: Intersect<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Intersect - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* Intersect - - ↳ [Union](knex.knex.union.md) - -## Callable - -▸ Intersect(`callback`: MaybeArray<[Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>\\>, `wrap?`: boolean): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| MaybeArray<[Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>\\> \| -`wrap?` \| boolean \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1385 - -▸ Intersect(...`callbacks`: readonly ([Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...callbacks` \| readonly ([Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1389 diff --git a/knex.knex.join.md b/knex.knex.join.md index 7e6074d..7dadbb5 100644 --- a/knex.knex.join.md +++ b/knex.knex.join.md @@ -1,239 +0,0 @@ ---- -id: "knex.knex.join" -title: "Interface: Join<TRecord, TResult>" -sidebar_label: "Join" -hide_title: true ---- - -# Interface: Join<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Join - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| unknown[] \| - -## Hierarchy - -* Join - -## Callable - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1033 - -▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `clause`: [JoinCallback](knex.knex.joincallback.md)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TTable` \| never \| - \| -`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\\\>, base\\\\> \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| TTable \| -`clause` \| [JoinCallback](knex.knex.joincallback.md) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1040 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `clause`: [JoinCallback](knex.knex.joincallback.md)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`clause` \| [JoinCallback](knex.knex.joincallback.md) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1048 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `columns`: { [key: string]: string \\\| number \\\| boolean \\\| [Raw](knex.knex.raw.md); }): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`columns` \| { [key: string]: string \\\| number \\\| boolean \\\| [Raw](knex.knex.raw.md); } \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1056 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `raw`: [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1064 - -▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `column1`: string, `column2`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TTable` \| never \| - \| -`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\\\>, base\\\\> \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| TTable \| -`column1` \| string \| -`column2` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1072 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `column2`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`column1` \| string \| -`column2` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1081 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `raw`: [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`column1` \| string \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1090 - -▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `column1`: string, `operator`: string, `column2`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TTable` \| never \| - \| -`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\\\>, base\\\\> \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| TTable \| -`column1` \| string \| -`operator` \| string \| -`column2` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1099 - -▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `operator`: string, `column2`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TJoinTargetRecord` \| {} \| any \| -`TRecord2` \| {} \| TRecord & TJoinTargetRecord \| -`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| -`column1` \| string \| -`operator` \| string \| -`column2` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1109 diff --git a/knex.knex.joincallback.md b/knex.knex.joincallback.md index 5306899..149970e 100644 --- a/knex.knex.joincallback.md +++ b/knex.knex.joincallback.md @@ -1,28 +0,0 @@ ---- -id: "knex.knex.joincallback" -title: "Interface: JoinCallback" -sidebar_label: "JoinCallback" -hide_title: true ---- - -# Interface: JoinCallback - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinCallback - -## Hierarchy - -* JoinCallback - -## Callable - -▸ JoinCallback(`join`: [JoinClause](knex.knex.joinclause.md)): void - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`join` \| [JoinClause](knex.knex.joinclause.md) \| - -Returns: void - -Defined in: node_modules/knex/types/index.d.ts:1029 diff --git a/knex.knex.joinclause.md b/knex.knex.joinclause.md index e57b2b4..b129e17 100644 --- a/knex.knex.joinclause.md +++ b/knex.knex.joinclause.md @@ -1,682 +0,0 @@ ---- -id: "knex.knex.joinclause" -title: "Interface: JoinClause" -sidebar_label: "JoinClause" -hide_title: true ---- - -# Interface: JoinClause - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinClause - -## Hierarchy - -* JoinClause - -## Methods - -### andOn - -▸ andOn(`raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1129 - -▸ andOn(`callback`: [JoinCallback](knex.knex.joincallback.md)): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [JoinCallback](knex.knex.joincallback.md) \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1130 - -▸ andOn(`columns`: { [key: string]: string \\\| [Raw](knex.knex.raw.md); }): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| { [key: string]: string \\\| [Raw](knex.knex.raw.md); } \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1131 - -▸ andOn(`column1`: string, `column2`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`column2` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1132 - -▸ andOn(`column1`: string, `raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1133 - -▸ andOn(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`operator` \| string \| -`column2` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1134 - -___ - -### andOnBetween - -▸ andOnBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1160 - -___ - -### andOnExists - -▸ andOnExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1154 - -___ - -### andOnIn - -▸ andOnIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1142 - -___ - -### andOnNotBetween - -▸ andOnNotBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1163 - -___ - -### andOnNotExists - -▸ andOnNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1157 - -___ - -### andOnNotIn - -▸ andOnNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1145 - -___ - -### andOnNotNull - -▸ andOnNotNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1151 - -___ - -### andOnNull - -▸ andOnNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1148 - -___ - -### on - -▸ on(`raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1123 - -▸ on(`callback`: [JoinCallback](knex.knex.joincallback.md)): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [JoinCallback](knex.knex.joincallback.md) \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1124 - -▸ on(`columns`: { [key: string]: string \\\| [Raw](knex.knex.raw.md); }): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| { [key: string]: string \\\| [Raw](knex.knex.raw.md); } \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1125 - -▸ on(`column1`: string, `column2`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`column2` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1126 - -▸ on(`column1`: string, `raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1127 - -▸ on(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`operator` \| string \| -`column2` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1128 - -___ - -### onBetween - -▸ onBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1159 - -___ - -### onExists - -▸ onExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1153 - -___ - -### onIn - -▸ onIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1141 - -___ - -### onNotBetween - -▸ onNotBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1162 - -___ - -### onNotExists - -▸ onNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1156 - -___ - -### onNotIn - -▸ onNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1144 - -___ - -### onNotNull - -▸ onNotNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1150 - -___ - -### onNull - -▸ onNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1147 - -___ - -### orOn - -▸ orOn(`raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1135 - -▸ orOn(`callback`: [JoinCallback](knex.knex.joincallback.md)): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [JoinCallback](knex.knex.joincallback.md) \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1136 - -▸ orOn(`columns`: { [key: string]: string \\\| [Raw](knex.knex.raw.md); }): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| { [key: string]: string \\\| [Raw](knex.knex.raw.md); } \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1137 - -▸ orOn(`column1`: string, `column2`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`column2` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1138 - -▸ orOn(`column1`: string, `raw`: [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1139 - -▸ orOn(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex.raw.md)<any\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`operator` \| string \| -`column2` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1140 - -___ - -### orOnBetween - -▸ orOnBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1161 - -___ - -### orOnExists - -▸ orOnExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1155 - -___ - -### orOnIn - -▸ orOnIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1143 - -___ - -### orOnNotBetween - -▸ orOnNotBetween(`column1`: string, `range`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`range` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1164 - -___ - -### orOnNotExists - -▸ orOnNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1158 - -___ - -### orOnNotIn - -▸ orOnNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| -`values` \| readonly any[] \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1146 - -___ - -### orOnNotNull - -▸ orOnNotNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1152 - -___ - -### orOnNull - -▸ orOnNull(`column1`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column1` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1149 - -___ - -### type - -▸ type(`type`: string): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`type` \| string \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1168 - -___ - -### using - -▸ using(`column`: string \\\| readonly string[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| { [key: string]: string \\\| [Raw](knex.knex.raw.md); }): [JoinClause](knex.knex.joinclause.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \\\| readonly string[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| { [key: string]: string \\\| [Raw](knex.knex.raw.md); } \| - -Returns: [JoinClause](knex.knex.joinclause.md) - -Defined in: node_modules/knex/types/index.d.ts:1165 diff --git a/knex.knex.joinraw.md b/knex.knex.joinraw.md index 6c05626..5281ede 100644 --- a/knex.knex.joinraw.md +++ b/knex.knex.joinraw.md @@ -1,36 +0,0 @@ ---- -id: "knex.knex.joinraw" -title: "Interface: JoinRaw<TRecord, TResult>" -sidebar_label: "JoinRaw" -hide_title: true ---- - -# Interface: JoinRaw<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinRaw - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* JoinRaw - -## Callable - -▸ JoinRaw(`tableName`: string, `binding?`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \| -`binding?` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1171 diff --git a/knex.knex.logger.md b/knex.knex.logger.md index 2020793..336fb1d 100644 --- a/knex.knex.logger.md +++ b/knex.knex.logger.md @@ -1,62 +0,0 @@ ---- -id: "knex.knex.logger" -title: "Interface: Logger" -sidebar_label: "Logger" -hide_title: true ---- - -# Interface: Logger - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Logger - -## Hierarchy - -* Logger - -## Properties - -### debug - -• `Optional` debug: undefined \\\| [LogFn](../modules/knex.knex-1.md#logfn) - -Defined in: node_modules/knex/types/index.d.ts:2097 - -___ - -### deprecate - -• `Optional` deprecate: undefined \\\| (`method`: string, `alternative`: string) => void - -Defined in: node_modules/knex/types/index.d.ts:2100 - -___ - -### enableColors - -• `Optional` enableColors: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2099 - -___ - -### error - -• `Optional` error: undefined \\\| [LogFn](../modules/knex.knex-1.md#logfn) - -Defined in: node_modules/knex/types/index.d.ts:2096 - -___ - -### inspectionDepth - -• `Optional` inspectionDepth: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2098 - -___ - -### warn - -• `Optional` warn: undefined \\\| [LogFn](../modules/knex.knex-1.md#logfn) - -Defined in: node_modules/knex/types/index.d.ts:2095 diff --git a/knex.knex.mariasqlconnectionconfig.md b/knex.knex.mariasqlconnectionconfig.md index 9a9ea4b..1121317 100644 --- a/knex.knex.mariasqlconnectionconfig.md +++ b/knex.knex.mariasqlconnectionconfig.md @@ -1,172 +0,0 @@ ---- -id: "knex.knex.mariasqlconnectionconfig" -title: "Interface: MariaSqlConnectionConfig" -sidebar_label: "MariaSqlConnectionConfig" -hide_title: true ---- - -# Interface: MariaSqlConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MariaSqlConnectionConfig - -## Hierarchy - -* MariaSqlConnectionConfig - -## Properties - -### charset - -• `Optional` charset: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1962 - -___ - -### compress - -• `Optional` compress: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1957 - -___ - -### connTimeout - -• `Optional` connTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1954 - -___ - -### db - -• `Optional` db: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1951 - -___ - -### host - -• `Optional` host: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1947 - -___ - -### keepQueries - -• `Optional` keepQueries: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1952 - -___ - -### local\\_infile - -• `Optional` local\\_infile: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1959 - -___ - -### multiStatements - -• `Optional` multiStatements: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1953 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1946 - -___ - -### pingInterval - -• `Optional` pingInterval: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1955 - -___ - -### port - -• `Optional` port: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1948 - -___ - -### protocol - -• `Optional` protocol: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1950 - -___ - -### read\\_default\\_file - -• `Optional` read\\_default\\_file: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1960 - -___ - -### read\\_default\\_group - -• `Optional` read\\_default\\_group: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1961 - -___ - -### secureAuth - -• `Optional` secureAuth: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1956 - -___ - -### ssl - -• `Optional` ssl: undefined \\\| boolean \\\| [MariaSslConfiguration](knex.knex.mariasslconfiguration.md) - -Defined in: node_modules/knex/types/index.d.ts:1958 - -___ - -### streamHWM - -• `Optional` streamHWM: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1963 - -___ - -### unixSocket - -• `Optional` unixSocket: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1949 - -___ - -### user - -• `Optional` user: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1945 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: diff --git a/knex.knex.mariasslconfiguration.md b/knex.knex.mariasslconfiguration.md index eae8339..6841121 100644 --- a/knex.knex.mariasslconfiguration.md +++ b/knex.knex.mariasslconfiguration.md @@ -1,68 +0,0 @@ ---- -id: "knex.knex.mariasslconfiguration" -title: "Interface: MariaSslConfiguration" -sidebar_label: "MariaSslConfiguration" -hide_title: true ---- - -# Interface: MariaSslConfiguration - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MariaSslConfiguration - -## Hierarchy - -* MariaSslConfiguration - -## Properties - -### ca - -• `Optional` ca: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1970 - -___ - -### capath - -• `Optional` capath: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1971 - -___ - -### cert - -• `Optional` cert: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1969 - -___ - -### cipher - -• `Optional` cipher: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1972 - -___ - -### key - -• `Optional` key: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1968 - -___ - -### rejectUnauthorized - -• `Optional` rejectUnauthorized: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1973 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: diff --git a/knex.knex.migration.md b/knex.knex.migration.md index df36410..ecba664 100644 --- a/knex.knex.migration.md +++ b/knex.knex.migration.md @@ -1,30 +0,0 @@ ---- -id: "knex.knex.migration" -title: "Interface: Migration" -sidebar_label: "Migration" -hide_title: true ---- - -# Interface: Migration - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Migration - -## Hierarchy - -* Migration - -## Properties - -### down - -• `Optional` down: undefined \\\| (`kenx`: Knex<any, unknown[]\\>) => PromiseLike<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2105 - -___ - -### up - -• up: (`knex`: Knex<any, unknown[]\\>) => PromiseLike<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2104 diff --git a/knex.knex.migrator.md b/knex.knex.migrator.md index b480aac..6e689cf 100644 --- a/knex.knex.migrator.md +++ b/knex.knex.migrator.md @@ -1,160 +0,0 @@ ---- -id: "knex.knex.migrator" -title: "Interface: Migrator" -sidebar_label: "Migrator" -hide_title: true ---- - -# Interface: Migrator - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Migrator - -## Hierarchy - -* Migrator - -## Methods - -### currentVersion - -▸ currentVersion(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<string\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<string\\> - -Defined in: node_modules/knex/types/index.d.ts:2133 - -___ - -### down - -▸ down(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2136 - -___ - -### forceFreeMigrationsLock - -▸ forceFreeMigrationsLock(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2137 - -___ - -### latest - -▸ latest(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2130 - -___ - -### list - -▸ list(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2134 - -___ - -### make - -▸ make(`name`: string, `config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<string\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`name` \| string \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<string\\> - -Defined in: node_modules/knex/types/index.d.ts:2129 - -___ - -### rollback - -▸ rollback(`config?`: [MigratorConfig](knex.knex.migratorconfig.md), `all?`: boolean): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| -`all?` \| boolean \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2131 - -___ - -### status - -▸ status(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<number\\> - -Defined in: node_modules/knex/types/index.d.ts:2132 - -___ - -### up - -▸ up(`config?`: [MigratorConfig](knex.knex.migratorconfig.md)): Promise<any\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [MigratorConfig](knex.knex.migratorconfig.md) \| - -Returns: Promise<any\\> - -Defined in: node_modules/knex/types/index.d.ts:2135 diff --git a/knex.knex.migratorconfig.md b/knex.knex.migratorconfig.md index e57227f..82d0b5b 100644 --- a/knex.knex.migratorconfig.md +++ b/knex.knex.migratorconfig.md @@ -1,102 +0,0 @@ ---- -id: "knex.knex.migratorconfig" -title: "Interface: MigratorConfig" -sidebar_label: "MigratorConfig" -hide_title: true ---- - -# Interface: MigratorConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MigratorConfig - -## Hierarchy - -* MigratorConfig - -## Properties - -### database - -• `Optional` database: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2115 - -___ - -### directory - -• `Optional` directory: undefined \\\| string \\\| readonly string[] - -Defined in: node_modules/knex/types/index.d.ts:2116 - -___ - -### disableMigrationsListValidation - -• `Optional` disableMigrationsListValidation: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2122 - -___ - -### disableTransactions - -• `Optional` disableTransactions: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2121 - -___ - -### extension - -• `Optional` extension: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2117 - -___ - -### loadExtensions - -• `Optional` loadExtensions: undefined \\\| readonly string[] - -Defined in: node_modules/knex/types/index.d.ts:2124 - -___ - -### migrationSource - -• `Optional` migrationSource: undefined \\\| [MigrationSource](knex.knex.migrationsource.md)<unknown\\> - -Defined in: node_modules/knex/types/index.d.ts:2125 - -___ - -### schemaName - -• `Optional` schemaName: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2120 - -___ - -### sortDirsSeparately - -• `Optional` sortDirsSeparately: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2123 - -___ - -### stub - -• `Optional` stub: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2118 - -___ - -### tableName - -• `Optional` tableName: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2119 diff --git a/knex.knex.mssqlconnectionconfig.md b/knex.knex.mssqlconnectionconfig.md index 4cdcf3f..f8e0f88 100644 --- a/knex.knex.mssqlconnectionconfig.md +++ b/knex.knex.mssqlconnectionconfig.md @@ -1,124 +0,0 @@ ---- -id: "knex.knex.mssqlconnectionconfig" -title: "Interface: MsSqlConnectionConfig" -sidebar_label: "MsSqlConnectionConfig" -hide_title: true ---- - -# Interface: MsSqlConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MsSqlConnectionConfig - -## Hierarchy - -* MsSqlConnectionConfig - -## Properties - -### connectionTimeout - -• `Optional` connectionTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1907 - -___ - -### database - -• database: string - -Defined in: node_modules/knex/types/index.d.ts:1906 - -___ - -### domain - -• `Optional` domain: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1905 - -___ - -### driver - -• `Optional` driver: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1900 - -___ - -### options - -• `Optional` options: undefined \\\| Readonly<{ `abortTransactionOnError?`: undefined \\\| boolean ; `appName?`: undefined \\\| string ; `enableArithAbort?`: undefined \\\| boolean ; `encrypt?`: undefined \\\| boolean ; `instanceName?`: undefined \\\| string ; `isolationLevel?`: undefined \\\| READ_UNCOMMITTED \\\| READ_COMMITTED \\\| REPEATABLE_READ \\\| SERIALIZABLE \\\| SNAPSHOT ; `maxRetriesOnTransientErrors?`: undefined \\\| number ; `multiSubnetFailover?`: undefined \\\| boolean ; `packetSize?`: undefined \\\| number ; `tdsVersion?`: undefined \\\| string ; `trustedConnection?`: undefined \\\| boolean ; `useUTC?`: undefined \\\| boolean }\\> - -Defined in: node_modules/knex/types/index.d.ts:1912 - -___ - -### parseJSON - -• `Optional` parseJSON: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1910 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1902 - -___ - -### pool - -• `Optional` pool: undefined \\\| Readonly<{ `Promise?`: any ; `acquireTimeoutMillis?`: undefined \\\| number ; `autostart?`: undefined \\\| boolean ; `evictionRunIntervalMillis?`: undefined \\\| number ; `fifo?`: undefined \\\| boolean ; `idleTimeoutMillis?`: undefined \\\| number ; `max?`: undefined \\\| number ; `maxWaitingClients?`: undefined \\\| number ; `min?`: undefined \\\| number ; `numTestsPerRun?`: undefined \\\| number ; `priorityRange?`: undefined \\\| number ; `softIdleTimeoutMillis?`: undefined \\\| number ; `testOnBorrow?`: undefined \\\| boolean }\\> - -Defined in: node_modules/knex/types/index.d.ts:1926 - -___ - -### port - -• `Optional` port: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1904 - -___ - -### requestTimeout - -• `Optional` requestTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1908 - -___ - -### server - -• server: string - -Defined in: node_modules/knex/types/index.d.ts:1903 - -___ - -### stream - -• `Optional` stream: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1909 - -___ - -### user - -• `Optional` user: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1901 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: diff --git a/knex.knex.mysql2connectionconfig.md b/knex.knex.mysql2connectionconfig.md index 38e676b..3843e82 100644 --- a/knex.knex.mysql2connectionconfig.md +++ b/knex.knex.mysql2connectionconfig.md @@ -1,366 +0,0 @@ ---- -id: "knex.knex.mysql2connectionconfig" -title: "Interface: MySql2ConnectionConfig" -sidebar_label: "MySql2ConnectionConfig" -hide_title: true ---- - -# Interface: MySql2ConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySql2ConnectionConfig - -## Hierarchy - -* [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md) - - ↳ MySql2ConnectionConfig - -## Properties - -### authPlugins - -• `Optional` authPlugins: undefined \\\| { [pluginName: string]: (`pluginMetadata`: any) => (`pluginData`: any) => any; } - -Defined in: node_modules/knex/types/index.d.ts:2008 - -___ - -### authSwitchHandler - -• `Optional` authSwitchHandler: undefined \\\| (`data`: any, `callback`: () => void) => any - -Defined in: node_modules/knex/types/index.d.ts:2009 - -___ - -### bigNumberStrings - -• `Optional` bigNumberStrings: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[bigNumberStrings](knex.knex.mysqlconnectionconfig.md#bignumberstrings) - -Defined in: node_modules/knex/types/index.d.ts:1994 - -___ - -### charset - -• `Optional` charset: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[charset](knex.knex.mysqlconnectionconfig.md#charset) - -Defined in: node_modules/knex/types/index.d.ts:1986 - -___ - -### charsetNumber - -• `Optional` charsetNumber: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2010 - -___ - -### compress - -• `Optional` compress: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2011 - -___ - -### connectAttributes - -• `Optional` connectAttributes: undefined \\\| { [attrNames: string]: any; } - -Defined in: node_modules/knex/types/index.d.ts:2012 - -___ - -### connectTimeout - -• `Optional` connectTimeout: undefined \\\| number - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[connectTimeout](knex.knex.mysqlconnectionconfig.md#connecttimeout) - -Defined in: node_modules/knex/types/index.d.ts:1988 - -___ - -### database - -• `Optional` database: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[database](knex.knex.mysqlconnectionconfig.md#database) - -Defined in: node_modules/knex/types/index.d.ts:1985 - -___ - -### dateStrings - -• `Optional` dateStrings: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[dateStrings](knex.knex.mysqlconnectionconfig.md#datestrings) - -Defined in: node_modules/knex/types/index.d.ts:1995 - -___ - -### debug - -• `Optional` debug: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[debug](knex.knex.mysqlconnectionconfig.md#debug) - -Defined in: node_modules/knex/types/index.d.ts:1996 - -___ - -### decimalNumbers - -• `Optional` decimalNumbers: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[decimalNumbers](knex.knex.mysqlconnectionconfig.md#decimalnumbers) - -Defined in: node_modules/knex/types/index.d.ts:2001 - -___ - -### enableKeepAlive - -• `Optional` enableKeepAlive: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2013 - -___ - -### flags - -• `Optional` flags: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[flags](knex.knex.mysqlconnectionconfig.md#flags) - -Defined in: node_modules/knex/types/index.d.ts:1999 - -___ - -### host - -• `Optional` host: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[host](knex.knex.mysqlconnectionconfig.md#host) - -Defined in: node_modules/knex/types/index.d.ts:1979 - -___ - -### insecureAuth - -• `Optional` insecureAuth: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[insecureAuth](knex.knex.mysqlconnectionconfig.md#insecureauth) - -Defined in: node_modules/knex/types/index.d.ts:1990 - -___ - -### keepAliveInitialDelay - -• `Optional` keepAliveInitialDelay: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2014 - -___ - -### localAddress - -• `Optional` localAddress: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[localAddress](knex.knex.mysqlconnectionconfig.md#localaddress) - -Defined in: node_modules/knex/types/index.d.ts:1981 - -___ - -### maxPreparedStatements - -• `Optional` maxPreparedStatements: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2015 - -___ - -### multipleStatements - -• `Optional` multipleStatements: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[multipleStatements](knex.knex.mysqlconnectionconfig.md#multiplestatements) - -Defined in: node_modules/knex/types/index.d.ts:1998 - -___ - -### namedPlaceholders - -• `Optional` namedPlaceholders: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2016 - -___ - -### nestTables - -• `Optional` nestTables: undefined \\\| string \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2017 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[password](knex.knex.mysqlconnectionconfig.md#password) - -Defined in: node_modules/knex/types/index.d.ts:1984 - -___ - -### passwordSha1 - -• `Optional` passwordSha1: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2018 - -___ - -### port - -• `Optional` port: undefined \\\| number - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[port](knex.knex.mysqlconnectionconfig.md#port) - -Defined in: node_modules/knex/types/index.d.ts:1980 - -___ - -### queryFormat - -• `Optional` queryFormat: undefined \\\| (`query`: string, `values`: any) => string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[queryFormat](knex.knex.mysqlconnectionconfig.md#queryformat) - -Defined in: node_modules/knex/types/index.d.ts:1992 - -___ - -### rowsAsArray - -• `Optional` rowsAsArray: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2019 - -___ - -### socketPath - -• `Optional` socketPath: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[socketPath](knex.knex.mysqlconnectionconfig.md#socketpath) - -Defined in: node_modules/knex/types/index.d.ts:1982 - -___ - -### ssl - -• `Optional` ssl: undefined \\\| string \\\| [MariaSslConfiguration](knex.knex.mariasslconfiguration.md) - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[ssl](knex.knex.mysqlconnectionconfig.md#ssl) - -Defined in: node_modules/knex/types/index.d.ts:2000 - -___ - -### stream - -• `Optional` stream: undefined \\\| boolean \\\| (`opts`: any) => Stream \\\| Stream - -Defined in: node_modules/knex/types/index.d.ts:2020 - -___ - -### stringifyObjects - -• `Optional` stringifyObjects: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[stringifyObjects](knex.knex.mysqlconnectionconfig.md#stringifyobjects) - -Defined in: node_modules/knex/types/index.d.ts:1989 - -___ - -### supportBigNumbers - -• `Optional` supportBigNumbers: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[supportBigNumbers](knex.knex.mysqlconnectionconfig.md#supportbignumbers) - -Defined in: node_modules/knex/types/index.d.ts:1993 - -___ - -### timezone - -• `Optional` timezone: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[timezone](knex.knex.mysqlconnectionconfig.md#timezone) - -Defined in: node_modules/knex/types/index.d.ts:1987 - -___ - -### trace - -• `Optional` trace: undefined \\\| boolean - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[trace](knex.knex.mysqlconnectionconfig.md#trace) - -Defined in: node_modules/knex/types/index.d.ts:1997 - -___ - -### typeCast - -• `Optional` typeCast: any - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[typeCast](knex.knex.mysqlconnectionconfig.md#typecast) - -Defined in: node_modules/knex/types/index.d.ts:1991 - -___ - -### uri - -• `Optional` uri: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2021 - -___ - -### user - -• `Optional` user: undefined \\\| string - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[user](knex.knex.mysqlconnectionconfig.md#user) - -Defined in: node_modules/knex/types/index.d.ts:1983 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: - -Inherited from: [MySqlConnectionConfig](knex.knex.mysqlconnectionconfig.md).[expirationChecker](knex.knex.mysqlconnectionconfig.md#expirationchecker) diff --git a/knex.knex.mysqlaltercolumnbuilder.md b/knex.knex.mysqlaltercolumnbuilder.md index 94f9c21..c0571f9 100644 --- a/knex.knex.mysqlaltercolumnbuilder.md +++ b/knex.knex.mysqlaltercolumnbuilder.md @@ -1,274 +0,0 @@ ---- -id: "knex.knex.mysqlaltercolumnbuilder" -title: "Interface: MySqlAlterColumnBuilder" -sidebar_label: "MySqlAlterColumnBuilder" -hide_title: true ---- - -# Interface: MySqlAlterColumnBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySqlAlterColumnBuilder - -## Hierarchy - -* [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - - ↳ MySqlAlterColumnBuilder - -## Methods - -### after - -▸ after(`columnName`: string): [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Overrides: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1835 - -___ - -### alter - -▸ alter(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1808 - -___ - -### comment - -▸ comment(`value`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1807 - -___ - -### defaultTo - -▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1803 - -___ - -### first - -▸ first(): [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Returns: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Overrides: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1834 - -___ - -### index - -▸ index(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1797 - -___ - -### notNullable - -▸ notNullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1805 - -___ - -### nullable - -▸ nullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1806 - -___ - -### onDelete - -▸ onDelete(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1801 - -___ - -### onUpdate - -▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1802 - -___ - -### primary - -▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1798 - -___ - -### queryContext - -▸ queryContext(`context`: any): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1809 - -___ - -### references - -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1800 - -___ - -### unique - -▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1799 - -___ - -### unsigned - -▸ unsigned(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1804 - -___ - -### withKeyName - -▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`keyName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [AlterColumnBuilder](knex.knex.altercolumnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1810 diff --git a/knex.knex.mysqlconnectionconfig.md b/knex.knex.mysqlconnectionconfig.md index b7e499b..a330443 100644 --- a/knex.knex.mysqlconnectionconfig.md +++ b/knex.knex.mysqlconnectionconfig.md @@ -1,206 +0,0 @@ ---- -id: "knex.knex.mysqlconnectionconfig" -title: "Interface: MySqlConnectionConfig" -sidebar_label: "MySqlConnectionConfig" -hide_title: true ---- - -# Interface: MySqlConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySqlConnectionConfig - -## Hierarchy - -* MySqlConnectionConfig - - ↳ [MySql2ConnectionConfig](knex.knex.mysql2connectionconfig.md) - -## Properties - -### bigNumberStrings - -• `Optional` bigNumberStrings: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1994 - -___ - -### charset - -• `Optional` charset: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1986 - -___ - -### connectTimeout - -• `Optional` connectTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1988 - -___ - -### database - -• `Optional` database: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1985 - -___ - -### dateStrings - -• `Optional` dateStrings: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1995 - -___ - -### debug - -• `Optional` debug: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1996 - -___ - -### decimalNumbers - -• `Optional` decimalNumbers: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2001 - -___ - -### flags - -• `Optional` flags: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1999 - -___ - -### host - -• `Optional` host: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1979 - -___ - -### insecureAuth - -• `Optional` insecureAuth: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1990 - -___ - -### localAddress - -• `Optional` localAddress: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1981 - -___ - -### multipleStatements - -• `Optional` multipleStatements: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1998 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1984 - -___ - -### port - -• `Optional` port: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:1980 - -___ - -### queryFormat - -• `Optional` queryFormat: undefined \\\| (`query`: string, `values`: any) => string - -Defined in: node_modules/knex/types/index.d.ts:1992 - -___ - -### socketPath - -• `Optional` socketPath: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1982 - -___ - -### ssl - -• `Optional` ssl: undefined \\\| string \\\| [MariaSslConfiguration](knex.knex.mariasslconfiguration.md) - -Defined in: node_modules/knex/types/index.d.ts:2000 - -___ - -### stringifyObjects - -• `Optional` stringifyObjects: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1989 - -___ - -### supportBigNumbers - -• `Optional` supportBigNumbers: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1993 - -___ - -### timezone - -• `Optional` timezone: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1987 - -___ - -### trace - -• `Optional` trace: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:1997 - -___ - -### typeCast - -• `Optional` typeCast: any - -Defined in: node_modules/knex/types/index.d.ts:1991 - -___ - -### user - -• `Optional` user: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:1983 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: diff --git a/knex.knex.onconflictquerybuilder.md b/knex.knex.onconflictquerybuilder.md index 4f85e32..5114735 100644 --- a/knex.knex.onconflictquerybuilder.md +++ b/knex.knex.onconflictquerybuilder.md @@ -1,47 +0,0 @@ ---- -id: "knex.knex.onconflictquerybuilder" -title: "Interface: OnConflictQueryBuilder<TRecord, TResult>" -sidebar_label: "OnConflictQueryBuilder" -hide_title: true ---- - -# Interface: OnConflictQueryBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OnConflictQueryBuilder - -## Type parameters - -Name \| ------- \| -`TRecord` \| -`TResult` \| - -## Hierarchy - -* OnConflictQueryBuilder - -## Methods - -### ignore - -▸ ignore(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:456 - -___ - -### merge - -▸ merge(`data?`: Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data?` \| Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:457 diff --git a/knex.knex.oracledbconnectionconfig.md b/knex.knex.oracledbconnectionconfig.md index 415b05e..13b61a0 100644 --- a/knex.knex.oracledbconnectionconfig.md +++ b/knex.knex.oracledbconnectionconfig.md @@ -1,92 +0,0 @@ ---- -id: "knex.knex.oracledbconnectionconfig" -title: "Interface: OracleDbConnectionConfig" -sidebar_label: "OracleDbConnectionConfig" -hide_title: true ---- - -# Interface: OracleDbConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OracleDbConnectionConfig - -## Hierarchy - -* OracleDbConnectionConfig - -## Properties - -### connectString - -• `Optional` connectString: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2033 - -___ - -### database - -• `Optional` database: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2028 - -___ - -### debug - -• `Optional` debug: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2031 - -___ - -### domain - -• `Optional` domain: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2029 - -___ - -### host - -• host: string - -Defined in: node_modules/knex/types/index.d.ts:2025 - -___ - -### instanceName - -• `Optional` instanceName: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2030 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2027 - -___ - -### requestTimeout - -• `Optional` requestTimeout: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2032 - -___ - -### user - -• user: string - -Defined in: node_modules/knex/types/index.d.ts:2026 - -## Methods - -### expirationChecker - -• `Optional` expirationChecker: diff --git a/knex.knex.orderby.md b/knex.knex.orderby.md index 63f8769..c3ce9d3 100644 --- a/knex.knex.orderby.md +++ b/knex.knex.orderby.md @@ -1,73 +0,0 @@ ---- -id: "knex.knex.orderby" -title: "Interface: OrderBy<TRecord, TResult>" -sidebar_label: "OrderBy" -hide_title: true ---- - -# Interface: OrderBy<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OrderBy - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* OrderBy - -## Callable - -▸ OrderBy(`columnName`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof TRecord, `order?`: asc \\\| desc): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof TRecord \| -`order?` \| asc \\\| desc \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1363 - -▸ OrderBy(`columnName`: string \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>, `order?`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \| -`order?` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1367 - -▸ OrderBy(`columnDefs`: (keyof TRecord \\\| Readonly<{ `column`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof TRecord ; `order?`: undefined \\\| asc \\\| desc }\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnDefs` \| (keyof TRecord \\\| Readonly<{ `column`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof TRecord ; `order?`: undefined \\\| asc \\\| desc }\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1368 - -▸ OrderBy(`columnDefs`: (string \\\| Readonly<{ `column`: string \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> ; `order?`: undefined \\\| string }\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnDefs` \| (string \\\| Readonly<{ `column`: string \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> ; `order?`: undefined \\\| string }\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1376 diff --git a/knex.knex.pgconnectionconfig.md b/knex.knex.pgconnectionconfig.md index 5e2fdea..4388f81 100644 --- a/knex.knex.pgconnectionconfig.md +++ b/knex.knex.pgconnectionconfig.md @@ -1,118 +0,0 @@ ---- -id: "knex.knex.pgconnectionconfig" -title: "Interface: PgConnectionConfig" -sidebar_label: "PgConnectionConfig" -hide_title: true ---- - -# Interface: PgConnectionConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PgConnectionConfig - -## Hierarchy - -* PgConnectionConfig - -## Properties - -### application\\_name - -• `Optional` application\\_name: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2051 - -___ - -### connectionString - -• `Optional` connectionString: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2044 - -___ - -### connectionTimeoutMillis - -• `Optional` connectionTimeoutMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2048 - -___ - -### database - -• `Optional` database: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2040 - -___ - -### host - -• `Optional` host: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2043 - -___ - -### keepAlive - -• `Optional` keepAlive: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2045 - -___ - -### keepAliveInitialDelayMillis - -• `Optional` keepAliveInitialDelayMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2049 - -___ - -### password - -• `Optional` password: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2041 - -___ - -### port - -• `Optional` port: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2042 - -___ - -### ssl - -• `Optional` ssl: undefined \\\| boolean \\\| ConnectionOptions - -Defined in: node_modules/knex/types/index.d.ts:2050 - -___ - -### statement\\_timeout - -• `Optional` statement\\_timeout: undefined \\\| number \\\| false - -Defined in: node_modules/knex/types/index.d.ts:2047 - -___ - -### stream - -• `Optional` stream: undefined \\\| Duplex - -Defined in: node_modules/knex/types/index.d.ts:2046 - -___ - -### user - -• `Optional` user: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2039 diff --git a/knex.knex.poolconfig.md b/knex.knex.poolconfig.md index 4b3d2f5..d8cb8da 100644 --- a/knex.knex.poolconfig.md +++ b/knex.knex.poolconfig.md @@ -1,134 +0,0 @@ ---- -id: "knex.knex.poolconfig" -title: "Interface: PoolConfig" -sidebar_label: "PoolConfig" -hide_title: true ---- - -# Interface: PoolConfig - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PoolConfig - -## Hierarchy - -* PoolConfig - -## Properties - -### acquireTimeoutMillis - -• `Optional` acquireTimeoutMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2089 - -___ - -### afterCreate - -• `Optional` afterCreate: undefined \\\| Function - -Defined in: node_modules/knex/types/index.d.ts:2074 - -___ - -### createRetryIntervalMillis - -• `Optional` createRetryIntervalMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2086 - -___ - -### createTimeoutMillis - -• `Optional` createTimeoutMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2087 - -___ - -### destroyTimeoutMillis - -• `Optional` destroyTimeoutMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2088 - -___ - -### idleTimeoutMillis - -• `Optional` idleTimeoutMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2078 - -___ - -### log - -• `Optional` log: undefined \\\| (`message`: string, `logLevel`: string) => void - -Defined in: node_modules/knex/types/index.d.ts:2082 - -___ - -### max - -• `Optional` max: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2076 - -___ - -### min - -• `Optional` min: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2075 - -___ - -### name - -• `Optional` name: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2073 - -___ - -### priorityRange - -• `Optional` priorityRange: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2081 - -___ - -### propagateCreateError - -• `Optional` propagateCreateError: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2085 - -___ - -### reapIntervalMillis - -• `Optional` reapIntervalMillis: undefined \\\| number - -Defined in: node_modules/knex/types/index.d.ts:2079 - -___ - -### refreshIdle - -• `Optional` refreshIdle: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2077 - -___ - -### returnToHead - -• `Optional` returnToHead: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2080 diff --git a/knex.knex.postgresqlcolumnbuilder.md b/knex.knex.postgresqlcolumnbuilder.md index 3b5dd8b..964dcfa 100644 --- a/knex.knex.postgresqlcolumnbuilder.md +++ b/knex.knex.postgresqlcolumnbuilder.md @@ -1,275 +0,0 @@ ---- -id: "knex.knex.postgresqlcolumnbuilder" -title: "Interface: PostgreSqlColumnBuilder" -sidebar_label: "PostgreSqlColumnBuilder" -hide_title: true ---- - -# Interface: PostgreSqlColumnBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PostgreSqlColumnBuilder - -## Hierarchy - -* [ColumnBuilder](knex.knex.columnbuilder.md) - - ↳ PostgreSqlColumnBuilder - -## Methods - -### after - -▸ after(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1811 - -___ - -### alter - -▸ alter(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1808 - -___ - -### comment - -▸ comment(`value`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1807 - -___ - -### defaultTo - -▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1803 - -___ - -### first - -▸ first(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1812 - -___ - -### index - -▸ index(`indexName?`: string, `indexType?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| -`indexType?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Overrides: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1824 - -___ - -### notNullable - -▸ notNullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1805 - -___ - -### nullable - -▸ nullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1806 - -___ - -### onDelete - -▸ onDelete(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1801 - -___ - -### onUpdate - -▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1802 - -___ - -### primary - -▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1798 - -___ - -### queryContext - -▸ queryContext(`context`: any): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1809 - -___ - -### references - -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1800 - -___ - -### unique - -▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1799 - -___ - -### unsigned - -▸ unsigned(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1804 - -___ - -### withKeyName - -▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`keyName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1810 diff --git a/knex.knex.queryinterface.md b/knex.knex.queryinterface.md index 92e62db..e69f67a 100644 --- a/knex.knex.queryinterface.md +++ b/knex.knex.queryinterface.md @@ -1,1538 +0,0 @@ ---- -id: "knex.knex.queryinterface" -title: "Interface: QueryInterface<TRecord, TResult>" -sidebar_label: "QueryInterface" -hide_title: true ---- - -# Interface: QueryInterface<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).QueryInterface - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| any \| - -## Hierarchy - -* QueryInterface - - ↳ [Knex](knex.knex-2.md) - - ↳ [QueryBuilder](../classes/knex.knex.querybuilder.md) - -## Properties - -### andHaving - -• andHaving: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:543 - -___ - -### andWhere - -• andWhere: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:497 - -___ - -### andWhereBetween - -• andWhereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:521 - -___ - -### andWhereNot - -• andWhereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:500 - -___ - -### andWhereNotBetween - -• andWhereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:524 - -___ - -### andWhereRaw - -• andWhereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:504 - -___ - -### as - -• as: [As](knex.knex.as.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:467 - -___ - -### avg - -• avg: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:586 - -___ - -### avgDistinct - -• avgDistinct: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:587 - -___ - -### column - -• column: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:469 - -___ - -### columns - -• columns: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:468 - -___ - -### count - -• count: [AsymmetricAggregation](knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Defined in: node_modules/knex/types/index.d.ts:580 - -___ - -### countDistinct - -• countDistinct: [AsymmetricAggregation](knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Defined in: node_modules/knex/types/index.d.ts:581 - -___ - -### crossJoin - -• crossJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:486 - -___ - -### distinct - -• distinct: [Distinct](knex.knex.distinct.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:473 - -___ - -### distinctOn - -• distinctOn: [DistinctOn](knex.knex.distincton.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:474 - -___ - -### first - -• first: [Select](knex.knex.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:608 - -___ - -### from - -• from: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:470 - -___ - -### fullOuterJoin - -• fullOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:485 - -___ - -### groupBy - -• groupBy: [GroupBy](knex.knex.groupby.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:527 - -___ - -### groupByRaw - -• groupByRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:528 - -___ - -### having - -• having: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:542 - -___ - -### havingBetween - -• havingBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:551 - -___ - -### havingIn - -• havingIn: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:547 - -___ - -### havingNotBetween - -• havingNotBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:549 - -___ - -### havingRaw - -• havingRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:544 - -___ - -### havingWrapped - -• havingWrapped: [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:506 - -___ - -### innerJoin - -• innerJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:479 - -___ - -### intersect - -• intersect: [Intersect](knex.knex.intersect.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:535 - -___ - -### into - -• into: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:471 - -___ - -### join - -• join: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:477 - -___ - -### joinRaw - -• joinRaw: [JoinRaw](knex.knex.joinraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:478 - -___ - -### leftJoin - -• leftJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:480 - -___ - -### leftOuterJoin - -• leftOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:481 - -___ - -### max - -• max: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:583 - -___ - -### min - -• min: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:582 - -___ - -### orHaving - -• orHaving: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:545 - -___ - -### orHavingBetween - -• orHavingBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:550 - -___ - -### orHavingNotBetween - -• orHavingNotBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:548 - -___ - -### orHavingRaw - -• orHavingRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:546 - -___ - -### orWhere - -• orWhere: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:498 - -___ - -### orWhereBetween - -• orWhereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:520 - -___ - -### orWhereExists - -• orWhereExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:508 - -___ - -### orWhereIn - -• orWhereIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:512 - -___ - -### orWhereNot - -• orWhereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:501 - -___ - -### orWhereNotBetween - -• orWhereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:523 - -___ - -### orWhereNotExists - -• orWhereNotExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:510 - -___ - -### orWhereNotIn - -• orWhereNotIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:514 - -___ - -### orWhereNotNull - -• orWhereNotNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:518 - -___ - -### orWhereNull - -• orWhereNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:516 - -___ - -### orWhereRaw - -• orWhereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:503 - -___ - -### orderBy - -• orderBy: [OrderBy](knex.knex.orderby.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:531 - -___ - -### orderByRaw - -• orderByRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:532 - -___ - -### outerJoin - -• outerJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:484 - -___ - -### rightJoin - -• rightJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:482 - -___ - -### rightOuterJoin - -• rightOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:483 - -___ - -### select - -• select: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:466 - -___ - -### sum - -• sum: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:584 - -___ - -### sumDistinct - -• sumDistinct: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:585 - -___ - -### table - -• table: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:472 - -___ - -### union - -• union: [Union](knex.knex.union.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:538 - -___ - -### unionAll - -• unionAll: [Union](knex.knex.union.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:539 - -___ - -### where - -• where: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:496 - -___ - -### whereBetween - -• whereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:519 - -___ - -### whereExists - -• whereExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:507 - -___ - -### whereIn - -• whereIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:511 - -___ - -### whereNot - -• whereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:499 - -___ - -### whereNotBetween - -• whereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:522 - -___ - -### whereNotExists - -• whereNotExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:509 - -___ - -### whereNotIn - -• whereNotIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:513 - -___ - -### whereNotNull - -• whereNotNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:517 - -___ - -### whereNull - -• whereNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:515 - -___ - -### whereRaw - -• whereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:502 - -___ - -### whereWrapped - -• whereWrapped: [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:505 - -___ - -### with - -• with: [With](knex.knex.with.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:489 - -___ - -### withRaw - -• withRaw: [WithRaw](knex.knex.withraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:491 - -___ - -### withRecursive - -• withRecursive: [With](knex.knex.with.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:490 - -___ - -### withSchema - -• withSchema: [WithSchema](knex.knex.withschema.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:492 - -___ - -### withWrapped - -• withWrapped: [WithWrapped](knex.knex.withwrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:493 - -## Methods - -### clear - -▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:573 - -___ - -### clearCounters - -▸ clearCounters(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:572 - -___ - -### clearGroup - -▸ clearGroup(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:569 - -___ - -### clearHaving - -▸ clearHaving(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:571 - -___ - -### clearOrder - -▸ clearOrder(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:570 - -___ - -### clearSelect - -▸ clearSelect(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:554 - -___ - -### clearWhere - -▸ clearWhere(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:568 - -___ - -### decrement - -▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:598 - -▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:602 - -___ - -### del - -▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:832 - -▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:836 - -▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -Defined in: node_modules/knex/types/index.d.ts:847 - -▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:858 - -▸ del<TResult2\\>(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:862 - -___ - -### delete - -▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:864 - -▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:868 - -▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:879 - -▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:890 - -▸ delete<TResult2\\>(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:894 - -___ - -### increment - -▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:589 - -▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:593 - -___ - -### insert - -▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| * \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:615 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:622 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:636 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:650 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:664 - -▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:678 - -___ - -### limit - -▸ limit(`limit`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`limit` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:577 - -___ - -### modify - -▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord2` \| {} \| any \| -`TResult2` \| {} \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| -`...args` \| any[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:684 - -___ - -### offset - -▸ offset(`offset`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`offset` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:576 - -___ - -### onConflict - -▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| - -Returns: [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:812 - -▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| - -Returns: [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:822 - -___ - -### pluck - -▸ pluck<K\\>(`column`: K): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| K \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -Defined in: node_modules/knex/types/index.d.ts:610 - -▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`TResult2` \| {} \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:613 - -___ - -### returning - -▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:785 - -▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:786 - -▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:797 - -▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:807 - -___ - -### truncate - -▸ truncate(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, void\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, void\\> - -Defined in: node_modules/knex/types/index.d.ts:896 - -___ - -### update - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| K2 \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:688 - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| readonly K2[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:702 - -▸ update<K\\>(`columnName`: K, `value`: Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`value` \| Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:716 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:720 - -▸ update(`data`: Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:726 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:731 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:743 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| string \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \\\| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:755 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:767 - -▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:779 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:783 diff --git a/knex.knex.rawbuilder.md b/knex.knex.rawbuilder.md index a5c3321..ccb6a23 100644 --- a/knex.knex.rawbuilder.md +++ b/knex.knex.rawbuilder.md @@ -1,79 +0,0 @@ ---- -id: "knex.knex.rawbuilder" -title: "Interface: RawBuilder<TRecord, TResult>" -sidebar_label: "RawBuilder" -hide_title: true ---- - -# Interface: RawBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RawBuilder - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| any \| - -## Hierarchy - -* RawBuilder - -## Callable - -▸ RawBuilder<TResult2\\>(`value`: [Value](../modules/knex.knex-1.md#value)): [Raw](knex.knex.raw.md)<TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [Raw](knex.knex.raw.md)<TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1506 - -▸ RawBuilder<TResult2\\>(`sql`: string, ...`bindings`: readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [Raw](knex.knex.raw.md)<TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`...bindings` \| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [Raw](knex.knex.raw.md)<TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1507 - -▸ RawBuilder<TResult2\\>(`sql`: string, `bindings`: [ValueDict](knex.knex.valuedict.md) \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [Raw](knex.knex.raw.md)<TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`bindings` \| [ValueDict](knex.knex.valuedict.md) \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [Raw](knex.knex.raw.md)<TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1508 diff --git a/knex.knex.rawquerybuilder.md b/knex.knex.rawquerybuilder.md index 400098f..d882456 100644 --- a/knex.knex.rawquerybuilder.md +++ b/knex.knex.rawquerybuilder.md @@ -1,64 +0,0 @@ ---- -id: "knex.knex.rawquerybuilder" -title: "Interface: RawQueryBuilder<TRecord, TResult>" -sidebar_label: "RawQueryBuilder" -hide_title: true ---- - -# Interface: RawQueryBuilder<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RawQueryBuilder - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* RawQueryBuilder - - ↳ [WhereRaw](knex.knex.whereraw.md) - - ↳ [GroupBy](knex.knex.groupby.md) - -## Callable - -▸ RawQueryBuilder<TResult2\\>(`sql`: string, `bindings?`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`bindings?` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1483 - -▸ RawQueryBuilder<TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<TResult2\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1487 diff --git a/knex.knex.refbuilder.md b/knex.knex.refbuilder.md index 41a7b83..6a7fdd9 100644 --- a/knex.knex.refbuilder.md +++ b/knex.knex.refbuilder.md @@ -1,34 +0,0 @@ ---- -id: "knex.knex.refbuilder" -title: "Interface: RefBuilder" -sidebar_label: "RefBuilder" -hide_title: true ---- - -# Interface: RefBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RefBuilder - -## Hierarchy - -* RefBuilder - -## Callable - -▸ RefBuilder<TSrc\\>(`src`: TSrc): [Ref](knex.knex.ref.md)<TSrc, { [K in string]: TSrc}\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`TSrc` \| string \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`src` \| TSrc \| - -Returns: [Ref](knex.knex.ref.md)<TSrc, { [K in string]: TSrc}\\> - -Defined in: node_modules/knex/types/index.d.ts:1534 diff --git a/knex.knex.referencingcolumnbuilder.md b/knex.knex.referencingcolumnbuilder.md index c996b89..4468b87 100644 --- a/knex.knex.referencingcolumnbuilder.md +++ b/knex.knex.referencingcolumnbuilder.md @@ -1,290 +0,0 @@ ---- -id: "knex.knex.referencingcolumnbuilder" -title: "Interface: ReferencingColumnBuilder" -sidebar_label: "ReferencingColumnBuilder" -hide_title: true ---- - -# Interface: ReferencingColumnBuilder - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ReferencingColumnBuilder - -## Hierarchy - -* [ColumnBuilder](knex.knex.columnbuilder.md) - - ↳ ReferencingColumnBuilder - -## Methods - -### after - -▸ after(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1811 - -___ - -### alter - -▸ alter(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1808 - -___ - -### comment - -▸ comment(`value`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1807 - -___ - -### defaultTo - -▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1803 - -___ - -### first - -▸ first(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1812 - -___ - -### inTable - -▸ inTable(`tableName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1828 - -___ - -### index - -▸ index(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1797 - -___ - -### notNullable - -▸ notNullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1805 - -___ - -### nullable - -▸ nullable(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1806 - -___ - -### onDelete - -▸ onDelete(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1801 - -___ - -### onUpdate - -▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`command` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1802 - -___ - -### primary - -▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`constraintName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1798 - -___ - -### queryContext - -▸ queryContext(`context`: any): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`context` \| any \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1809 - -___ - -### references - -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1800 - -___ - -### unique - -▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`indexName?` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1799 - -___ - -### unsigned - -▸ unsigned(): [ColumnBuilder](knex.knex.columnbuilder.md) - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1804 - -___ - -### withKeyName - -▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`keyName` \| string \| - -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) - -Inherited from: [ColumnBuilder](knex.knex.columnbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:1810 diff --git a/knex.knex.seederconfig.md b/knex.knex.seederconfig.md index 644cadd..3145074 100644 --- a/knex.knex.seederconfig.md +++ b/knex.knex.seederconfig.md @@ -1,92 +0,0 @@ ---- -id: "knex.knex.seederconfig" -title: "Interface: SeederConfig<V>" -sidebar_label: "SeederConfig" -hide_title: true ---- - -# Interface: SeederConfig<V\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).SeederConfig - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`V` \| {} \| any \| - -## Hierarchy - -* SeederConfig - -## Properties - -### directory - -• `Optional` directory: undefined \\\| string \\\| readonly string[] - -Defined in: node_modules/knex/types/index.d.ts:2142 - -___ - -### extension - -• `Optional` extension: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2141 - -___ - -### loadExtensions - -• `Optional` loadExtensions: undefined \\\| readonly string[] - -Defined in: node_modules/knex/types/index.d.ts:2143 - -___ - -### recursive - -• `Optional` recursive: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2146 - -___ - -### sortDirsSeparately - -• `Optional` sortDirsSeparately: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2147 - -___ - -### specific - -• `Optional` specific: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2144 - -___ - -### stub - -• `Optional` stub: undefined \\\| string - -Defined in: node_modules/knex/types/index.d.ts:2148 - -___ - -### timestampFilenamePrefix - -• `Optional` timestampFilenamePrefix: undefined \\\| boolean - -Defined in: node_modules/knex/types/index.d.ts:2145 - -___ - -### variables - -• `Optional` variables: undefined \\\| V - -Defined in: node_modules/knex/types/index.d.ts:2149 diff --git a/knex.knex.select.md b/knex.knex.select.md index 1aa11cc..7be62ba 100644 --- a/knex.knex.select.md +++ b/knex.knex.select.md @@ -1,235 +0,0 @@ ---- -id: "knex.knex.select" -title: "Interface: Select<TRecord, TResult>" -sidebar_label: "Select" -hide_title: true ---- - -# Interface: Select<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Select - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| unknown[] \| - -## Hierarchy - -* [AliasQueryBuilder](knex.knex.aliasquerybuilder.md)<TRecord, TResult\\> - -* [ColumnNameQueryBuilder](knex.knex.columnnamequerybuilder.md)<TRecord, TResult\\> - - ↳ Select - -## Callable - -▸ Select(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:969 - -▸ Select<TResult2, TInnerRecord, TInnerResult\\>(...`subQueryBuilders`: readonly [QueryBuilder](../classes/knex.knex.querybuilder.md)<TInnerRecord, TInnerResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| ArrayIfAlready<TResult, any\\\\> \| -`TInnerRecord` \| any \| -`TInnerResult` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...subQueryBuilders` \| readonly [QueryBuilder](../classes/knex.knex.querybuilder.md)<TInnerRecord, TInnerResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:970 - -▸ Select<TResult2, TInnerRecord, TInnerResult\\>(`subQueryBuilders`: readonly [QueryBuilder](../classes/knex.knex.querybuilder.md)<TInnerRecord, TInnerResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| ArrayIfAlready<TResult, any\\\\> \| -`TInnerRecord` \| any \| -`TInnerResult` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`subQueryBuilders` \| readonly [QueryBuilder](../classes/knex.knex.querybuilder.md)<TInnerRecord, TInnerResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:974 - -▸ Select<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:917 - -▸ Select<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:928 - -▸ Select<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:940 - -▸ Select<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, IncompatibleToAlt<ArrayMember<AliasUT\\\\>, string, never\\\\>\\\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex.ref.md)<any, TMapping\\\\> ? TMapping : I : never, Dict<any\\\\>, {}\\\\>\\\\>\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| AliasUT \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:952 - -▸ Select(`columnName`: **): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:1428 - -▸ Select<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1434 - -▸ Select<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`ColNameUT` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, ColNameUT & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly ColNameUT[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1445 - -▸ Select<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1456 - -▸ Select<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>\\\\>, keyof TRecord & string\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1468 diff --git a/knex.knex.sql.md b/knex.knex.sql.md index 45bca3c..8bb1ddb 100644 --- a/knex.knex.sql.md +++ b/knex.knex.sql.md @@ -1,56 +0,0 @@ ---- -id: "knex.knex.sql" -title: "Interface: Sql" -sidebar_label: "Sql" -hide_title: true ---- - -# Interface: Sql - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Sql - -## Hierarchy - -* Sql - -## Properties - -### bindings - -• bindings: readonly [Value](../modules/knex.knex-1.md#value)[] - -Defined in: node_modules/knex/types/index.d.ts:1619 - -___ - -### method - -• method: string - -Defined in: node_modules/knex/types/index.d.ts:1617 - -___ - -### options - -• options: any - -Defined in: node_modules/knex/types/index.d.ts:1618 - -___ - -### sql - -• sql: string - -Defined in: node_modules/knex/types/index.d.ts:1620 - -## Methods - -### toNative - -▸ toNative(): [SqlNative](knex.knex.sqlnative.md) - -Returns: [SqlNative](knex.knex.sqlnative.md) - -Defined in: node_modules/knex/types/index.d.ts:1621 diff --git a/knex.knex.table.md b/knex.knex.table.md index 2373a7f..b2393a0 100644 --- a/knex.knex.table.md +++ b/knex.knex.table.md @@ -1,104 +0,0 @@ ---- -id: "knex.knex.table" -title: "Interface: Table<TRecord, TResult>" -sidebar_label: "Table" -hide_title: true ---- - -# Interface: Table<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Table - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| {} \| any \| - -## Hierarchy - -* Table - -## Callable - -▸ Table<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TTable` \| never \| - \| -`TRecord2` \| - \| [TableType](../modules/knex.knex-1.md#tabletype)<TTable\\\\> \| -`TResult2` \| - \| ReplaceBase<TResult, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, base\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| TTable \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:981 - -▸ Table<TRecord2, TResult2\\>(`tableName`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md), `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| unknown \| -`TResult2` \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:989 - -▸ Table<TRecord2, TResult2\\>(`callback`: Function, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| unknown \| -`TResult2` \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| Function \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:996 - -▸ Table<TRecord2, TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<any\\>, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| unknown \| -`TResult2` \| ReplaceBase<TResult, TRecord2\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1003 diff --git a/knex.knex.transaction.md b/knex.knex.transaction.md index 8ecb264..d13d8da 100644 --- a/knex.knex.transaction.md +++ b/knex.knex.transaction.md @@ -1,2137 +0,0 @@ ---- -id: "knex.knex.transaction" -title: "Interface: Transaction<TRecord, TResult>" -sidebar_label: "Transaction" -hide_title: true ---- - -# Interface: Transaction<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Transaction - -## Type parameters - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| any \| - -## Hierarchy - -* Knex<TRecord, TResult\\> - - ↳ Transaction - -## Callable - -▸ Transaction<TTable\\>(`tableName`: TTable, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`TTable` \| never \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| TTable \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:332 - -▸ Transaction<TRecord2, TResult2\\>(`tableName?`: string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md), `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| TRecord \| -`TResult2` \| DeferredKeySelection<TRecord2, never, false, {}, false, {}, never\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName?` \| string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [AliasDict](knex.knex.aliasdict.md) \| -`options?` \| PgTableOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:336 - -## Properties - -### VERSION - -• VERSION: string - -Defined in: node_modules/knex/types/index.d.ts:341 - -___ - -### \\_\\_knex\\_\\_ - -• \\_\\_knex\\_\\_: string - -Defined in: node_modules/knex/types/index.d.ts:342 - -___ - -### andHaving - -• andHaving: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:543 - -___ - -### andWhere - -• andWhere: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:497 - -___ - -### andWhereBetween - -• andWhereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:521 - -___ - -### andWhereNot - -• andWhereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:500 - -___ - -### andWhereNotBetween - -• andWhereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:524 - -___ - -### andWhereRaw - -• andWhereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:504 - -___ - -### as - -• as: [As](knex.knex.as.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:467 - -___ - -### avg - -• avg: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:586 - -___ - -### avgDistinct - -• avgDistinct: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:587 - -___ - -### client - -• client: any - -Defined in: node_modules/knex/types/index.d.ts:375 - -___ - -### column - -• column: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:469 - -___ - -### columns - -• columns: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:468 - -___ - -### count - -• count: [AsymmetricAggregation](knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Defined in: node_modules/knex/types/index.d.ts:580 - -___ - -### countDistinct - -• countDistinct: [AsymmetricAggregation](knex.knex.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> - -Defined in: node_modules/knex/types/index.d.ts:581 - -___ - -### crossJoin - -• crossJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:486 - -___ - -### distinct - -• distinct: [Distinct](knex.knex.distinct.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:473 - -___ - -### distinctOn - -• distinctOn: [DistinctOn](knex.knex.distincton.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:474 - -___ - -### executionPromise - -• executionPromise: Promise<TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1662 - -___ - -### first - -• first: [Select](knex.knex.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:608 - -___ - -### fn - -• fn: [FunctionHelper](knex.knex.functionhelper.md) - -Defined in: node_modules/knex/types/index.d.ts:378 - -___ - -### from - -• from: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:470 - -___ - -### fullOuterJoin - -• fullOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:485 - -___ - -### groupBy - -• groupBy: [GroupBy](knex.knex.groupby.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:527 - -___ - -### groupByRaw - -• groupByRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:528 - -___ - -### having - -• having: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:542 - -___ - -### havingBetween - -• havingBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:551 - -___ - -### havingIn - -• havingIn: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:547 - -___ - -### havingNotBetween - -• havingNotBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:549 - -___ - -### havingRaw - -• havingRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:544 - -___ - -### havingWrapped - -• havingWrapped: [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:506 - -___ - -### innerJoin - -• innerJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:479 - -___ - -### intersect - -• intersect: [Intersect](knex.knex.intersect.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:535 - -___ - -### into - -• into: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:471 - -___ - -### isCompleted - -• isCompleted: () => boolean - -Defined in: node_modules/knex/types/index.d.ts:1663 - -___ - -### join - -• join: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:477 - -___ - -### joinRaw - -• joinRaw: [JoinRaw](knex.knex.joinraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:478 - -___ - -### leftJoin - -• leftJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:480 - -___ - -### leftOuterJoin - -• leftOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:481 - -___ - -### max - -• max: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:583 - -___ - -### migrate - -• migrate: [Migrator](knex.knex.migrator.md) - -Defined in: node_modules/knex/types/index.d.ts:376 - -___ - -### min - -• min: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:582 - -___ - -### orHaving - -• orHaving: [Having](knex.knex.having.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:545 - -___ - -### orHavingBetween - -• orHavingBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:550 - -___ - -### orHavingNotBetween - -• orHavingNotBetween: [HavingRange](knex.knex.havingrange.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:548 - -___ - -### orHavingRaw - -• orHavingRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:546 - -___ - -### orWhere - -• orWhere: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:498 - -___ - -### orWhereBetween - -• orWhereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:520 - -___ - -### orWhereExists - -• orWhereExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:508 - -___ - -### orWhereIn - -• orWhereIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:512 - -___ - -### orWhereNot - -• orWhereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:501 - -___ - -### orWhereNotBetween - -• orWhereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:523 - -___ - -### orWhereNotExists - -• orWhereNotExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:510 - -___ - -### orWhereNotIn - -• orWhereNotIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:514 - -___ - -### orWhereNotNull - -• orWhereNotNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:518 - -___ - -### orWhereNull - -• orWhereNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:516 - -___ - -### orWhereRaw - -• orWhereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:503 - -___ - -### orderBy - -• orderBy: [OrderBy](knex.knex.orderby.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:531 - -___ - -### orderByRaw - -• orderByRaw: [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:532 - -___ - -### outerJoin - -• outerJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:484 - -___ - -### raw - -• raw: [RawBuilder](knex.knex.rawbuilder.md)<TRecord, any\\> - -Defined in: node_modules/knex/types/index.d.ts:344 - -___ - -### ref - -• ref: [RefBuilder](knex.knex.refbuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:379 - -___ - -### rightJoin - -• rightJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:482 - -___ - -### rightOuterJoin - -• rightOuterJoin: [Join](knex.knex.join.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:483 - -___ - -### schema - -• schema: [SchemaBuilder](knex.knex.schemabuilder.md) - -Defined in: node_modules/knex/types/index.d.ts:369 - -___ - -### seed - -• seed: [Seeder](../classes/knex.knex.seeder.md) - -Defined in: node_modules/knex/types/index.d.ts:377 - -___ - -### select - -• select: [Select](knex.knex.select.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:466 - -___ - -### sum - -• sum: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:584 - -___ - -### sumDistinct - -• sumDistinct: [TypePreservingAggregation](knex.knex.typepreservingaggregation.md)<TRecord, TResult, any\\> - -Defined in: node_modules/knex/types/index.d.ts:585 - -___ - -### table - -• table: [Table](knex.knex.table.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:472 - -___ - -### union - -• union: [Union](knex.knex.union.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:538 - -___ - -### unionAll - -• unionAll: [Union](knex.knex.union.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:539 - -___ - -### userParams - -• userParams: Record<string, any\\> - -Defined in: node_modules/knex/types/index.d.ts:380 - -___ - -### where - -• where: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:496 - -___ - -### whereBetween - -• whereBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:519 - -___ - -### whereExists - -• whereExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:507 - -___ - -### whereIn - -• whereIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:511 - -___ - -### whereNot - -• whereNot: [Where](knex.knex.where.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:499 - -___ - -### whereNotBetween - -• whereNotBetween: [WhereBetween](knex.knex.wherebetween.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:522 - -___ - -### whereNotExists - -• whereNotExists: [WhereExists](knex.knex.whereexists.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:509 - -___ - -### whereNotIn - -• whereNotIn: [WhereIn](knex.knex.wherein.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:513 - -___ - -### whereNotNull - -• whereNotNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:517 - -___ - -### whereNull - -• whereNull: [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:515 - -___ - -### whereRaw - -• whereRaw: [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:502 - -___ - -### whereWrapped - -• whereWrapped: [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:505 - -___ - -### with - -• with: [With](knex.knex.with.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:489 - -___ - -### withRaw - -• withRaw: [WithRaw](knex.knex.withraw.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:491 - -___ - -### withRecursive - -• withRecursive: [With](knex.knex.with.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:490 - -___ - -### withSchema - -• withSchema: [WithSchema](knex.knex.withschema.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:492 - -___ - -### withWrapped - -• withWrapped: [WithWrapped](knex.knex.withwrapped.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:493 - -## Methods - -### addListener - -▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:57 - -___ - -### batchInsert - -▸ batchInsert<TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor), `data`: TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord2\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2\\>, {}\\>\\>\\>[])[], `chunkSize?`: number): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| TRecord \| -`TResult2` \| number[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \| -`data` \| TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord2\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord2\\>, {}\\>\\>\\>[])[] \| -`chunkSize?` \| number \| - -Returns: [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:361 - -___ - -### clear - -▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:573 - -___ - -### clearCounters - -▸ clearCounters(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:572 - -___ - -### clearGroup - -▸ clearGroup(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:569 - -___ - -### clearHaving - -▸ clearHaving(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:571 - -___ - -### clearOrder - -▸ clearOrder(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:570 - -___ - -### clearSelect - -▸ clearSelect(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:554 - -___ - -### clearWhere - -▸ clearWhere(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:568 - -___ - -### commit - -▸ commit(`value?`: any): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`value?` \| any \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1674 - -___ - -### decrement - -▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:598 - -▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:602 - -___ - -### del - -▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:832 - -▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:836 - -▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2[]\\> - -Defined in: node_modules/knex/types/index.d.ts:847 - -▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:858 - -▸ del<TResult2\\>(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:862 - -___ - -### delete - -▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:864 - -▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:868 - -▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:879 - -▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:890 - -▸ delete<TResult2\\>(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:894 - -___ - -### destroy - -▸ destroy(`callback`: Function): void - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| Function \| - -Returns: void - -Defined in: node_modules/knex/types/index.d.ts:358 - -▸ destroy(): Promise<void\\> - -Returns: Promise<void\\> - -Defined in: node_modules/knex/types/index.d.ts:359 - -___ - -### emit - -▸ emit(`event`: string \\\| symbol, ...`args`: any[]): boolean - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`...args` \| any[] \| - -Returns: boolean - -Defined in: node_modules/@types/node/events.d.ts:67 - -___ - -### eventNames - -▸ eventNames(): (string \\\| symbol)[] - -Returns: (string \\\| symbol)[] - -Defined in: node_modules/@types/node/events.d.ts:72 - -___ - -### getMaxListeners - -▸ getMaxListeners(): number - -Returns: number - -Defined in: node_modules/@types/node/events.d.ts:64 - -___ - -### increment - -▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:589 - -▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`amount?` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:593 - -___ - -### initialize - -▸ initialize(`config?`: [Config](knex.knex.config.md)<any\\>): void - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| [Config](knex.knex.config.md)<any\\> \| - -Returns: void - -Defined in: node_modules/knex/types/index.d.ts:357 - -___ - -### insert - -▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| * \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:615 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:622 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:636 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:650 - -▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:664 - -▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \\\| readonly (Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<MaybeRawRecord<TRecord\\>, {}\\>\\>\\>[])[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:678 - -___ - -### limit - -▸ limit(`limit`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`limit` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:577 - -___ - -### listenerCount - -▸ listenerCount(`event`: string \\\| symbol): number - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| - -Returns: number - -Defined in: node_modules/@types/node/events.d.ts:68 - -___ - -### listeners - -▸ listeners(`event`: string \\\| symbol): Function[] - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| - -Returns: Function[] - -Defined in: node_modules/@types/node/events.d.ts:65 - -___ - -### modify - -▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord2` \| {} \| any \| -`TResult2` \| {} \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| -`...args` \| any[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:684 - -___ - -### off - -▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:61 - -___ - -### offset - -▸ offset(`offset`: number): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`offset` \| number \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:576 - -___ - -### on - -▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:58 - -___ - -### onConflict - -▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| - -Returns: [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:812 - -▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| - -Returns: [OnConflictQueryBuilder](knex.knex.onconflictquerybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:822 - -___ - -### once - -▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:59 - -___ - -### pluck - -▸ pluck<K\\>(`column`: K): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| K \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TRecord[K][]\\> - -Defined in: node_modules/knex/types/index.d.ts:610 - -▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`TResult2` \| {} \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:613 - -___ - -### prependListener - -▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:70 - -___ - -### prependOnceListener - -▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:71 - -___ - -### query - -▸ query<TRecord, TResult\\>(`conn`: any, `sql`: any, `status`: any, `value`: any): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| -`TResult` \| - \| void \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`conn` \| any \| -`sql` \| any \| -`status` \| any \| -`value` \| any \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1665 - -___ - -### queryBuilder - -▸ queryBuilder<TRecord2, TResult2\\>(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TRecord2` \| TRecord \| -`TResult2` \| TResult \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord2, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:370 - -___ - -### rawListeners - -▸ rawListeners(`event`: string \\\| symbol): Function[] - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| - -Returns: Function[] - -Defined in: node_modules/@types/node/events.d.ts:66 - -___ - -### removeAllListeners - -▸ removeAllListeners(`event?`: string \\\| symbol): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event?` \| string \\\| symbol \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:62 - -___ - -### removeListener - -▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`event` \| string \\\| symbol \| -`listener` \| (...`args`: any[]) => void \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:60 - -___ - -### returning - -▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:785 - -▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:786 - -▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columns` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:797 - -▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`column` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:807 - -___ - -### rollback - -▸ rollback(`error?`: any): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`error?` \| any \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1675 - -___ - -### savepoint - -▸ savepoint<T\\>(`transactionScope`: (`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>) => any): Promise<T\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`T` \| any \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`transactionScope` \| (`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>) => any \| - -Returns: Promise<T\\> - -Defined in: node_modules/knex/types/index.d.ts:1671 - -___ - -### setMaxListeners - -▸ setMaxListeners(`n`: number): [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`n` \| number \| - -Returns: [Transaction](knex.knex.transaction.md)<TRecord, TResult\\> - -Defined in: node_modules/@types/node/events.d.ts:63 - -___ - -### transaction - -▸ transaction(`transactionScope?`: null, `config?`: any): Promise<[Transaction](knex.knex.transaction.md)<any, any\\>\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`transactionScope?` \| null \| -`config?` \| any \| - -Returns: Promise<[Transaction](knex.knex.transaction.md)<any, any\\>\\> - -Defined in: node_modules/knex/types/index.d.ts:349 - -▸ transaction<T\\>(`transactionScope`: (`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>) => void \\\| Promise<T\\>, `config?`: any): Promise<T\\> - -#### Type parameters: - -Name \| ------- \| -`T` \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`transactionScope` \| (`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>) => void \\\| Promise<T\\> \| -`config?` \| any \| - -Returns: Promise<T\\> - -Defined in: node_modules/knex/types/index.d.ts:353 - -___ - -### transactionProvider - -▸ transactionProvider(`config?`: any): function - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`config?` \| any \| - -Returns: function - -Defined in: node_modules/knex/types/index.d.ts:346 - -___ - -### truncate - -▸ truncate(): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, void\\> - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, void\\> - -Defined in: node_modules/knex/types/index.d.ts:896 - -___ - -### update - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| K2 \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:688 - -▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`K1` \| string \| - \| -`K2` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, K2\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K1 \| -`value` \| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>\\> \| -`returning` \| readonly K2[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:702 - -▸ update<K\\>(`columnName`: K, `value`: Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`value` \| Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, number\\> - -Defined in: node_modules/knex/types/index.d.ts:716 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| -`returning` \| string \\\| readonly string[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:720 - -▸ update(`data`: Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| \| -`options?` \| DMLOptions \| - -Returns:** [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> - -Defined in: node_modules/knex/types/index.d.ts:726 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:731 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:743 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| string \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| TKey \\\| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:755 - -▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \| - \| -`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, TRecord\\\\>, TKey\\\\>, {}\\\\>[] \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| -`returning` \| readonly TKey[] \| -`options?` \| DMLOptions \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:767 - -▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : Readonly<Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>\\> \\\| readonly Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:779 - -▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| number \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:783 - -___ - -### withUserParams - -▸ withUserParams(`params`: Record<string, any\\>): Knex<any, unknown[]\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`params` \| Record<string, any\\> \| - -Returns: Knex<any, unknown[]\\> - -Defined in: node_modules/knex/types/index.d.ts:381 diff --git a/knex.knex.typepreservingaggregation.md b/knex.knex.typepreservingaggregation.md index 034e384..b5a3666 100644 --- a/knex.knex.typepreservingaggregation.md +++ b/knex.knex.typepreservingaggregation.md @@ -1,80 +0,0 @@ ---- -id: "knex.knex.typepreservingaggregation" -title: "Interface: TypePreservingAggregation<TRecord, TResult, TValue>" -sidebar_label: "TypePreservingAggregation" -hide_title: true ---- - -# Interface: TypePreservingAggregation<TRecord, TResult, TValue\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).TypePreservingAggregation - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| -`TValue` \| any \| - -## Hierarchy - -* TypePreservingAggregation - -## Callable - -▸ TypePreservingAggregation<TKey, TResult2\\>(...`columnNames`: readonly TKey[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TKey` \| string \\\| number \\\| symbol \| - \| -`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>[TKey]\\\\>, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>[TKey]\\\\>, never\\\\> : Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>[TKey]\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly TKey[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1337 - -▸ TypePreservingAggregation<TAliases, TResult2\\>(`aliases`: TAliases): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TAliases` \| {} \| Readonly<Record<string, string \\\\\| string[] \\\\\| [Raw](knex.knex.raw.md)<any\\\\>\\\\>\\\\> \| -`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & { [K in string \\\\\| number \\\\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, { [K in string \\\\\| number \\\\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}, never\\\\> : { [K in string \\\\\| number \\\\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`aliases` \| TAliases \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1343 - -▸ TypePreservingAggregation<TResult2\\>(...`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| readonly string[] \\\| [Raw](knex.knex.raw.md)<any\\>\\>\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\\\>, TUnionProps\\\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\\\>, never\\\\> : Dict<TValue\\\\>\\\\> \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| readonly string[] \\\| [Raw](knex.knex.raw.md)<any\\>\\>\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1353 diff --git a/knex.knex.union.md b/knex.knex.union.md index e4fb419..9e7240f 100644 --- a/knex.knex.union.md +++ b/knex.knex.union.md @@ -1,50 +0,0 @@ ---- -id: "knex.knex.union" -title: "Interface: Union<TRecord, TResult>" -sidebar_label: "Union" -hide_title: true ---- - -# Interface: Union<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Union - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* [Intersect](knex.knex.intersect.md)<TRecord, TResult\\> - - ↳ Union - -## Callable - -▸ Union(`callback`: MaybeArray<[Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>\\>, `wrap?`: boolean): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| MaybeArray<[Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>\\> \| -`wrap?` \| boolean \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1385 - -▸ Union(...`callbacks`: readonly ([Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`...callbacks` \| readonly ([Raw](knex.knex.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, any\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1389 diff --git a/knex.knex.where.md b/knex.knex.where.md index adb89ae..5edb92e 100644 --- a/knex.knex.where.md +++ b/knex.knex.where.md @@ -1,306 +0,0 @@ ---- -id: "knex.knex.where" -title: "Interface: Where<TRecord, TResult>" -sidebar_label: "Where" -hide_title: true ---- - -# Interface: Where<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Where - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown \| - -## Hierarchy - -* [WhereRaw](knex.knex.whereraw.md)<TRecord, TResult\\> - -* [WhereWrapped](knex.knex.wherewrapped.md)<TRecord, TResult\\> - -* [WhereNull](knex.knex.wherenull.md)<TRecord, TResult\\> - - ↳ Where - -## Callable - -▸ Where(`raw`: [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1205 - -▸ Where(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1206 - -▸ Where(`object`: Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, {}\\>\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`object` \| Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, {}\\>\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1208 - -▸ Where(`object`: Readonly<Object\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`object` \| Readonly<Object\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1210 - -▸ Where<T\\>(`columnName`: T, `value`: null \\\| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`T` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| T \| -`value` \| null \\\| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1212 - -▸ Where(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1217 - -▸ Where<T\\>(`columnName`: T, `operator`: ComparisonOperator, `value`: null \\\| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`T` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| T \| -`operator` \| ComparisonOperator \| -`value` \| null \\\| Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1219 - -▸ Where(`columnName`: string, `operator`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`operator` \| string \| -`value` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1225 - -▸ Where<T, TRecordInner, TResultInner\\>(`columnName`: T, `operator`: ComparisonOperator, `value`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`T` \| string \\\| number \\\| symbol \| -`TRecordInner` \| - \| -`TResultInner` \| - \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| T \| -`operator` \| ComparisonOperator \| -`value` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1230 - -▸ Where<TRecordInner, TResultInner\\>(`columnName`: string, `operator`: string, `value`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| ------- \| -`TRecordInner` \| -`TResultInner` \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`operator` \| string \| -`value` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1236 - -▸ Where(`left`: [Raw](knex.knex.raw.md)<any\\>, `operator`: string, `right`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`left` \| [Raw](knex.knex.raw.md)<any\\> \| -`operator` \| string \| -`right` \| [Value](../modules/knex.knex-1.md#value) \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1242 - -▸ Where<TRecordInner, TResultInner\\>(`left`: [Raw](knex.knex.raw.md)<any\\>, `operator`: string, `right`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| ------- \| -`TRecordInner` \| -`TResultInner` \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`left` \| [Raw](knex.knex.raw.md)<any\\> \| -`operator` \| string \| -`right` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1247 - -▸ Where(`condition`: boolean): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`condition` \| boolean \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1257 - -▸ Where<TResult2\\>(`sql`: string, `bindings?`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`bindings?` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1483 - -▸ Where<TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<TResult2\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1487 - -▸ Where(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1261 - -▸ Where(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| keyof TRecord \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1265 - -▸ Where(`columnName`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1266 diff --git a/knex.knex.wherebetween.md b/knex.knex.wherebetween.md index 938f1d1..09e7983 100644 --- a/knex.knex.wherebetween.md +++ b/knex.knex.wherebetween.md @@ -1,55 +0,0 @@ ---- -id: "knex.knex.wherebetween" -title: "Interface: WhereBetween<TRecord, TResult>" -sidebar_label: "WhereBetween" -hide_title: true ---- - -# Interface: WhereBetween<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereBetween - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* WhereBetween - -## Callable - -▸ WhereBetween<K\\>(`columnName`: K, `range`: readonly (Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`range` \| readonly (Readonly<TRecord[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<TRecord[K]\\>\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1270 - -▸ WhereBetween(`columnName`: string, `range`: readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`range` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1274 diff --git a/knex.knex.wherein.md b/knex.knex.wherein.md index 7e0a2bb..0ec19d1 100644 --- a/knex.knex.wherein.md +++ b/knex.knex.wherein.md @@ -1,169 +0,0 @@ ---- -id: "knex.knex.wherein" -title: "Interface: WhereIn<TRecord, TResult>" -sidebar_label: "WhereIn" -hide_title: true ---- - -# Interface: WhereIn<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereIn - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* WhereIn - -## Callable - -▸ WhereIn<K\\>(`columnName`: K, `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly (Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\>\\>)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly (Readonly<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\> \\\| Readonly<[Raw](knex.knex.raw.md)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\>\\>)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1285 - -▸ WhereIn(`columnName`: string, `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1289 - -▸ WhereIn<K\\>(`columnNames`: readonly K[], `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly readonly (Readonly<ResolveTableType<TRecord, "base"\\>[K]\\> \\\| Readonly<Raw<ResolveTableType<TRecord, "base"\\>[K]\\>\\>)[][]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly K[] \| -`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly readonly (Readonly<ResolveTableType<TRecord, "base"\\>[K]\\> \\\| Readonly<Raw<ResolveTableType<TRecord, "base"\\>[K]\\>\\>)[][] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1293 - -▸ WhereIn(`columnNames`: readonly string[], `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[][]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[][] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1297 - -▸ WhereIn<K, TRecordInner, TResultInner\\>(`columnName`: K, `values`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TRecord[K]\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| -`TRecordInner` \| - \| -`TResultInner` \| - \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| K \| -`values` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TRecord[K]\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1301 - -▸ WhereIn<TRecordInner, TResultInner\\>(`columnName`: string, `values`: [Value](../modules/knex.knex-1.md#value)[] \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| ------- \| -`TRecordInner` \| -`TResultInner` \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnName` \| string \| -`values` \| [Value](../modules/knex.knex-1.md#value)[] \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1305 - -▸ WhereIn<K, TRecordInner, TResultInner\\>(`columnNames`: readonly K[], `values`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TRecord[K]\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| Type \| ------- \| ------ \| -`K` \| string \\\| number \\\| symbol \| -`TRecordInner` \| - \| -`TResultInner` \| - \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly K[] \| -`values` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TRecord[K]\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1309 - -▸ WhereIn<TRecordInner, TResultInner\\>(`columnNames`: readonly string[], `values`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Type parameters: - -Name \| ------- \| -`TRecordInner` \| -`TResultInner` \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly string[] \| -`values` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1313 diff --git a/knex.knex.whereraw.md b/knex.knex.whereraw.md index 7161b84..1d11ff2 100644 --- a/knex.knex.whereraw.md +++ b/knex.knex.whereraw.md @@ -1,76 +0,0 @@ ---- -id: "knex.knex.whereraw" -title: "Interface: WhereRaw<TRecord, TResult>" -sidebar_label: "WhereRaw" -hide_title: true ---- - -# Interface: WhereRaw<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereRaw - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* [RawQueryBuilder](knex.knex.rawquerybuilder.md)<TRecord, TResult\\> - - ↳ WhereRaw - - ↳↳ [Where](knex.knex.where.md) - -## Callable - -▸ WhereRaw(`condition`: boolean): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`condition` \| boolean \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1257 - -▸ WhereRaw<TResult2\\>(`sql`: string, `bindings?`: null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`sql` \| string \| -`bindings?` \| null \\\| string \\\| number \\\| boolean \\\| Date \\\| Buffer \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| [Raw](knex.knex.raw.md)<any\\> \\\| [ValueDict](knex.knex.valuedict.md) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| readonly [RawBinding](../modules/knex.knex-1.md#rawbinding)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1483 - -▸ WhereRaw<TResult2\\>(`raw`: [Raw](knex.knex.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`TResult2` \| TResult \| - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`raw` \| [Raw](knex.knex.raw.md)<TResult2\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult2\\> - -Defined in: node_modules/knex/types/index.d.ts:1487 diff --git a/knex.knex.with.md b/knex.knex.with.md index 724c4f4..168fbe5 100644 --- a/knex.knex.with.md +++ b/knex.knex.with.md @@ -1,80 +0,0 @@ ---- -id: "knex.knex.with" -title: "Interface: With<TRecord, TResult>" -sidebar_label: "With" -hide_title: true ---- - -# Interface: With<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).With - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* [WithRaw](knex.knex.withraw.md)<TRecord, TResult\\> - -* [WithWrapped](knex.knex.withwrapped.md)<TRecord, TResult\\> - - ↳ With - -## Callable - -▸ With(`alias`: string, `raw`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`raw` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex.raw.md)<any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1182 - -▸ With(`alias`: string, `sql`: string, `bindings?`: Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`sql` \| string \| -`bindings?` \| Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[] \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1183 - -▸ With(`alias`: string, `queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`queryBuilder` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1194 - -▸ With(`alias`: string, `callback`: (`queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>) => any): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`callback` \| (`queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>) => any \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1195 diff --git a/knex.knex.withwrapped.md b/knex.knex.withwrapped.md index 6ab19fc..8e54756 100644 --- a/knex.knex.withwrapped.md +++ b/knex.knex.withwrapped.md @@ -1,51 +0,0 @@ ---- -id: "knex.knex.withwrapped" -title: "Interface: WithWrapped<TRecord, TResult>" -sidebar_label: "WithWrapped" -hide_title: true ---- - -# Interface: WithWrapped<TRecord, TResult\\> - -[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WithWrapped - -## Type parameters - -Name \| Default \| ------- \| ------ \| -`TRecord` \| any \| -`TResult` \| unknown[] \| - -## Hierarchy - -* WithWrapped - - ↳ [With](knex.knex.with.md) - -## Callable - -▸ WithWrapped(`alias`: string, `queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`queryBuilder` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1194 - -▸ WithWrapped(`alias`: string, `callback`: (`queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>) => any): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -#### Parameters: - -Name \| Type \| ------- \| ------ \| -`alias` \| string \| -`callback` \| (`queryBuilder`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>) => any \| - -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> - -Defined in: node_modules/knex/types/index.d.ts:1195 diff --git a/knex.knex-1.md b/knex.knex-1.md index 890c1b3..50e0cf7 100644 --- a/knex.knex-1.md +++ b/knex.knex-1.md @@ -0,0 +1,476 @@ +--- +id: "knex.knex-1" +title: "Namespace: Knex" +sidebar_label: "Knex" +custom_edit_url: null +hide_title: true +--- + +# Namespace: Knex + +[knex](knex.md).Knex + +## Table of contents + +### Classes + +- [Client](../classes/knex.knex-1.client.md) +- [KnexTimeoutError](../classes/knex.knex-1.knextimeouterror.md) +- [QueryBuilder](../classes/knex.knex-1.querybuilder.md) +- [Seeder](../classes/knex.knex-1.seeder.md) + +### Interfaces + +- [AliasDict](../interfaces/knex.knex-1.aliasdict.md) +- [AliasQueryBuilder](../interfaces/knex.knex-1.aliasquerybuilder.md) +- [AlterColumnBuilder](../interfaces/knex.knex-1.altercolumnbuilder.md) +- [AlterTableBuilder](../interfaces/knex.knex-1.altertablebuilder.md) +- [As](../interfaces/knex.knex-1.as.md) +- [AsymmetricAggregation](../interfaces/knex.knex-1.asymmetricaggregation.md) +- [BatchInsertBuilder](../interfaces/knex.knex-1.batchinsertbuilder.md) +- [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) +- [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) +- [ColumnInfo](../interfaces/knex.knex-1.columninfo.md) +- [ColumnNameQueryBuilder](../interfaces/knex.knex-1.columnnamequerybuilder.md) +- [Config](../interfaces/knex.knex-1.config.md) +- [ConnectionConfig](../interfaces/knex.knex-1.connectionconfig.md) +- [CreateTableBuilder](../interfaces/knex.knex-1.createtablebuilder.md) +- [Distinct](../interfaces/knex.knex-1.distinct.md) +- [DistinctOn](../interfaces/knex.knex-1.distincton.md) +- [EnumOptions](../interfaces/knex.knex-1.enumoptions.md) +- [ForeignConstraintBuilder](../interfaces/knex.knex-1.foreignconstraintbuilder.md) +- [FunctionHelper](../interfaces/knex.knex-1.functionhelper.md) +- [GroupBy](../interfaces/knex.knex-1.groupby.md) +- [Having](../interfaces/knex.knex-1.having.md) +- [HavingRange](../interfaces/knex.knex-1.havingrange.md) +- [HintComment](../interfaces/knex.knex-1.hintcomment.md) +- [Intersect](../interfaces/knex.knex-1.intersect.md) +- [Join](../interfaces/knex.knex-1.join.md) +- [JoinCallback](../interfaces/knex.knex-1.joincallback.md) +- [JoinClause](../interfaces/knex.knex-1.joinclause.md) +- [JoinRaw](../interfaces/knex.knex-1.joinraw.md) +- [Logger](../interfaces/knex.knex-1.logger.md) +- [MariaSqlConnectionConfig](../interfaces/knex.knex-1.mariasqlconnectionconfig.md) +- [MariaSslConfiguration](../interfaces/knex.knex-1.mariasslconfiguration.md) +- [Migration](../interfaces/knex.knex-1.migration.md) +- [MigrationSource](../interfaces/knex.knex-1.migrationsource.md) +- [Migrator](../interfaces/knex.knex-1.migrator.md) +- [MigratorConfig](../interfaces/knex.knex-1.migratorconfig.md) +- [MsSqlConnectionConfig](../interfaces/knex.knex-1.mssqlconnectionconfig.md) +- [MultikeyForeignConstraintBuilder](../interfaces/knex.knex-1.multikeyforeignconstraintbuilder.md) +- [MySql2ConnectionConfig](../interfaces/knex.knex-1.mysql2connectionconfig.md) +- [MySqlAlterColumnBuilder](../interfaces/knex.knex-1.mysqlaltercolumnbuilder.md) +- [MySqlConnectionConfig](../interfaces/knex.knex-1.mysqlconnectionconfig.md) +- [OnConflictQueryBuilder](../interfaces/knex.knex-1.onconflictquerybuilder.md) +- [OracleDbConnectionConfig](../interfaces/knex.knex-1.oracledbconnectionconfig.md) +- [OrderBy](../interfaces/knex.knex-1.orderby.md) +- [PgConnectionConfig](../interfaces/knex.knex-1.pgconnectionconfig.md) +- [PoolConfig](../interfaces/knex.knex-1.poolconfig.md) +- [PostgreSqlColumnBuilder](../interfaces/knex.knex-1.postgresqlcolumnbuilder.md) +- [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) +- [Raw](../interfaces/knex.knex-1.raw.md) +- [RawBuilder](../interfaces/knex.knex-1.rawbuilder.md) +- [RawQueryBuilder](../interfaces/knex.knex-1.rawquerybuilder.md) +- [Ref](../interfaces/knex.knex-1.ref.md) +- [RefBuilder](../interfaces/knex.knex-1.refbuilder.md) +- [ReferencingColumnBuilder](../interfaces/knex.knex-1.referencingcolumnbuilder.md) +- [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) +- [SeederConfig](../interfaces/knex.knex-1.seederconfig.md) +- [Select](../interfaces/knex.knex-1.select.md) +- [SocketConnectionConfig](../interfaces/knex.knex-1.socketconnectionconfig.md) +- [Sql](../interfaces/knex.knex-1.sql.md) +- [SqlNative](../interfaces/knex.knex-1.sqlnative.md) +- [Sqlite3ConnectionConfig](../interfaces/knex.knex-1.sqlite3connectionconfig.md) +- [StringTagSupport](../interfaces/knex.knex-1.stringtagsupport.md) +- [Table](../interfaces/knex.knex-1.table.md) +- [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) +- [Transaction](../interfaces/knex.knex-1.transaction.md) +- [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md) +- [Union](../interfaces/knex.knex-1.union.md) +- [ValueDict](../interfaces/knex.knex-1.valuedict.md) +- [Where](../interfaces/knex.knex-1.where.md) +- [WhereBetween](../interfaces/knex.knex-1.wherebetween.md) +- [WhereExists](../interfaces/knex.knex-1.whereexists.md) +- [WhereIn](../interfaces/knex.knex-1.wherein.md) +- [WhereNull](../interfaces/knex.knex-1.wherenull.md) +- [WhereRaw](../interfaces/knex.knex-1.whereraw.md) +- [WhereWrapped](../interfaces/knex.knex-1.wherewrapped.md) +- [With](../interfaces/knex.knex-1.with.md) +- [WithRaw](../interfaces/knex.knex-1.withraw.md) +- [WithSchema](../interfaces/knex.knex-1.withschema.md) +- [WithWrapped](../interfaces/knex.knex-1.withwrapped.md) + +## Type aliases + +### AsyncConnectionConfigProvider + +Ƭ AsyncConnectionConfigProvider: () => Promise<[StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig)\\> + +#### Type declaration: + +▸ (): Promise<[StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig)\\> + +Returns: Promise<[StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig)\\> + +Defined in: node_modules/knex/types/index.d.ts:1891 + +___ + +### ClearStatements + +Ƭ ClearStatements: with \\\| select \\\| columns \\\| hintComments \\\| where \\\| union \\\| join \\\| group \\\| order \\\| having \\\| limit \\\| offset \\\| counter \\\| counters + +Defined in: node_modules/knex/types/index.d.ts:463 + +___ + +### ColumnDescriptor + +Ƭ ColumnDescriptor<TRecord, TResult\\>: string \\\| [Raw](../interfaces/knex.knex-1.raw.md) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> \\\| Dict<string\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecord` \| +`TResult` \| + +Defined in: node_modules/knex/types/index.d.ts:409 + +___ + +### CompositeTableType + +Ƭ CompositeTableType<TBase, TInsert, TUpdate\\>: object + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TBase` \| - \| +`TInsert` \| TBase \| +`TUpdate` \| Partial<TInsert\\> \| + +#### Type declaration: + +Name \| Type \| +:------ \| :------ \| +`base` \| TBase \| +`insert` \| TInsert \| +`update` \| TUpdate \| + +Defined in: node_modules/knex/types/index.d.ts:439 + +___ + +### ConnectionConfigProvider + +Ƭ ConnectionConfigProvider: [SyncConnectionConfigProvider](knex.knex-1.md#syncconnectionconfigprovider) \\\| [AsyncConnectionConfigProvider](knex.knex-1.md#asyncconnectionconfigprovider) + +Defined in: node_modules/knex/types/index.d.ts:1889 + +___ + +### DbColumn + +Ƭ DbColumn<TColumn\\>: Readonly<[MaybeRawColumn](knex.knex-1.md#mayberawcolumn)<TColumn\\>\\> + +#### Type parameters: + +Name \| +:------ \| +`TColumn` \| + +Defined in: node_modules/knex/types/index.d.ts:433 + +___ + +### DbRecord + +Ƭ DbRecord<TRecord\\>: Readonly<SafePartial<[MaybeRawRecord](knex.knex-1.md#mayberawrecord)<TRecord\\>\\>\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecord` \| + +Defined in: node_modules/knex/types/index.d.ts:435 + +___ + +### DbRecordArr + +Ƭ DbRecordArr<TRecord\\>: Readonly<MaybeArray<[DbRecord](knex.knex-1.md#dbrecord)<TRecord\\>\\>\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecord` \| + +Defined in: node_modules/knex/types/index.d.ts:437 + +___ + +### ExposedPromiseKeys + +Ƭ ExposedPromiseKeys: then \\\| catch \\\| finally + +Defined in: node_modules/knex/types/index.d.ts:1639 + +___ + +### InferrableColumnDescriptor + +Ƭ InferrableColumnDescriptor<TRecord\\>: keyof TRecord \\\| [Ref](../interfaces/knex.knex-1.ref.md)<any, any\\> \\\| Dict<keyof TRecord\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TRecord` \| object \| + +Defined in: node_modules/knex/types/index.d.ts:415 + +___ + +### IntersectAliases + +Ƭ IntersectAliases<AliasUT\\>: UnionToIntersection<IncompatibleToAlt<AliasUT extends infer I[] ? I extends [Ref](../interfaces/knex.knex-1.ref.md)<any, infer TMapping\\> ? TMapping : I : never, Dict, {}\\>\\> + +#### Type parameters: + +Name \| +:------ \| +`AliasUT` \| + +Defined in: node_modules/knex/types/index.d.ts:905 + +___ + +### LogFn + +Ƭ LogFn: (`message`: any) => void + +#### Type declaration: + +▸ (`message`: any): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`message` \| any \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:2098 + +___ + +### Lookup + +Ƭ Lookup<TRegistry, TKey, TDefault\\>: TKey extends keyof TRegistry ? TRegistry[TKey] : TDefault + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRegistry` \| object \| - \| +`TKey` \| string \| - \| +`TDefault` \| - \| never \| + +Defined in: node_modules/knex/types/index.d.ts:422 + +___ + +### MaybeRawColumn + +Ƭ MaybeRawColumn<TColumn\\>: TColumn \\\| [Raw](../interfaces/knex.knex-1.raw.md)<TColumn\\> + +#### Type parameters: + +Name \| +:------ \| +`TColumn` \| + +Defined in: node_modules/knex/types/index.d.ts:427 + +___ + +### MaybeRawRecord + +Ƭ MaybeRawRecord<TRecord\\>: { [K in keyof TRecord]: MaybeRawColumn<TRecord[K]\\>} + +#### Type parameters: + +Name \| +:------ \| +`TRecord` \| + +Defined in: node_modules/knex/types/index.d.ts:429 + +___ + +### QueryCallback + +Ƭ QueryCallback<TRecord, TResult\\>: (`this`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, `builder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>) => void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +#### Type declaration: + +▸ (`this`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, `builder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`this` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> \| +`builder` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:1577 + +___ + +### QueryCallbackWithArgs + +Ƭ QueryCallbackWithArgs<TRecord, TResult\\>: (`this`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, `builder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, ...`args`: any[]) => void + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +#### Type declaration: + +▸ (`this`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, `builder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\>, ...`args`: any[]): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`this` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> \| +`builder` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> \| +`...args` \| any[] \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:1582 + +___ + +### RawBinding + +Ƭ RawBinding: [Value](knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1487 + +___ + +### RedshiftConnectionConfig + +Ƭ RedshiftConnectionConfig: [PgConnectionConfig](../interfaces/knex.knex-1.pgconnectionconfig.md) + +Defined in: node_modules/knex/types/index.d.ts:2060 + +___ + +### ResolveTableType + +Ƭ ResolveTableType<TCompositeTableType, TScope\\>: TCompositeTableType extends [CompositeTableType](knex.knex-1.md#compositetabletype)<unknown\\> ? TCompositeTableType[TScope] : TCompositeTableType + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TCompositeTableType` \| - \| - \| +`TScope` \| [TableInterfaceScope](knex.knex-1.md#tableinterfacescope) \| base \| + +Defined in: node_modules/knex/types/index.d.ts:451 + +___ + +### StaticConnectionConfig + +Ƭ StaticConnectionConfig: [ConnectionConfig](../interfaces/knex.knex-1.connectionconfig.md) \\\| [MariaSqlConnectionConfig](../interfaces/knex.knex-1.mariasqlconnectionconfig.md) \\\| [MySqlConnectionConfig](../interfaces/knex.knex-1.mysqlconnectionconfig.md) \\\| [MySql2ConnectionConfig](../interfaces/knex.knex-1.mysql2connectionconfig.md) \\\| [MsSqlConnectionConfig](../interfaces/knex.knex-1.mssqlconnectionconfig.md) \\\| [OracleDbConnectionConfig](../interfaces/knex.knex-1.oracledbconnectionconfig.md) \\\| [PgConnectionConfig](../interfaces/knex.knex-1.pgconnectionconfig.md) \\\| [RedshiftConnectionConfig](knex.knex-1.md#redshiftconnectionconfig) \\\| [Sqlite3ConnectionConfig](../interfaces/knex.knex-1.sqlite3connectionconfig.md) \\\| [SocketConnectionConfig](../interfaces/knex.knex-1.socketconnectionconfig.md) + +Defined in: node_modules/knex/types/index.d.ts:1877 + +___ + +### SyncConnectionConfigProvider + +Ƭ SyncConnectionConfigProvider: () => [StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig) + +#### Type declaration: + +▸ (): [StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig) + +Returns: [StaticConnectionConfig](knex.knex-1.md#staticconnectionconfig) + +Defined in: node_modules/knex/types/index.d.ts:1890 + +___ + +### TableDescriptor + +Ƭ TableDescriptor: string \\\| [Raw](../interfaces/knex.knex-1.raw.md) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:420 + +___ + +### TableInterfaceScope + +Ƭ TableInterfaceScope: keyof [CompositeTableType](knex.knex-1.md#compositetabletype)<unknown\\> + +Defined in: node_modules/knex/types/index.d.ts:447 + +___ + +### TableNames + +Ƭ TableNames: keyof Tables + +Defined in: node_modules/knex/types/index.d.ts:445 + +___ + +### TableType + +Ƭ TableType<TTable\\>: Tables[TTable] + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TTable` \| keyof Tables \| + +Defined in: node_modules/knex/types/index.d.ts:449 + +___ + +### Value + +Ƭ Value: string \\\| number \\\| boolean \\\| null \\\| Date \\\| string[] \\\| number[] \\\| Date[] \\\| boolean[] \\\| Buffer \\\| [Raw](../interfaces/knex.knex-1.raw.md) + +Defined in: node_modules/knex/types/index.d.ts:393 + +## Variables + +### RefMemberTag + +• `Const` RefMemberTag: unique symbol + +Defined in: node_modules/knex/types/index.d.ts:1518 diff --git a/cli.clihelper.md b/cli.clihelper.md index e7e7be1..66819b6 100644 --- a/cli.clihelper.md +++ b/cli.clihelper.md @@ -2,6 +2,7 @@ id: "cli.clihelper" title: "Class: CLIHelper" sidebar_label: "CLIHelper" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [cli](../modules/cli.md).CLIHelper -## Hierarchy - -* CLIHelper - ## Constructors ### constructor @@ -30,23 +27,23 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `text` \| string \| `config?` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void -Defined in: [packages/cli/src/CLIHelper.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L42) +Defined in: [packages/cli/src/CLIHelper.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L42) ___ ### dumpDependencies -▸ `Static`dumpDependencies(): Promise<void\\> +▸ `Static`dumpDependencies(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/cli/src/CLIHelper.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L55) +Defined in: [packages/cli/src/CLIHelper.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L55) ___ @@ -57,71 +54,74 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| -`options` \| { `columns`: string[] ; `empty`: string ; `rows`: string[][] } \| +:------ \| :------ \| +`options` \| object \| +`options.columns` \| string[] \| +`options.empty` \| string \| +`options.rows` \| string[][] \| Returns: void -Defined in: [packages/cli/src/CLIHelper.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L83) +Defined in: [packages/cli/src/CLIHelper.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L83) ___ ### getConfigPaths -▸ `Static`getConfigPaths(): Promise<string[]\\> +▸ `Static`getConfigPaths(): Promise<string[]\\> -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/cli/src/CLIHelper.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L51) +Defined in: [packages/cli/src/CLIHelper.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L51) ___ ### getConfiguration -▸ `Static`getConfiguration<D\\>(`validate?`: boolean, `options?`: Partial<[Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): Promise<[Configuration](core.configuration.md)<D\\>\\> +▸ `Static`getConfiguration<D\\>(`validate?`: boolean, `options?`: Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): Promise<[Configuration](core.configuration.md)<D\\>\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `validate` \| boolean \| true \| -`options` \| Partial<[Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| ... \| +`options` \| Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| - \| Returns: Promise<[Configuration](core.configuration.md)<D\\>\\> -Defined in: [packages/cli/src/CLIHelper.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L9) +Defined in: [packages/cli/src/CLIHelper.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L9) ___ ### getDriverDependencies -▸ `Static`getDriverDependencies(): Promise<string[]\\> +▸ `Static`getDriverDependencies(): Promise<string[]\\> -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/cli/src/CLIHelper.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L33) +Defined in: [packages/cli/src/CLIHelper.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L33) ___ ### getModuleVersion -▸ `Static`getModuleVersion(`name`: string): Promise<string\\> +▸ `Static`getModuleVersion(`name`: string): Promise<string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/cli/src/CLIHelper.ts:74](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L74) +Defined in: [packages/cli/src/CLIHelper.ts:74](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L74) ___ @@ -131,21 +131,21 @@ ___ Returns: string -Defined in: [packages/cli/src/CLIHelper.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L29) +Defined in: [packages/cli/src/CLIHelper.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L29) ___ ### getORM -▸ `Static`getORM(`warnWhenNoEntities?`: boolean, `opts?`: Partial<[Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): Promise<[MikroORM](core.mikroorm.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> +▸ `Static`getORM(`warnWhenNoEntities?`: boolean, `opts?`: Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): Promise<[MikroORM](core.mikroorm.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`warnWhenNoEntities?` \| boolean \| - \| -`opts` \| Partial<[Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`warnWhenNoEntities?` \| boolean \| +`opts` \| Partial<[Options](../modules/core.md#options)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| Returns: Promise<[MikroORM](core.mikroorm.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> -Defined in: [packages/cli/src/CLIHelper.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/cli/src/CLIHelper.ts#L13) +Defined in: [packages/cli/src/CLIHelper.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/cli/src/CLIHelper.ts#L13) diff --git a/core.abstractnamingstrategy.md b/core.abstractnamingstrategy.md index b640716..c61328c 100644 --- a/core.abstractnamingstrategy.md +++ b/core.abstractnamingstrategy.md @@ -2,6 +2,7 @@ id: "core.abstractnamingstrategy" title: "Class: AbstractNamingStrategy" sidebar_label: "AbstractNamingStrategy" +custom_edit_url: null hide_title: true --- @@ -37,17 +38,19 @@ hide_title: true ▸ classToMigrationName(`timestamp`: string): string +Return a migration name. This name should allow ordering. + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `timestamp` \| string \| Returns: string Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) ___ @@ -55,17 +58,19 @@ ___ ▸ `Abstract`classToTableName(`entityName`: string): string +Return a table name for an entity class + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L16) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L16) ___ @@ -73,10 +78,12 @@ ___ ▸ getClassName(`file`: string, `separator?`: string): string +Return a name of the class based on its file name + #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `file` \| string \| - \| `separator` \| string \| '-' \| @@ -84,7 +91,7 @@ Name \| Type \| Default value \| Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) ___ @@ -92,17 +99,19 @@ ___ ▸ `Abstract`joinColumnName(`propertyName`: string): string +Return a join column name for a property + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L18) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L18) ___ @@ -110,16 +119,20 @@ ___ ▸ `Abstract`joinKeyColumnName(`entityName`: string, `referencedColumnName?`: string): string +Return the foreign key column name for the given parameters + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `referencedColumnName?` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L20) +Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) + +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L20) ___ @@ -127,10 +140,12 @@ ___ ▸ `Abstract`joinTableName(`sourceEntity`: string, `targetEntity`: string, `propertyName?`: string): string +Return a join table name + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sourceEntity` \| string \| `targetEntity` \| string \| `propertyName?` \| string \| @@ -139,7 +154,7 @@ Name \| Type \| Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L22) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L22) ___ @@ -147,17 +162,19 @@ ___ ▸ `Abstract`propertyToColumnName(`propertyName`: string): string +Return a column name for a property + #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L24) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L24) ___ @@ -165,8 +182,10 @@ ___ ▸ `Abstract`referenceColumnName(): string +Return the default reference column name + Returns: string Implementation of: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L26) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L26) diff --git a/core.arraycollection.md b/core.arraycollection.md index e5e3884..afb3d34 100644 --- a/core.arraycollection.md +++ b/core.arraycollection.md @@ -2,6 +2,7 @@ id: "core.arraycollection" title: "Class: ArrayCollection<T, O>" sidebar_label: "ArrayCollection" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| `O` \| @@ -30,41 +31,41 @@ Name \| ### constructor -\\+ new ArrayCollection<T, O\\>(`owner`: O & Partial<O\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: undefined \\\| IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: undefined \\\| [Platform](core.platform.md) }, `items?`: T[]): [ArrayCollection](core.arraycollection.md)<T, O\\> +\\+ new ArrayCollection<T, O\\>(`owner`: O & Partial<O\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: [Platform](core.platform.md) }, `items?`: T[]): [ArrayCollection](core.arraycollection.md)<T, O\\> #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| O & Partial<O\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: undefined \\\| IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: undefined \\\| [Platform](core.platform.md) } \| +:------ \| :------ \| +`owner` \| O & Partial<O\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: [Platform](core.platform.md) } \| `items?` \| T[] \| Returns: [ArrayCollection](core.arraycollection.md)<T, O\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L14) +Defined in: [packages/core/src/entity/ArrayCollection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L14) ## Properties ### \\_count -• `Protected` `Optional` \\_count: undefined \\\| number +• `Protected` `Optional` \\_count: number -Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L13) +Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L13) ___ ### \\_property -• `Private` `Optional` \\_property: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +• `Private` `Optional` \\_property: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L14) +Defined in: [packages/core/src/entity/ArrayCollection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L14) ___ @@ -72,7 +73,7 @@ ___ • `Protected` initialized: boolean= true -Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L12) +Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L12) ___ @@ -80,35 +81,35 @@ ___ • `Protected` `Readonly` items: Set<T\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L11) +Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L11) ___ ### owner -• `Readonly` owner: O & Partial<O\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: undefined \\\| IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: undefined \\\| [Platform](core.platform.md) } +• `Readonly` owner: O & Partial<O\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: [Platform](core.platform.md) } ## Accessors ### length -• length(): number +• get length(): number Returns: number -Defined in: [packages/core/src/entity/ArrayCollection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L134) +Defined in: [packages/core/src/entity/ArrayCollection.ts:139](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L139) ___ ### property -• property(): [EntityProperty](../interfaces/core.entityproperty.md)<T\\> +• get property(): [EntityProperty](../interfaces/core.entityproperty.md)<T\\> `internal` Returns: [EntityProperty](../interfaces/core.entityproperty.md)<T\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L147) +Defined in: [packages/core/src/entity/ArrayCollection.ts:152](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L152) ## Methods @@ -118,7 +119,7 @@ Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com Returns: IterableIterator<T\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L138) +Defined in: [packages/core/src/entity/ArrayCollection.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L143) ___ @@ -129,12 +130,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L71) +Defined in: [packages/core/src/entity/ArrayCollection.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L71) ___ @@ -145,13 +146,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \\\| [Reference](core.reference.md)<T\\> \| `check?` \| boolean \| Returns: boolean -Defined in: [packages/core/src/entity/ArrayCollection.ts:117](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L117) +Defined in: [packages/core/src/entity/ArrayCollection.ts:122](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L122) ___ @@ -161,7 +162,7 @@ ___ Returns: number -Defined in: [packages/core/src/entity/ArrayCollection.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L122) +Defined in: [packages/core/src/entity/ArrayCollection.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L127) ___ @@ -172,18 +173,18 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\\\> & string \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & number \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & bigint \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & Date \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & { \\`toHexString\\`: () =\\> string } \| +:------ \| :------ \| :------ \| +`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\> & IPrimaryKeyValue \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field?` \| string \| Returns: U[] -Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L53) +Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L53) ___ @@ -193,7 +194,7 @@ ___ Returns: T[] -Defined in: [packages/core/src/entity/ArrayCollection.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L34) +Defined in: [packages/core/src/entity/ArrayCollection.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L34) ___ @@ -206,12 +207,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L92) +Defined in: [packages/core/src/entity/ArrayCollection.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L92) ___ @@ -222,12 +223,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| number \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:197](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L197) +Defined in: [packages/core/src/entity/ArrayCollection.ts:202](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L202) ___ @@ -238,22 +239,22 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `fully` \| boolean \| false \| Returns: boolean -Defined in: [packages/core/src/entity/ArrayCollection.ts:126](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L126) +Defined in: [packages/core/src/entity/ArrayCollection.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L131) ___ ### loadCount -▸ loadCount(): Promise<number\\> +▸ loadCount(): Promise<number\\> -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L30) +Defined in: [packages/core/src/entity/ArrayCollection.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L30) ___ @@ -264,13 +265,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:157](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L157) +Defined in: [packages/core/src/entity/ArrayCollection.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L162) ___ @@ -281,13 +282,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L165) +Defined in: [packages/core/src/entity/ArrayCollection.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L170) ___ @@ -298,13 +299,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L173) +Defined in: [packages/core/src/entity/ArrayCollection.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L178) ___ @@ -315,12 +316,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L102) +Defined in: [packages/core/src/entity/ArrayCollection.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L102) ___ @@ -330,7 +331,7 @@ ___ Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L113) +Defined in: [packages/core/src/entity/ArrayCollection.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L118) ___ @@ -341,12 +342,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void -Defined in: [packages/core/src/entity/ArrayCollection.ts:84](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L84) +Defined in: [packages/core/src/entity/ArrayCollection.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L84) ___ @@ -357,30 +358,30 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `collection` \| [ArrayCollection](core.arraycollection.md)<O, T\\> \| `method` \| add \\\| remove \| Returns: boolean -Defined in: [packages/core/src/entity/ArrayCollection.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L184) +Defined in: [packages/core/src/entity/ArrayCollection.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L189) ___ ### toArray -▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] -Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L38) +Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L38) ___ ### toJSON -▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] -Defined in: [packages/core/src/entity/ArrayCollection.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L49) +Defined in: [packages/core/src/entity/ArrayCollection.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L49) diff --git a/core.arraytype.md b/core.arraytype.md index 0d1e2cd..286a262 100644 --- a/core.arraytype.md +++ b/core.arraytype.md @@ -2,6 +2,7 @@ id: "core.arraytype" title: "Class: ArrayType<T>" sidebar_label: "ArrayType" +custom_edit_url: null hide_title: true --- @@ -12,12 +13,12 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| string \\\| number \| string \| ## Hierarchy -* [Type](core.type.md)<T[] \\\| null, string \\\| null\\> +* [Type](core.type.md)<T[] \\\| null, string \\\| null\\> ↳ ArrayType @@ -32,20 +33,20 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| string \\\| number \| string \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`hydrate` \| (`i`: string) => T \| ... \| +Name \| Type \| +:------ \| :------ \| +`hydrate` \| (`i`: string) => T \| Returns: [ArrayType](core.arraytype.md)<T\\> -Inherited from: [Type](core.type.md) +Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L7) +Defined in: [packages/core/src/types/ArrayType.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L7) ## Methods @@ -57,7 +58,7 @@ Defined in: [packages/core/src/types/ArrayType.ts:7](https://github.com/mikro-or Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L41) +Defined in: [packages/core/src/types/ArrayType.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L41) ___ @@ -68,7 +69,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| null \\\| T[] \| `platform` \| [Platform](core.platform.md) \| `fromQuery?` \| boolean \| @@ -77,7 +78,28 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L13) +Defined in: [packages/core/src/types/ArrayType.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L13) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -88,7 +110,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| null \\\| string \\\| T[] \| `platform` \| [Platform](core.platform.md) \| @@ -96,26 +118,47 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L29) +Defined in: [packages/core/src/types/ArrayType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L29) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L49) +Defined in: [packages/core/src/types/ArrayType.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L49) ___ @@ -126,14 +169,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| T[] \| Returns: T[] Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/ArrayType.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L45) +Defined in: [packages/core/src/types/ArrayType.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L45) ___ @@ -144,18 +187,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.baseentity.md b/core.baseentity.md index bcb4e26..e3a8534 100644 --- a/core.baseentity.md +++ b/core.baseentity.md @@ -2,6 +2,7 @@ id: "core.baseentity" title: "Class: BaseEntity<T, PK, P>" sidebar_label: "BaseEntity" +custom_edit_url: null hide_title: true --- @@ -12,15 +13,11 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| `PK` \| keyof T \| - \| `P` \| [Populate](../modules/core.md#populate)<T\\> \\\| unknown \| unknown \| -## Hierarchy - -* BaseEntity - ## Implements * [IWrappedEntity](../interfaces/core.iwrappedentity.md)<T, PK, P\\> @@ -34,14 +31,14 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| `PK` \| string \\\| number \\\| symbol \| - \| `P` \| unknown \| unknown \| Returns: [BaseEntity](core.baseentity.md)<T, PK, P\\> -Defined in: [packages/core/src/entity/BaseEntity.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L5) +Defined in: [packages/core/src/entity/BaseEntity.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L5) ## Methods @@ -52,13 +49,15 @@ Defined in: [packages/core/src/entity/BaseEntity.ts:5](https://github.com/mikro- #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `options?` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/entity/BaseEntity.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L35) +Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) + +Defined in: [packages/core/src/entity/BaseEntity.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L35) ___ @@ -69,12 +68,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `populated` \| boolean \| true \| Returns: Promise<T\\> -Defined in: [packages/core/src/entity/BaseEntity.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L39) +Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) + +Defined in: [packages/core/src/entity/BaseEntity.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L39) ___ @@ -86,7 +87,7 @@ ___ Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L11) +Defined in: [packages/core/src/entity/BaseEntity.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L11) ___ @@ -97,50 +98,50 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `populated` \| boolean \| true \| Returns: void Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L15) +Defined in: [packages/core/src/entity/BaseEntity.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L15) ___ ### toJSON -▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L27) +Defined in: [packages/core/src/entity/BaseEntity.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L27) ___ ### toObject -▸ toObject(`ignoreFields?`: string[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toObject(`ignoreFields?`: string[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`ignoreFields` \| string[] \| ... \| +Name \| Type \| +:------ \| :------ \| +`ignoreFields` \| string[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L23) +Defined in: [packages/core/src/entity/BaseEntity.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L23) ___ @@ -152,7 +153,7 @@ ___ Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L31) +Defined in: [packages/core/src/entity/BaseEntity.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L31) ___ @@ -164,4 +165,4 @@ ___ Implementation of: [IWrappedEntity](../interfaces/core.iwrappedentity.md) -Defined in: [packages/core/src/entity/BaseEntity.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/BaseEntity.ts#L19) +Defined in: [packages/core/src/entity/BaseEntity.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/BaseEntity.ts#L19) diff --git a/core.biginttype.md b/core.biginttype.md index 39c80c1..1b25c10 100644 --- a/core.biginttype.md +++ b/core.biginttype.md @@ -2,6 +2,7 @@ id: "core.biginttype" title: "Class: BigIntType" sidebar_label: "BigIntType" +custom_edit_url: null hide_title: true --- @@ -13,7 +14,7 @@ This type will automatically convert string values returned from the database to ## Hierarchy -* [Type](core.type.md)<string \\\| bigint \\\| null \\\| undefined, string \\\| null \\\| undefined\\> +* [Type](core.type.md)<string \\\| bigint \\\| null \\\| undefined, string \\\| null \\\| undefined\\> ↳ BigIntType @@ -40,7 +41,7 @@ Possible values: string \| number \| boolean \| date \| any \| buffer \| array Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L26) +Defined in: [packages/core/src/types/Type.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L36) ___ @@ -51,14 +52,35 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| undefined \\\| null \\\| string \\\| bigint \| Returns: undefined \\\| null \\\| string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BigIntType.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BigIntType.ts#L10) +Defined in: [packages/core/src/types/BigIntType.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BigIntType.ts#L10) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -69,33 +91,54 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| undefined \\\| null \\\| string \\\| bigint \| Returns: undefined \\\| null \\\| string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BigIntType.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BigIntType.ts#L18) +Defined in: [packages/core/src/types/BigIntType.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BigIntType.ts#L18) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BigIntType.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BigIntType.ts#L26) +Defined in: [packages/core/src/types/BigIntType.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BigIntType.ts#L26) ___ @@ -109,7 +152,7 @@ By default uses the runtime value. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| undefined \\\| null \\\| string \\\| bigint \| `platform` \| [Platform](core.platform.md) \| @@ -117,7 +160,7 @@ Name \| Type \| Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L34) +Defined in: [packages/core/src/types/Type.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L44) ___ @@ -128,18 +171,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.blobtype.md b/core.blobtype.md index 63452c0..0cfb805 100644 --- a/core.blobtype.md +++ b/core.blobtype.md @@ -2,6 +2,7 @@ id: "core.blobtype" title: "Class: BlobType" sidebar_label: "BlobType" +custom_edit_url: null hide_title: true --- @@ -35,7 +36,7 @@ Inherited from: [Type](core.type.md) Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BlobType.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BlobType.ts#L25) +Defined in: [packages/core/src/types/BlobType.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BlobType.ts#L25) ___ @@ -46,7 +47,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| Buffer \| `platform` \| [Platform](core.platform.md) \| @@ -54,7 +55,28 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BlobType.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BlobType.ts#L7) +Defined in: [packages/core/src/types/BlobType.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BlobType.ts#L7) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -65,7 +87,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| Buffer \| `platform` \| [Platform](core.platform.md) \| @@ -73,26 +95,47 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BlobType.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BlobType.ts#L11) +Defined in: [packages/core/src/types/BlobType.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BlobType.ts#L11) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/BlobType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/BlobType.ts#L29) +Defined in: [packages/core/src/types/BlobType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/BlobType.ts#L29) ___ @@ -106,7 +149,7 @@ By default uses the runtime value. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| null \\\| Buffer \| `platform` \| [Platform](core.platform.md) \| @@ -114,7 +157,7 @@ Name \| Type \| Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L34) +Defined in: [packages/core/src/types/Type.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L44) ___ @@ -125,18 +168,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.changeset.md b/core.changeset.md index 6842632..bbccfed 100644 --- a/core.changeset.md +++ b/core.changeset.md @@ -2,6 +2,7 @@ id: "core.changeset" title: "Class: ChangeSet<T>" sidebar_label: "ChangeSet" +custom_edit_url: null hide_title: true --- @@ -12,13 +13,9 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| -## Hierarchy - -* ChangeSet - ## Constructors ### constructor @@ -28,13 +25,13 @@ Name \| Type \| #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `type` \| [ChangeSetType](../enums/core.changesettype.md) \| `payload` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -42,7 +39,7 @@ Name \| Type \| Returns: [ChangeSet](core.changeset.md)<T\\> -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:3](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L3) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:3](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L3) ## Properties @@ -50,7 +47,7 @@ Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:3](https://github.com/m • collection: string -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L19) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L19) ___ @@ -58,7 +55,7 @@ ___ • entity: T -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L21) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L21) ___ @@ -66,15 +63,15 @@ ___ • name: string -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L17) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L17) ___ ### originalEntity -• `Optional` originalEntity: undefined \\\| [EntityData](../modules/core.md#entitydata)<T\\> +• `Optional` originalEntity: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L24) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L24) ___ @@ -82,7 +79,7 @@ ___ • payload: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L22) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L22) ___ @@ -90,7 +87,7 @@ ___ • persisted: boolean -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L23) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L23) ___ @@ -98,7 +95,7 @@ ___ • rootName: string -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L18) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L18) ___ @@ -106,4 +103,4 @@ ___ • type: [ChangeSetType](../enums/core.changesettype.md) -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L20) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L20) diff --git a/core.changesetcomputer.md b/core.changesetcomputer.md index 46488ef..c693c1b 100644 --- a/core.changesetcomputer.md +++ b/core.changesetcomputer.md @@ -2,6 +2,7 @@ id: "core.changesetcomputer" title: "Class: ChangeSetComputer" sidebar_label: "ChangeSetComputer" +custom_edit_url: null hide_title: true --- @@ -9,30 +10,26 @@ hide_title: true [core](../modules/core.md).ChangeSetComputer -## Hierarchy - -* ChangeSetComputer - ## Constructors ### constructor -\\+ new ChangeSetComputer(`validator`: [EntityValidator](core.entityvalidator.md), `collectionUpdates`: Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\>, `removeStack`: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `metadata`: [MetadataStorage](core.metadatastorage.md), `platform`: [Platform](core.platform.md), `config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>): [ChangeSetComputer](core.changesetcomputer.md) +\\+ new ChangeSetComputer(`validator`: [EntityValidator](core.entityvalidator.md), `collectionUpdates`: Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\>, `removeStack`: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `metadata`: [MetadataStorage](core.metadatastorage.md), `platform`: [Platform](core.platform.md), `config`: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>): [ChangeSetComputer](core.changesetcomputer.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `validator` \| [EntityValidator](core.entityvalidator.md) \| -`collectionUpdates` \| Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\> \| -`removeStack` \| Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`collectionUpdates` \| Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\> \| +`removeStack` \| Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `platform` \| [Platform](core.platform.md) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [ChangeSetComputer](core.changesetcomputer.md) -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L12) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L12) ## Properties @@ -40,7 +37,7 @@ Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://git • `Private` `Readonly` comparator: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L12) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L12) ## Methods @@ -51,18 +48,18 @@ Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:12](https://git #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: null \\\| [ChangeSet](core.changeset.md)<T\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L21) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L21) ___ @@ -73,18 +70,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L50) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L50) ___ @@ -95,19 +92,19 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L63) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L63) ___ @@ -118,19 +115,19 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L83) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L83) ___ @@ -141,16 +138,16 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:73](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetComputer.ts#L73) +Defined in: [packages/core/src/unit-of-work/ChangeSetComputer.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetComputer.ts#L73) diff --git a/core.changesetpersister.md b/core.changesetpersister.md index 0cc9344..b3434a2 100644 --- a/core.changesetpersister.md +++ b/core.changesetpersister.md @@ -2,6 +2,7 @@ id: "core.changesetpersister" title: "Class: ChangeSetPersister" sidebar_label: "ChangeSetPersister" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).ChangeSetPersister -## Hierarchy - -* ChangeSetPersister - ## Constructors ### constructor @@ -22,7 +19,7 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `driver` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `hydrator` \| IHydrator \| @@ -31,7 +28,7 @@ Name \| Type \| Returns: [ChangeSetPersister](core.changesetpersister.md) -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L12) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L12) ## Properties @@ -39,7 +36,7 @@ Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://gi • `Private` `Readonly` platform: [Platform](core.platform.md) -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L12) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L12) ## Methods @@ -50,114 +47,114 @@ Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:12](https://gi #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `res?` \| [QueryResult](../interfaces/core.queryresult.md) \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L211) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L211) ___ ### checkOptimisticLocks -▸ `Private`checkOptimisticLocks<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`checkOptimisticLocks<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:192](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L192) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:192](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L192) ___ ### executeDeletes -▸ executeDeletes<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ executeDeletes<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L46) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L46) ___ ### executeInserts -▸ executeInserts<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ executeInserts<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L20) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L20) ___ ### executeUpdates -▸ executeUpdates<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `batched`: boolean, `ctx?`: any): Promise<void\\> +▸ executeUpdates<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `batched`: boolean, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `batched` \| boolean \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L33) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L33) ___ @@ -168,20 +165,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `value` \| IPrimaryKeyValue \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:142](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L142) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:142](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L142) ___ @@ -196,20 +193,20 @@ We do need to map to the change set payload too, as it will be used in the origi #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `res` \| [QueryResult](../interfaces/core.queryresult.md) \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:273](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L273) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:273](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L273) ___ @@ -222,162 +219,162 @@ Sets populate flag to new entities so they are serialized like if they were load #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:162](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L162) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L162) ___ ### persistManagedEntities -▸ `Private`persistManagedEntities<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`persistManagedEntities<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:126](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L126) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:126](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L126) ___ ### persistManagedEntitiesBatch -▸ `Private`persistManagedEntitiesBatch<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`persistManagedEntitiesBatch<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L136) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L136) ___ ### persistManagedEntity -▸ `Private`persistManagedEntity<T\\>(`changeSet`: [ChangeSet](core.changeset.md)<T\\>, `ctx?`: any): Promise<void\\> +▸ `Private`persistManagedEntity<T\\>(`changeSet`: [ChangeSet](core.changeset.md)<T\\>, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L118) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L118) ___ ### persistNewEntities -▸ `Private`persistNewEntities<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`persistNewEntities<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L86) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L86) ___ ### persistNewEntitiesBatch -▸ `Private`persistNewEntitiesBatch<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`persistNewEntitiesBatch<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L99) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L99) ___ ### persistNewEntity -▸ `Private`persistNewEntity<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSet`: [ChangeSet](core.changeset.md)<T\\>, `ctx?`: any): Promise<void\\> +▸ `Private`persistNewEntity<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSet`: [ChangeSet](core.changeset.md)<T\\>, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:66](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L66) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L66) ___ @@ -388,18 +385,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L58) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L58) ___ @@ -410,43 +407,43 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:244](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L244) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:244](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L244) ___ ### reloadVersionValues -▸ `Private`reloadVersionValues<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`reloadVersionValues<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:217](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L217) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:217](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L217) ___ @@ -457,17 +454,17 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `ctx?` \| any \| Returns: Promise<[QueryResult](../interfaces/core.queryresult.md)\\> -Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:179](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSetPersister.ts#L179) +Defined in: [packages/core/src/unit-of-work/ChangeSetPersister.ts:179](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSetPersister.ts#L179) diff --git a/core.collection.md b/core.collection.md index 322ff91..8dc1864 100644 --- a/core.collection.md +++ b/core.collection.md @@ -2,6 +2,7 @@ id: "core.collection" title: "Class: Collection<T, O>" sidebar_label: "Collection" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `O` \| unknown \| @@ -33,33 +34,33 @@ Name \| Default \| #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `O` \| unknown \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `owner` \| O \| - \| `items?` \| T[] \| - \| `initialized` \| boolean \| true \| Returns: [Collection](core.collection.md)<T, O\\> -Inherited from: [ArrayCollection](core.arraycollection.md) +Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L13) +Defined in: [packages/core/src/entity/Collection.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L22) ## Properties ### \\_count -• `Protected` `Optional` \\_count: undefined \\\| number +• `Protected` `Optional` \\_count: number Inherited from: [ArrayCollection](core.arraycollection.md).[_count](core.arraycollection.md#_count) -Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L13) +Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L13) ___ @@ -67,7 +68,7 @@ ___ • `Private` \\_lazyInitialized: boolean= false -Defined in: [packages/core/src/entity/Collection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L13) +Defined in: [packages/core/src/entity/Collection.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L22) ___ @@ -75,7 +76,7 @@ ___ • `Private` \\_populated: boolean= false -Defined in: [packages/core/src/entity/Collection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L12) +Defined in: [packages/core/src/entity/Collection.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L21) ___ @@ -83,7 +84,7 @@ ___ • `Private` dirty: boolean= false -Defined in: [packages/core/src/entity/Collection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L11) +Defined in: [packages/core/src/entity/Collection.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L19) ___ @@ -93,7 +94,7 @@ ___ Inherited from: [ArrayCollection](core.arraycollection.md).[initialized](core.arraycollection.md#initialized) -Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L12) +Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L12) ___ @@ -103,45 +104,53 @@ ___ Inherited from: [ArrayCollection](core.arraycollection.md).[items](core.arraycollection.md#items) -Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L11) +Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L11) ___ ### owner -• `Readonly` owner: O & Partial<O\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: undefined \\\| IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: undefined \\\| [Platform](core.platform.md) } +• `Readonly` owner: O & Partial<O\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<O, keyof O, keyof O\\> ; `__meta?`: [EntityMetadata](core.entitymetadata.md)<O\\> ; `__platform?`: [Platform](core.platform.md) } Inherited from: [ArrayCollection](core.arraycollection.md).[owner](core.arraycollection.md#owner) ___ +### readonly + +• `Private` `Optional` readonly: boolean + +Defined in: [packages/core/src/entity/Collection.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L20) + +___ + ### snapshot • `Private` snapshot: undefined \\\| T[] -Defined in: [packages/core/src/entity/Collection.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L10) +Defined in: [packages/core/src/entity/Collection.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L18) ## Accessors ### length -• length(): number +• get length(): number Returns: number -Defined in: [packages/core/src/entity/ArrayCollection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L134) +Defined in: [packages/core/src/entity/ArrayCollection.ts:139](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L139) ___ ### property -• property(): [EntityProperty](../interfaces/core.entityproperty.md)<T\\> +• get property(): [EntityProperty](../interfaces/core.entityproperty.md)<T\\> `internal` Returns: [EntityProperty](../interfaces/core.entityproperty.md)<T\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L147) +Defined in: [packages/core/src/entity/ArrayCollection.ts:152](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L152) ## Methods @@ -153,7 +162,7 @@ Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L138) +Defined in: [packages/core/src/entity/ArrayCollection.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L143) ___ @@ -164,14 +173,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L91) +Defined in: [packages/core/src/entity/Collection.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L118) ___ @@ -182,12 +191,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:298](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L298) +Defined in: [packages/core/src/entity/Collection.ts:332](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L332) ___ @@ -197,7 +206,7 @@ ___ Returns: void -Defined in: [packages/core/src/entity/Collection.ts:283](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L283) +Defined in: [packages/core/src/entity/Collection.ts:317](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L317) ___ @@ -208,7 +217,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `item` \| T \\\| [Reference](core.reference.md)<T\\> \| - \| `check` \| boolean \| true \| @@ -216,7 +225,7 @@ Name \| Type \| Default value \| Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L134) +Defined in: [packages/core/src/entity/Collection.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L161) ___ @@ -228,7 +237,7 @@ ___ Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:142](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L142) +Defined in: [packages/core/src/entity/Collection.ts:169](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L169) ___ @@ -239,50 +248,50 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| Returns: [FilterQuery](../modules/core.md#filterquery)<T\\> -Defined in: [packages/core/src/entity/Collection.ts:230](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L230) +Defined in: [packages/core/src/entity/Collection.ts:263](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L263) ___ ### createLoadCountCondition -▸ `Private`createLoadCountCondition(`cond`: [Dictionary](../modules/core.md#dictionary)<any\\>): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ `Private`createLoadCountCondition(`cond`: [Dictionary](../modules/core.md#dictionary)<any\\>): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/entity/Collection.ts:263](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L263) +Defined in: [packages/core/src/entity/Collection.ts:296](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L296) ___ ### createManyToManyCondition -▸ `Private`createManyToManyCondition(`cond`: [Dictionary](../modules/core.md#dictionary)<any\\>): void +▸ `Private`createManyToManyCondition(`cond`: [Dictionary](../modules/core.md#dictionary)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L252) +Defined in: [packages/core/src/entity/Collection.ts:285](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L285) ___ @@ -292,13 +301,23 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`orderBy` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| ... \| +Name \| Type \| +:------ \| :------ \| +`orderBy` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: [QueryOrderMap](../interfaces/core.queryordermap.md) -Defined in: [packages/core/src/entity/Collection.ts:240](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L240) +Defined in: [packages/core/src/entity/Collection.ts:273](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L273) + +___ + +### getEntityManager + +▸ `Private`getEntityManager(): any + +Returns: any + +Defined in: [packages/core/src/entity/Collection.ts:253](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L253) ___ @@ -309,20 +328,20 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\\\> & string \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & number \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & bigint \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & Date \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & { \\`toHexString\\`: () =\\> string } \| +:------ \| :------ \| :------ \| +`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\> & IPrimaryKeyValue \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field?` \| string \| Returns: U[] Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L53) +Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L53) ___ @@ -335,14 +354,14 @@ Returns the items (the collection must be initialized) #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `check` \| boolean \| true \| Returns: T[] Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L75) +Defined in: [packages/core/src/entity/Collection.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L102) ___ @@ -354,7 +373,7 @@ ___ Returns: undefined \\\| T[] -Defined in: [packages/core/src/entity/Collection.ts:226](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L226) +Defined in: [packages/core/src/entity/Collection.ts:249](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L249) ___ @@ -367,14 +386,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: void Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L116) +Defined in: [packages/core/src/entity/Collection.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L143) ___ @@ -385,14 +404,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| number \| Returns: void Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:197](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L197) +Defined in: [packages/core/src/entity/ArrayCollection.ts:202](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L202) ___ @@ -403,26 +422,26 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| [InitOptions](../interfaces/core.initoptions.md)<T\\> \| Returns: Promise<[Collection](core.collection.md)<T, O\\>\\> -Defined in: [packages/core/src/entity/Collection.ts:164](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L164) +Defined in: [packages/core/src/entity/Collection.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L191) -▸ init(`populate?`: string[], `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Collection](core.collection.md)<T, O\\>\\> +▸ init(`populate?`: string[], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Collection](core.collection.md)<T, O\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate?` \| string[] \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: Promise<[Collection](core.collection.md)<T, O\\>\\> -Defined in: [packages/core/src/entity/Collection.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L165) +Defined in: [packages/core/src/entity/Collection.ts:192](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L192) ___ @@ -432,7 +451,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/entity/Collection.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L156) +Defined in: [packages/core/src/entity/Collection.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L183) ___ @@ -443,20 +462,20 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `fully` \| boolean \| false \| Returns: boolean Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:126](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L126) +Defined in: [packages/core/src/entity/ArrayCollection.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L131) ___ ### loadCount -▸ loadCount(`refresh?`: boolean): Promise<number\\> +▸ loadCount(`refresh?`: boolean): Promise<number\\> Gets the count of collection items from database instead of counting loaded items. The value is cached, use `refresh = true` to force reload it. @@ -464,14 +483,14 @@ The value is cached, use `refresh = true` to force reload it. #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `refresh` \| boolean \| false \| -Returns: Promise<number\\> +Returns: Promise<number\\> Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L54) +Defined in: [packages/core/src/entity/Collection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L63) ___ @@ -483,7 +502,23 @@ Initializes the collection and returns the items Returns: Promise<T[]\\> -Defined in: [packages/core/src/entity/Collection.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L42) +Defined in: [packages/core/src/entity/Collection.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L51) + +___ + +### matching + +▸ matching(`options`: [MatchingOptions](../interfaces/core.matchingoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<T[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| [MatchingOptions](../interfaces/core.matchingoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| + +Returns: Promise<T[]\\> + +Defined in: [packages/core/src/entity/Collection.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L77) ___ @@ -494,13 +529,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `method` \| add \\\| remove \| `items` \| T[] \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:273](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L273) +Defined in: [packages/core/src/entity/Collection.ts:307](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L307) ___ @@ -511,12 +546,12 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `populated` \| boolean \| true \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:151](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L151) +Defined in: [packages/core/src/entity/Collection.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L178) ___ @@ -527,7 +562,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -535,7 +570,7 @@ Name \| Type \| Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:157](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L157) +Defined in: [packages/core/src/entity/ArrayCollection.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L162) ___ @@ -546,7 +581,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -554,7 +589,7 @@ Name \| Type \| Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L165) +Defined in: [packages/core/src/entity/ArrayCollection.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L170) ___ @@ -565,7 +600,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -573,7 +608,7 @@ Name \| Type \| Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L173) +Defined in: [packages/core/src/entity/ArrayCollection.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L178) ___ @@ -584,14 +619,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L122) +Defined in: [packages/core/src/entity/Collection.ts:149](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L149) ___ @@ -603,7 +638,7 @@ ___ Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L113) +Defined in: [packages/core/src/entity/ArrayCollection.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L118) ___ @@ -616,13 +651,13 @@ re-orders items after searching with `$in` operator #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| `order` \| T[] \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:292](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L292) +Defined in: [packages/core/src/entity/Collection.ts:326](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L326) ___ @@ -633,14 +668,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: void Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:98](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L98) +Defined in: [packages/core/src/entity/Collection.ts:125](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L125) ___ @@ -651,12 +686,12 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `dirty` \| boolean \| true \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L160) +Defined in: [packages/core/src/entity/Collection.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L187) ___ @@ -666,7 +701,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/entity/Collection.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L147) +Defined in: [packages/core/src/entity/Collection.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L174) ___ @@ -677,7 +712,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `collection` \| [ArrayCollection](core.arraycollection.md)<O, T\\> \| `method` \| add \\\| remove \| @@ -685,7 +720,7 @@ Name \| Type \| Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L184) +Defined in: [packages/core/src/entity/ArrayCollection.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L189) ___ @@ -697,31 +732,31 @@ ___ Returns: void -Defined in: [packages/core/src/entity/Collection.ts:218](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L218) +Defined in: [packages/core/src/entity/Collection.ts:241](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L241) ___ ### toArray -▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] Inherited from: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L38) +Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L38) ___ ### toJSON -▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] Overrides: [ArrayCollection](core.arraycollection.md) -Defined in: [packages/core/src/entity/Collection.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L83) +Defined in: [packages/core/src/entity/Collection.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L110) ___ @@ -732,12 +767,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \\\| [Primary](../modules/core.md#primary)<T\\> \\\| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:310](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L310) +Defined in: [packages/core/src/entity/Collection.ts:344](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L344) ___ @@ -748,12 +783,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: void -Defined in: [packages/core/src/entity/Collection.ts:316](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L316) +Defined in: [packages/core/src/entity/Collection.ts:350](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L350) ___ @@ -766,14 +801,14 @@ Creates new Collection instance, assigns it to the owning entity and sets the it #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `O` \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `owner` \| O \| `prop` \| keyof O \| `items` \| undefined \\\| T[] \| @@ -781,4 +816,4 @@ Name \| Type \| Returns: [Collection](core.collection.md)<T, O\\> -Defined in: [packages/core/src/entity/Collection.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L28) +Defined in: [packages/core/src/entity/Collection.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L37) diff --git a/core.commitordercalculator.md b/core.commitordercalculator.md index 5e56aa8..cfe61af 100644 --- a/core.commitordercalculator.md +++ b/core.commitordercalculator.md @@ -2,6 +2,7 @@ id: "core.commitordercalculator" title: "Class: CommitOrderCalculator" sidebar_label: "CommitOrderCalculator" +custom_edit_url: null hide_title: true --- @@ -17,10 +18,6 @@ between the nodes (E), resulting in a computational complexity of O(V + E). Based on https://github.com/doctrine/orm/blob/master/lib/Doctrine/ORM/Internal/CommitOrderCalculator.php -## Hierarchy - -* CommitOrderCalculator - ## Constructors ### constructor @@ -37,7 +34,7 @@ Based on https://github.com/doctrine/orm/blob/master/lib/Doctrine/ORM/Internal/C Matrix of nodes, keys are provided hashes and values are the node definition objects. -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L34) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L34) ___ @@ -47,7 +44,7 @@ ___ Volatile variable holding calculated nodes during sorting process. -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L37) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L37) ## Methods @@ -60,14 +57,14 @@ Adds a new dependency (edge) to the graph using their hashes. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `from` \| string \| `to` \| string \| `weight` \| number \| Returns: void -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L56) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L56) ___ @@ -80,29 +77,29 @@ Adds a new node to the graph, assigning its hash. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `hash` \| string \| Returns: void -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L49) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L49) ___ ### discoverProperty -▸ discoverProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `entityName`: string): void +▸ discoverProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `entityName`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `entityName` \| string \| Returns: void -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L60) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L60) ___ @@ -115,12 +112,12 @@ Checks for node existence in graph. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `hash` \| string \| Returns: boolean -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L42) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L42) ___ @@ -135,7 +132,7 @@ The desired topological sorting is the reverse post order of these searches. Returns: string[] -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L81) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L81) ___ @@ -150,12 +147,12 @@ Visit a given node definition for reordering. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `node` \| [Node](../interfaces/core.node.md) \| Returns: void -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L102) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L102) ___ @@ -168,11 +165,11 @@ Visits all target's dependencies if in cycle with given node #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `node` \| [Node](../interfaces/core.node.md) \| `target` \| [Node](../interfaces/core.node.md) \| `edge` \| [Edge](../interfaces/core.edge.md) \| Returns: void -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L124) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L124) diff --git a/core.connection.md b/core.connection.md index c6f40d4..b4b9901 100644 --- a/core.connection.md +++ b/core.connection.md @@ -2,6 +2,7 @@ id: "core.connection" title: "Class: Connection" sidebar_label: "Connection" +custom_edit_url: null hide_title: true --- @@ -24,14 +25,14 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| - \| `options?` \| [ConnectionOptions](../interfaces/core.connectionoptions.md) \| - \| `type` \| read \\\| write \| 'write' \| Returns: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L14) +Defined in: [packages/core/src/connections/Connection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L14) ## Properties @@ -39,7 +40,7 @@ Defined in: [packages/core/src/connections/Connection.ts:14](https://github.com/ • `Protected` `Abstract` client: any -Defined in: [packages/core/src/connections/Connection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L14) +Defined in: [packages/core/src/connections/Connection.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L14) ___ @@ -53,13 +54,13 @@ ___ • `Protected` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/connections/Connection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L12) +Defined in: [packages/core/src/connections/Connection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L12) ___ ### options -• `Protected` `Optional` `Readonly` options: undefined \\\| [ConnectionOptions](../interfaces/core.connectionoptions.md) +• `Protected` `Optional` `Readonly` options: [ConnectionOptions](../interfaces/core.connectionoptions.md) ___ @@ -67,7 +68,7 @@ ___ • `Protected` platform: [Platform](core.platform.md) -Defined in: [packages/core/src/connections/Connection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L13) +Defined in: [packages/core/src/connections/Connection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L13) ___ @@ -79,84 +80,84 @@ ___ ### begin -▸ begin(`ctx?`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<unknown\\> +▸ begin(`ctx?`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<unknown\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx?` \| any \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<unknown\\> +Returns: Promise<unknown\\> -Defined in: [packages/core/src/connections/Connection.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L49) +Defined in: [packages/core/src/connections/Connection.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L49) ___ ### close -▸ `Abstract`close(`force?`: boolean): Promise<void\\> +▸ `Abstract`close(`force?`: boolean): Promise<void\\> Closes the database connection (aka disconnect) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `force?` \| boolean \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/connections/Connection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L38) +Defined in: [packages/core/src/connections/Connection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L38) ___ ### commit -▸ commit(`ctx`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> +▸ commit(`ctx`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx` \| any \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/connections/Connection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L53) +Defined in: [packages/core/src/connections/Connection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L53) ___ ### connect -▸ `Abstract`connect(): Promise<void\\> +▸ `Abstract`connect(): Promise<void\\> Establishes connection to database -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/connections/Connection.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L28) +Defined in: [packages/core/src/connections/Connection.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L28) ___ ### execute -▸ `Abstract`execute(`query`: string, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<any\\> +▸ `Abstract`execute(`query`: string, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `params?` \| any[] \| `method?` \| all \\\| get \\\| run \| `ctx?` \| any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Defined in: [packages/core/src/connections/Connection.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L61) +Defined in: [packages/core/src/connections/Connection.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L61) ___ @@ -167,19 +168,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `cb` \| () => Promise<T\\> \| Returns: Promise<T\\> -Defined in: [packages/core/src/connections/Connection.ts:90](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L90) +Defined in: [packages/core/src/connections/Connection.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L90) ___ @@ -189,7 +190,7 @@ ___ Returns: string -Defined in: [packages/core/src/connections/Connection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L75) +Defined in: [packages/core/src/connections/Connection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L75) ___ @@ -199,7 +200,7 @@ ___ Returns: [ConnectionConfig](../interfaces/core.connectionconfig.md) -Defined in: [packages/core/src/connections/Connection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L63) +Defined in: [packages/core/src/connections/Connection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L63) ___ @@ -211,19 +212,19 @@ Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for Returns: string -Defined in: [packages/core/src/connections/Connection.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L43) +Defined in: [packages/core/src/connections/Connection.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L43) ___ ### isConnected -▸ `Abstract`isConnected(): Promise<boolean\\> +▸ `Abstract`isConnected(): Promise<boolean\\> Are we connected to the database -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: [packages/core/src/connections/Connection.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L33) +Defined in: [packages/core/src/connections/Connection.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L33) ___ @@ -234,30 +235,30 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `took?` \| number \| Returns: void -Defined in: [packages/core/src/connections/Connection.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L104) +Defined in: [packages/core/src/connections/Connection.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L104) ___ ### rollback -▸ rollback(`ctx`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> +▸ rollback(`ctx`: any, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx` \| any \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/connections/Connection.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L57) +Defined in: [packages/core/src/connections/Connection.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L57) ___ @@ -268,12 +269,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/connections/Connection.ts:82](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L82) +Defined in: [packages/core/src/connections/Connection.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L82) ___ @@ -284,12 +285,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `platform` \| [Platform](core.platform.md) \| Returns: void -Defined in: [packages/core/src/connections/Connection.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L86) +Defined in: [packages/core/src/connections/Connection.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L86) ___ @@ -300,17 +301,17 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cb` \| (`trx`: any) => Promise<T\\> \| `ctx?` \| any \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| Returns: Promise<T\\> -Defined in: [packages/core/src/connections/Connection.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L45) +Defined in: [packages/core/src/connections/Connection.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L45) diff --git a/core.connectionexception.md b/core.connectionexception.md index e99d025..27a6899 100644 --- a/core.connectionexception.md +++ b/core.connectionexception.md @@ -2,6 +2,7 @@ id: "core.connectionexception" title: "Class: ConnectionException" sidebar_label: "ConnectionException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Base class for all connection related errors detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [ConnectionException](core.connectionexception.md) Inherited from: [DriverException](core.driverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [DriverException](core.driverexception.md).[code](core.driverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [DriverException](core.driverexception.md).[errmsg](core.driverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [DriverException](core.driverexception.md).[errno](core.driverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [DriverException](core.driverexception.md).[prepareStackTrace](core.driverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [DriverException](core.driverexception.md).[sqlMessage](core.driverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [DriverException](core.driverexception.md).[sqlState](core.driverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [DriverException](core.driverexception.md).[stack](core.driverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.constraintviolationexception.md b/core.constraintviolationexception.md index 65fe5a1..a70c6a0 100644 --- a/core.constraintviolationexception.md +++ b/core.constraintviolationexception.md @@ -2,6 +2,7 @@ id: "core.constraintviolationexception" title: "Class: ConstraintViolationException" sidebar_label: "ConstraintViolationException" +custom_edit_url: null hide_title: true --- @@ -32,44 +33,44 @@ Base class for all constraint violation related errors detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [ConstraintViolationException](core.constraintviolationexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -95,11 +96,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -109,27 +125,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -156,7 +172,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.databasedriver.md b/core.databasedriver.md index 85c803f..58701ef 100644 --- a/core.databasedriver.md +++ b/core.databasedriver.md @@ -2,6 +2,7 @@ id: "core.databasedriver" title: "Class: DatabaseDriver<C>" sidebar_label: "DatabaseDriver" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `C` \| [Connection](core.connection.md) \| ## Hierarchy @@ -34,29 +35,29 @@ Name \| Type \| #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `C` \| [Connection](core.connection.md)<C\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `dependencies` \| string[] \| Returns: [DatabaseDriver](core.databasedriver.md)<C\\> -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L22) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L22) ## Properties -### \\_\\_@EntityManagerType@43871 +### [EntityManagerType] -• \\_\\_@EntityManagerType@43871: [EntityManager](core.entitymanager.md)<[DatabaseDriver](core.databasedriver.md)<C\\>\\> +• [EntityManagerType]: [EntityManager](core.entitymanager.md)<[DatabaseDriver](core.databasedriver.md)<C\\>\\> -Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md).[__@EntityManagerType@43871](../interfaces/core.idatabasedriver.md#__@entitymanagertype@43871) +Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md).[[EntityManagerType]](../interfaces/core.idatabasedriver.md#[entitymanagertype]) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L15) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L15) ___ @@ -64,7 +65,7 @@ ___ • `Protected` comparator: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L21) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L21) ___ @@ -78,7 +79,7 @@ ___ • `Protected` `Readonly` connection: C -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L17) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L17) ___ @@ -92,7 +93,7 @@ ___ • `Protected` `Readonly` logger: [Logger](core.logger.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L20) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L20) ___ @@ -100,7 +101,7 @@ ___ • `Protected` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L22) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L22) ___ @@ -108,7 +109,7 @@ ___ • `Protected` `Readonly` platform: [Platform](core.platform.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L19) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L19) ___ @@ -116,44 +117,44 @@ ___ • `Protected` `Readonly` replicas: C[] -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L18) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L18) ## Methods ### aggregate -▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> +▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `pipeline` \| any[] \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L49) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L49) ___ ### close -▸ close(`force?`: boolean): Promise<void\\> +▸ close(`force?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `force?` \| boolean \| -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L93) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L93) ___ @@ -165,7 +166,7 @@ ___ Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L71) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L71) ___ @@ -178,41 +179,41 @@ Converts native db errors to standardized driver exceptions #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `exception` \| Error \| Returns: [DriverException](core.driverexception.md) Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:244](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L244) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:254](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L254) ___ ### count -▸ `Abstract`count<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>, `ctx?`: any): Promise<number\\> +▸ `Abstract`count<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>, `ctx?`: any): Promise<number\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| `ctx?` \| any \| -Returns: Promise<number\\> +Returns: Promise<number\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L43) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L43) ___ @@ -223,20 +224,20 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `useContext?` \| boolean \| Returns: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)] Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L45) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L45) ___ @@ -247,78 +248,82 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cb` \| (`c`: [ConnectionOptions](../interfaces/core.connectionoptions.md)) => C \| Returns: C[] -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L205) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:215](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L215) ___ ### ensureIndexes -▸ ensureIndexes(): Promise<void\\> +▸ ensureIndexes(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:117](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L117) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L127) ___ ### find -▸ `Abstract`find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: any): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> +▸ `Abstract`find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: any): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> + +Finds selection of entities #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `ctx?` \| any \| Returns: Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L27) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L27) ___ ### findOne -▸ `Abstract`findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: any): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> +▸ `Abstract`findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: any): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> + +Finds single entity (table row, document) #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `ctx?` \| any \| Returns: Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L29) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L29) ___ @@ -329,14 +334,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `type` \| read \\\| write \| 'write' \| Returns: C Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L83) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L83) ___ @@ -344,44 +349,47 @@ ___ ▸ getDependencies(): string[] +Returns name of the underlying database dependencies (e.g. `mongodb` or `mysql2`) +for SQL drivers it also returns `knex` in the array as connectors are not used directly there + Returns: string[] Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L113) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L123) ___ ### getPivotInverseProperty -▸ `Protected`getPivotInverseProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +▸ `Protected`getPivotInverseProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:190](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L190) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:200](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L200) ___ ### getPivotOrderBy -▸ `Protected`getPivotOrderBy(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): [QueryOrderMap](../interfaces/core.queryordermap.md) +▸ `Protected`getPivotOrderBy(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): [QueryOrderMap](../interfaces/core.queryordermap.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: [QueryOrderMap](../interfaces/core.queryordermap.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:169](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L169) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:179](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L179) ___ @@ -393,7 +401,7 @@ ___ Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:98](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L98) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L108) ___ @@ -404,12 +412,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string[] -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:185](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L185) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:195](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L195) ___ @@ -420,72 +428,78 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| T \| `where?` \| boolean \| Returns: void -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:121](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L121) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L131) ___ ### loadFromPivotTable -▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> +▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> + +When driver uses pivot tables for M:N, this method will load identifiers for given collections from them #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `owners` \| [Primary](../modules/core.md#primary)<O\\>[][] \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `ctx?` \| any \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L53) +Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) + +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L53) ___ ### lockPessimistic -▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> +▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `mode` \| [LockMode](../enums/core.lockmode.md) \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:218](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L218) +Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) + +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:228](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L228) ___ @@ -496,22 +510,22 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| -`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| ... \| +Name \| Type \| +:------ \| :------ \| +`result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: null \\\| [EntityData](../modules/core.md#entitydata)<T\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L63) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L63) ___ @@ -522,13 +536,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `ctx?` \| any \| @@ -537,7 +551,7 @@ Name \| Type \| Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L41) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L41) ___ @@ -548,13 +562,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `ctx?` \| any \| @@ -564,7 +578,7 @@ Name \| Type \| Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L31) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L31) ___ @@ -575,13 +589,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| `ctx?` \| any \| @@ -592,7 +606,7 @@ Name \| Type \| Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L33) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L33) ___ @@ -603,13 +617,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -620,7 +634,7 @@ Name \| Type \| Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L35) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L35) ___ @@ -631,13 +645,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\>[] \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| @@ -649,7 +663,7 @@ Name \| Type \| Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L37) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L37) ___ @@ -661,7 +675,7 @@ ___ Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L78) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L78) ___ @@ -672,18 +686,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `promise` \| Promise<T\\> \| Returns: Promise<T\\> -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L252) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:262](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L262) ___ @@ -694,14 +708,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L102) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L112) ___ @@ -714,43 +728,43 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| - \| `includeFormulas` \| boolean \| true \| Returns: boolean -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:225](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L225) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L235) ___ ### syncCollection -▸ syncCollection<T, O\\>(`coll`: [Collection](core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> +▸ syncCollection<T, O\\>(`coll`: [Collection](core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `coll` \| [Collection](core.collection.md)<T, O\\> \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [IDatabaseDriver](../interfaces/core.idatabasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L57) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L57) diff --git a/core.databaseobjectexistsexception.md b/core.databaseobjectexistsexception.md index fe7780e..cc6ca52 100644 --- a/core.databaseobjectexistsexception.md +++ b/core.databaseobjectexistsexception.md @@ -2,6 +2,7 @@ id: "core.databaseobjectexistsexception" title: "Class: DatabaseObjectExistsException" sidebar_label: "DatabaseObjectExistsException" +custom_edit_url: null hide_title: true --- @@ -32,44 +33,44 @@ functions, stored procedures etc. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -95,11 +96,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -109,27 +125,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -156,7 +172,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.databaseobjectnotfoundexception.md b/core.databaseobjectnotfoundexception.md index 153a846..ed5c7c3 100644 --- a/core.databaseobjectnotfoundexception.md +++ b/core.databaseobjectnotfoundexception.md @@ -2,6 +2,7 @@ id: "core.databaseobjectnotfoundexception" title: "Class: DatabaseObjectNotFoundException" sidebar_label: "DatabaseObjectNotFoundException" +custom_edit_url: null hide_title: true --- @@ -32,44 +33,44 @@ functions, stored procedures etc. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -95,11 +96,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -109,27 +125,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -156,7 +172,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.datetype.md b/core.datetype.md index 2675669..be71ba9 100644 --- a/core.datetype.md +++ b/core.datetype.md @@ -2,6 +2,7 @@ id: "core.datetype" title: "Class: DateType" sidebar_label: "DateType" +custom_edit_url: null hide_title: true --- @@ -11,7 +12,7 @@ hide_title: true ## Hierarchy -* [Type](core.type.md)<Date, string\\> +* [Type](core.type.md)<Date, string\\> ↳ DateType @@ -35,7 +36,7 @@ Inherited from: [Type](core.type.md) Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/DateType.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/DateType.ts#L34) +Defined in: [packages/core/src/types/DateType.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/DateType.ts#L34) ___ @@ -46,7 +47,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| undefined \\\| null \\\| string \\\| Date \| `platform` \| [Platform](core.platform.md) \| @@ -54,7 +55,28 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/DateType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/DateType.ts#L8) +Defined in: [packages/core/src/types/DateType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/DateType.ts#L8) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -65,7 +87,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| undefined \\\| null \\\| string \\\| Date \| `platform` \| [Platform](core.platform.md) \| @@ -73,26 +95,47 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/DateType.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/DateType.ts#L20) +Defined in: [packages/core/src/types/DateType.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/DateType.ts#L20) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/DateType.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/DateType.ts#L38) +Defined in: [packages/core/src/types/DateType.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/DateType.ts#L38) ___ @@ -103,7 +146,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| Date \| `platform` \| [Platform](core.platform.md) \| @@ -111,7 +154,7 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/DateType.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/DateType.ts#L42) +Defined in: [packages/core/src/types/DateType.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/DateType.ts#L42) ___ @@ -122,18 +165,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.deadlockexception.md b/core.deadlockexception.md index f55bba5..8b3f969 100644 --- a/core.deadlockexception.md +++ b/core.deadlockexception.md @@ -2,6 +2,7 @@ id: "core.deadlockexception" title: "Class: DeadlockException" sidebar_label: "DeadlockException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a deadlock error of a transaction detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [DeadlockException](core.deadlockexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.driverexception.md b/core.driverexception.md index 784b2e7..ba4da78 100644 --- a/core.driverexception.md +++ b/core.driverexception.md @@ -2,6 +2,7 @@ id: "core.driverexception" title: "Class: DriverException" sidebar_label: "DriverException" +custom_edit_url: null hide_title: true --- @@ -30,36 +31,38 @@ Base class for all errors detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [DriverException](core.driverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Overrides: void + +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -67,6 +70,8 @@ ___ • message: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:974 ___ @@ -75,17 +80,34 @@ ___ • name: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973 ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Defined in: node_modules/@types/node/globals.d.ts:11 @@ -93,23 +115,25 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string + +Inherited from: void Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975 @@ -132,7 +156,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.entityassigner.md b/core.entityassigner.md index b1db68f..f08ced8 100644 --- a/core.entityassigner.md +++ b/core.entityassigner.md @@ -2,6 +2,7 @@ id: "core.entityassigner" title: "Class: EntityAssigner" sidebar_label: "EntityAssigner" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityAssigner -## Hierarchy - -* EntityAssigner - ## Constructors ### constructor @@ -30,126 +27,126 @@ hide_title: true #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `options?` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/entity/EntityAssigner.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L14) +Defined in: [packages/core/src/entity/EntityAssigner.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L15) ▸ `Static`assign<T\\>(`entity`: T, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `onlyProperties?`: boolean): T #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `onlyProperties?` \| boolean \| Returns: T -Defined in: [packages/core/src/entity/EntityAssigner.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L15) +Defined in: [packages/core/src/entity/EntityAssigner.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L16) ___ ### assignCollection -▸ `Private` `Static`assignCollection<T, U\\>(`entity`: T, `collection`: [Collection](core.collection.md)<U, unknown\\>, `value`: any[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void +▸ `Private` `Static`assignCollection<T, U\\>(`entity`: T, `collection`: [Collection](core.collection.md)<U, unknown\\>, `value`: any[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`U` \| [AnyEntity](../modules/core.md#anyentity)<U\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +`U` \| [AnyEntity](../modules/core.md#anyentity)<U\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| -`collection` \| [Collection](core.collection.md)<U, unknown\\> \| +`collection` \| [Collection](core.collection.md)<U, unknown\\> \| `value` \| any[] \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: void -Defined in: [packages/core/src/entity/EntityAssigner.ts:111](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L111) +Defined in: [packages/core/src/entity/EntityAssigner.ts:126](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L126) ___ ### assignEmbeddable -▸ `Private` `Static`assignEmbeddable<T\\>(`entity`: T, `value`: any, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void +▸ `Private` `Static`assignEmbeddable<T\\>(`entity`: T, `value`: any, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `value` \| any \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: void -Defined in: [packages/core/src/entity/EntityAssigner.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L123) +Defined in: [packages/core/src/entity/EntityAssigner.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L138) ___ ### assignReference -▸ `Private` `Static`assignReference<T\\>(`entity`: T, `value`: any, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void +▸ `Private` `Static`assignReference<T\\>(`entity`: T, `value`: any, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `options`: [AssignOptions](../interfaces/core.assignoptions.md)): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `value` \| any \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: void -Defined in: [packages/core/src/entity/EntityAssigner.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L94) +Defined in: [packages/core/src/entity/EntityAssigner.ts:109](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L109) ___ ### autoWireOneToOne -▸ `Static`autoWireOneToOne<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `entity`: T): void +▸ `Static`autoWireOneToOne<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `entity`: T): void auto-wire 1:1 inverse side with owner as in no-sql drivers it can't be joined also makes sure the link is bidirectional when creating new entities from nested structures @@ -159,45 +156,45 @@ also makes sure the link is bidirectional when creating new entities from nested #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `entity` \| T \| Returns: void -Defined in: [packages/core/src/entity/EntityAssigner.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L68) +Defined in: [packages/core/src/entity/EntityAssigner.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L83) ___ ### createCollectionItem -▸ `Private` `Static`createCollectionItem<T\\>(`item`: any, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `invalid`: any[], `options`: [AssignOptions](../interfaces/core.assignoptions.md)): T +▸ `Private` `Static`createCollectionItem<T\\>(`item`: any, `em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `invalid`: any[], `options`: [AssignOptions](../interfaces/core.assignoptions.md)): T #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| any \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `invalid` \| any[] \| `options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/entity/EntityAssigner.ts:139](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L139) +Defined in: [packages/core/src/entity/EntityAssigner.ts:159](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L159) ___ @@ -208,9 +205,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em?` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: boolean -Defined in: [packages/core/src/entity/EntityAssigner.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L86) +Defined in: [packages/core/src/entity/EntityAssigner.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L101) diff --git a/core.entitycasenamingstrategy.md b/core.entitycasenamingstrategy.md index 794c168..4193a56 100644 --- a/core.entitycasenamingstrategy.md +++ b/core.entitycasenamingstrategy.md @@ -2,6 +2,7 @@ id: "core.entitycasenamingstrategy" title: "Class: EntityCaseNamingStrategy" sidebar_label: "EntityCaseNamingStrategy" +custom_edit_url: null hide_title: true --- @@ -36,14 +37,14 @@ Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `timestamp` \| string \| Returns: string Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) ___ @@ -54,14 +55,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L8) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L8) ___ @@ -72,7 +73,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `file` \| string \| - \| `separator` \| string \| '-' \| @@ -80,7 +81,7 @@ Name \| Type \| Default value \| Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) ___ @@ -91,14 +92,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L12) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L12) ___ @@ -109,7 +110,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `referencedColumnName?` \| string \| - \| `composite` \| boolean \| false \| @@ -118,7 +119,7 @@ Name \| Type \| Default value \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L16) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L16) ___ @@ -129,7 +130,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sourceEntity` \| string \| `targetEntity` \| string \| `propertyName` \| string \| @@ -138,7 +139,7 @@ Name \| Type \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L26) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L26) ___ @@ -149,14 +150,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L30) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L30) ___ @@ -168,4 +169,4 @@ ___ Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L34) +Defined in: [packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/EntityCaseNamingStrategy.ts#L34) diff --git a/core.entitycomparator.md b/core.entitycomparator.md index 8beaf25..e16e6dc 100644 --- a/core.entitycomparator.md +++ b/core.entitycomparator.md @@ -2,6 +2,7 @@ id: "core.entitycomparator" title: "Class: EntityComparator" sidebar_label: "EntityComparator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityComparator -## Hierarchy - -* EntityComparator - ## Constructors ### constructor @@ -22,53 +19,53 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| IMetadataStorage \| `platform` \| [Platform](core.platform.md) \| Returns: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/utils/EntityComparator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L19) +Defined in: [packages/core/src/utils/EntityComparator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L19) ## Properties ### comparators -• `Private` `Readonly` comparators: Map<string, Comparator<any\\>\\> +• `Private` `Readonly` comparators: Map<string, Comparator<any\\>\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L15) +Defined in: [packages/core/src/utils/EntityComparator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L15) ___ ### mappers -• `Private` `Readonly` mappers: Map<string, ResultMapper<any\\>\\> +• `Private` `Readonly` mappers: Map<string, ResultMapper<any\\>\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L16) +Defined in: [packages/core/src/utils/EntityComparator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L16) ___ ### pkGetters -• `Private` `Readonly` pkGetters: Map<string, PkGetter<any\\>\\> +• `Private` `Readonly` pkGetters: Map<string, PkGetter<any\\>\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L18) +Defined in: [packages/core/src/utils/EntityComparator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L18) ___ ### pkSerializers -• `Private` `Readonly` pkSerializers: Map<string, PkSerializer<any\\>\\> +• `Private` `Readonly` pkSerializers: Map<string, PkSerializer<any\\>\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L19) +Defined in: [packages/core/src/utils/EntityComparator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L19) ___ ### snapshotGenerators -• `Private` `Readonly` snapshotGenerators: Map<string, SnapshotGenerator<any\\>\\> +• `Private` `Readonly` snapshotGenerators: Map<string, SnapshotGenerator<any\\>\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L17) +Defined in: [packages/core/src/utils/EntityComparator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L17) ## Methods @@ -81,46 +78,77 @@ Computes difference between two entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [EntityData](../modules/core.md#entitydata)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `a` \| T \| `b` \| T \| Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L27) +Defined in: [packages/core/src/utils/EntityComparator.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L27) + +___ + +### getEmbeddedArrayPropertySnapshot + +▸ `Private`getEmbeddedArrayPropertySnapshot<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `context`: Map<string, any\\>, `level`: number, `path?`: string[], `dataKey?`: string, `object?`: boolean, `serialize?`: boolean): string + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| +`context` \| Map<string, any\\> \| +`level` \| number \| +`path` \| string[] \| +`dataKey?` \| string \| +`object?` \| boolean \| +`serialize?` \| boolean \| + +Returns: string + +Defined in: [packages/core/src/utils/EntityComparator.ts:225](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L225) ___ ### getEmbeddedPropertySnapshot -▸ `Private`getEmbeddedPropertySnapshot<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `context`: Map<string, any\\>, `level?`: number, `path?`: string[]): string +▸ `Private`getEmbeddedPropertySnapshot<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `context`: Map<string, any\\>, `level`: number, `path?`: string[], `dataKey?`: string, `object?`: undefined \\\| boolean): string #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| -`context` \| Map<string, any\\> \| - \| -`level` \| number \| 1 \| -`path` \| string[] \| ... \| +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| +`context` \| Map<string, any\\> \| +`level` \| number \| +`path` \| string[] \| +`dataKey?` \| string \| +`object` \| undefined \\\| boolean \| Returns: string -Defined in: [packages/core/src/utils/EntityComparator.ts:225](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L225) +Defined in: [packages/core/src/utils/EntityComparator.ts:259](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L259) ___ @@ -133,18 +161,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: Comparator<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:292](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L292) +Defined in: [packages/core/src/utils/EntityComparator.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L355) ___ @@ -155,13 +183,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| string \| `cond` \| string \| Returns: string -Defined in: [packages/core/src/utils/EntityComparator.ts:318](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L318) +Defined in: [packages/core/src/utils/EntityComparator.ts:381](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L381) ___ @@ -174,18 +202,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: any -Defined in: [packages/core/src/utils/EntityComparator.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L52) +Defined in: [packages/core/src/utils/EntityComparator.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L52) ___ @@ -198,18 +226,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: any -Defined in: [packages/core/src/utils/EntityComparator.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L94) +Defined in: [packages/core/src/utils/EntityComparator.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L94) ___ @@ -220,18 +248,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: string -Defined in: [packages/core/src/utils/EntityComparator.ts:327](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L327) +Defined in: [packages/core/src/utils/EntityComparator.ts:390](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L390) ___ @@ -242,42 +270,46 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: string -Defined in: [packages/core/src/utils/EntityComparator.ts:209](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L209) +Defined in: [packages/core/src/utils/EntityComparator.ts:209](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L209) ___ ### getPropertySnapshot -▸ `Private`getPropertySnapshot<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `context`: Map<string, any\\>): string +▸ `Private`getPropertySnapshot<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `context`: Map<string, any\\>, `dataKey?`: string, `path?`: string[], `level?`: number, `object?`: boolean): string #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| -`context` \| Map<string, any\\> \| +Name \| Type \| Default value \| +:------ \| :------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| +`context` \| Map<string, any\\> \| - \| +`dataKey?` \| string \| - \| +`path?` \| string[] \| - \| +`level` \| number \| 1 \| +`object?` \| boolean \| - \| Returns: string -Defined in: [packages/core/src/utils/EntityComparator.ts:238](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L238) +Defined in: [packages/core/src/utils/EntityComparator.ts:301](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L301) ___ @@ -290,18 +322,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: ResultMapper<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:172](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L172) +Defined in: [packages/core/src/utils/EntityComparator.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L172) ___ @@ -314,18 +346,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: SnapshotGenerator<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:135](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L135) +Defined in: [packages/core/src/utils/EntityComparator.ts:135](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L135) ___ @@ -338,19 +370,19 @@ Maps database columns to properties. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: null \\\| [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L44) +Defined in: [packages/core/src/utils/EntityComparator.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L44) ___ @@ -364,40 +396,60 @@ References will be mapped to primary keys, collections to arrays of primary keys #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/utils/EntityComparator.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L36) +Defined in: [packages/core/src/utils/EntityComparator.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L36) + +___ + +### shouldSerialize + +▸ `Private`shouldSerialize(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `dataKey`: string): boolean + +we need to serialize only object embeddables, and only the top level ones, so root object embeddable +properties and first child nested object embeddables with inlined parent + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`dataKey` \| string \| + +Returns: boolean + +Defined in: [packages/core/src/utils/EntityComparator.ts:251](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L251) ___ ### isComparable -▸ `Static`isComparable<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `root`: [EntityMetadata](core.entitymetadata.md)<any\\>): boolean +▸ `Static`isComparable<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `root`: [EntityMetadata](core.entitymetadata.md)<any\\>): boolean perf: used to generate list of comparable properties during discovery, so we speed up the runtime comparison #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| -`root` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`root` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: boolean -Defined in: [packages/core/src/utils/EntityComparator.ts:371](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/EntityComparator.ts#L371) +Defined in: [packages/core/src/utils/EntityComparator.ts:434](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/EntityComparator.ts#L434) diff --git a/core.entityfactory.md b/core.entityfactory.md index e723a6c..f6f79e2 100644 --- a/core.entityfactory.md +++ b/core.entityfactory.md @@ -2,6 +2,7 @@ id: "core.entityfactory" title: "Class: EntityFactory" sidebar_label: "EntityFactory" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityFactory -## Hierarchy - -* EntityFactory - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `unitOfWork` \| [UnitOfWork](core.unitofwork.md) \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [EntityFactory](core.entityfactory.md) -Defined in: [packages/core/src/entity/EntityFactory.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L22) +Defined in: [packages/core/src/entity/EntityFactory.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L22) ## Properties @@ -36,7 +33,7 @@ Defined in: [packages/core/src/entity/EntityFactory.ts:22](https://github.com/mi • `Private` `Readonly` config: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/entity/EntityFactory.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L19) +Defined in: [packages/core/src/entity/EntityFactory.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L19) ___ @@ -44,7 +41,7 @@ ___ • `Private` `Readonly` driver: [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> -Defined in: [packages/core/src/entity/EntityFactory.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L17) +Defined in: [packages/core/src/entity/EntityFactory.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L17) ___ @@ -52,7 +49,7 @@ ___ • `Private` `Readonly` eventManager: [EventManager](core.eventmanager.md) -Defined in: [packages/core/src/entity/EntityFactory.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L22) +Defined in: [packages/core/src/entity/EntityFactory.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L22) ___ @@ -60,7 +57,7 @@ ___ • `Private` `Readonly` hydrator: IHydrator -Defined in: [packages/core/src/entity/EntityFactory.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L21) +Defined in: [packages/core/src/entity/EntityFactory.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L21) ___ @@ -68,7 +65,7 @@ ___ • `Private` `Readonly` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/entity/EntityFactory.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L20) +Defined in: [packages/core/src/entity/EntityFactory.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L20) ___ @@ -76,7 +73,7 @@ ___ • `Private` `Readonly` platform: [Platform](core.platform.md) -Defined in: [packages/core/src/entity/EntityFactory.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L18) +Defined in: [packages/core/src/entity/EntityFactory.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L18) ## Methods @@ -87,21 +84,21 @@ Defined in: [packages/core/src/entity/EntityFactory.ts:18](https://github.com/mi #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [FactoryOptions](../interfaces/core.factoryoptions.md) \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [FactoryOptions](../interfaces/core.factoryoptions.md) \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> -Defined in: [packages/core/src/entity/EntityFactory.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L27) +Defined in: [packages/core/src/entity/EntityFactory.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L27) ___ @@ -112,44 +109,44 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `options` \| [FactoryOptions](../interfaces/core.factoryoptions.md) \| Returns: T -Defined in: [packages/core/src/entity/EntityFactory.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L88) +Defined in: [packages/core/src/entity/EntityFactory.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L88) ___ ### createReference -▸ createReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\>, `options?`: Pick<[FactoryOptions](../interfaces/core.factoryoptions.md), convertCustomTypes \\\| merge\\>): T +▸ createReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\>, `options?`: Pick<[FactoryOptions](../interfaces/core.factoryoptions.md), convertCustomTypes \\\| merge\\>): T #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> \| - \| -`options` \| Pick<[FactoryOptions](../interfaces/core.factoryoptions.md), convertCustomTypes \\\| merge\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> \| +`options` \| Pick<[FactoryOptions](../interfaces/core.factoryoptions.md), convertCustomTypes \\\| merge\\> \| Returns: T -Defined in: [packages/core/src/entity/EntityFactory.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L64) +Defined in: [packages/core/src/entity/EntityFactory.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L64) ___ @@ -162,20 +159,20 @@ denormalize PK to value required by driver (e.g. ObjectId) #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `primaryKey` \| string \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityFactory.ts:153](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L153) +Defined in: [packages/core/src/entity/EntityFactory.ts:153](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L153) ___ @@ -188,19 +185,19 @@ returns parameters for entity constructor, creating references from plain ids #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T[keyof T][] -Defined in: [packages/core/src/entity/EntityFactory.ts:171](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L171) +Defined in: [packages/core/src/entity/EntityFactory.ts:171](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L171) ___ @@ -211,20 +208,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `convertCustomTypes?` \| boolean \| Returns: undefined \\\| T -Defined in: [packages/core/src/entity/EntityFactory.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L118) +Defined in: [packages/core/src/entity/EntityFactory.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L118) ___ @@ -235,13 +232,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -249,7 +246,7 @@ Name \| Type \| Returns: void -Defined in: [packages/core/src/entity/EntityFactory.ts:110](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L110) +Defined in: [packages/core/src/entity/EntityFactory.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L110) ___ @@ -260,16 +257,16 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/entity/EntityFactory.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L132) +Defined in: [packages/core/src/entity/EntityFactory.ts:132](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L132) diff --git a/core.entityhelper.md b/core.entityhelper.md index d8a1581..82844d0 100644 --- a/core.entityhelper.md +++ b/core.entityhelper.md @@ -2,6 +2,7 @@ id: "core.entityhelper" title: "Class: EntityHelper" sidebar_label: "EntityHelper" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityHelper -## Hierarchy - -* EntityHelper - ## Constructors ### constructor @@ -30,19 +27,19 @@ hide_title: true #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L16) +Defined in: [packages/core/src/entity/EntityHelper.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L16) ___ @@ -53,20 +50,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `prototype` \| T \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L55) +Defined in: [packages/core/src/entity/EntityHelper.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L55) ___ @@ -79,19 +76,19 @@ defines magic id property getter/setter if PK property is `_id` and there is no #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `platform` \| [Platform](core.platform.md) \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L44) +Defined in: [packages/core/src/entity/EntityHelper.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L44) ___ @@ -107,42 +104,42 @@ than on its prototype. Thanks to this we still have those properties enumerable #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L79) +Defined in: [packages/core/src/entity/EntityHelper.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L79) ___ ### defineReferenceProperty -▸ `Private` `Static`defineReferenceProperty<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `ref`: T, `val`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ `Private` `Static`defineReferenceProperty<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `ref`: T, `val`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `ref` \| T \| -`val` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`val` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L113) +Defined in: [packages/core/src/entity/EntityHelper.ts:113](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L113) ___ @@ -153,21 +150,21 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `owner` \| O \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<O\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:129](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L129) +Defined in: [packages/core/src/entity/EntityHelper.ts:129](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L129) ___ @@ -178,18 +175,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `owner` \| O \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<O\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityHelper.ts:141](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityHelper.ts#L141) +Defined in: [packages/core/src/entity/EntityHelper.ts:141](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityHelper.ts#L141) diff --git a/core.entityidentifier.md b/core.entityidentifier.md index ccc8ad0..5d0a9bf 100644 --- a/core.entityidentifier.md +++ b/core.entityidentifier.md @@ -2,6 +2,7 @@ id: "core.entityidentifier" title: "Class: EntityIdentifier" sidebar_label: "EntityIdentifier" +custom_edit_url: null hide_title: true --- @@ -9,25 +10,21 @@ hide_title: true [core](../modules/core.md).EntityIdentifier -## Hierarchy - -* EntityIdentifier - ## Constructors ### constructor -\\+ new EntityIdentifier(`value?`: string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string }): [EntityIdentifier](core.entityidentifier.md) +\\+ new EntityIdentifier(`value?`: IPrimaryKeyValue): [EntityIdentifier](core.entityidentifier.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`value?` \| string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \| +:------ \| :------ \| +`value?` \| IPrimaryKeyValue \| Returns: [EntityIdentifier](core.entityidentifier.md) -Defined in: [packages/core/src/entity/EntityIdentifier.ts:3](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityIdentifier.ts#L3) +Defined in: [packages/core/src/entity/EntityIdentifier.ts:3](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityIdentifier.ts#L3) ## Methods @@ -38,12 +35,12 @@ Defined in: [packages/core/src/entity/EntityIdentifier.ts:3](https://github.com/ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| IPrimaryKeyValue \| IPrimaryKeyValue \| Returns: T -Defined in: [packages/core/src/entity/EntityIdentifier.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityIdentifier.ts#L11) +Defined in: [packages/core/src/entity/EntityIdentifier.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityIdentifier.ts#L11) ___ @@ -54,9 +51,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| IPrimaryKeyValue \| Returns: void -Defined in: [packages/core/src/entity/EntityIdentifier.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityIdentifier.ts#L7) +Defined in: [packages/core/src/entity/EntityIdentifier.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityIdentifier.ts#L7) diff --git a/core.entityloader.md b/core.entityloader.md index e318c9c..5140d4b 100644 --- a/core.entityloader.md +++ b/core.entityloader.md @@ -2,6 +2,7 @@ id: "core.entityloader" title: "Class: EntityLoader" sidebar_label: "EntityLoader" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityLoader -## Hierarchy - -* EntityLoader - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [EntityLoader](core.entityloader.md) -Defined in: [packages/core/src/entity/EntityLoader.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L25) +Defined in: [packages/core/src/entity/EntityLoader.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L25) ## Properties @@ -35,7 +32,7 @@ Defined in: [packages/core/src/entity/EntityLoader.ts:25](https://github.com/mik • `Private` `Readonly` driver: [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L25) +Defined in: [packages/core/src/entity/EntityLoader.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L25) ___ @@ -43,56 +40,56 @@ ___ • `Private` `Readonly` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/entity/EntityLoader.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L24) +Defined in: [packages/core/src/entity/EntityLoader.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L24) ## Methods ### buildFields -▸ `Private`buildFields<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `options`: Required<Options<T\\>\\>): string[] +▸ `Private`buildFields<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `options`: Required<Options<T\\>\\>): string[] #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| -`options` \| Required<Options<T\\>\\> \| +`options` \| Required<Options<T\\>\\> \| Returns: string[] -Defined in: [packages/core/src/entity/EntityLoader.ts:305](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L305) +Defined in: [packages/core/src/entity/EntityLoader.ts:306](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L306) ___ ### expandNestedPopulate -▸ `Private`expandNestedPopulate<T\\>(`entityName`: string, `parts`: string[], `strategy?`: [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined)): [PopulateOptions](../modules/core.md#populateoptions)<T\\> +▸ `Private`expandNestedPopulate<T\\>(`entityName`: string, `parts`: string[], `strategy?`: [LoadStrategy](../enums/core.loadstrategy.md)): [PopulateOptions](../modules/core.md#populateoptions)<T\\> Expands `books.perex` like populate to use `children` array instead of the dot syntax #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `parts` \| string[] \| -`strategy?` \| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) \| +`strategy?` \| [LoadStrategy](../enums/core.loadstrategy.md) \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:117](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L117) +Defined in: [packages/core/src/entity/EntityLoader.ts:117](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L117) ___ @@ -103,20 +100,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `field` \| keyof T \| `refresh` \| boolean \| Returns: T[] -Defined in: [packages/core/src/entity/EntityLoader.ts:343](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L343) +Defined in: [packages/core/src/entity/EntityLoader.ts:344](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L344) ___ @@ -127,170 +124,170 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `field` \| keyof T \| `refresh` \| boolean \| Returns: T[keyof T][] -Defined in: [packages/core/src/entity/EntityLoader.ts:351](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L351) +Defined in: [packages/core/src/entity/EntityLoader.ts:352](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L352) ___ ### findChildren -▸ `Private`findChildren<T\\>(`entities`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +▸ `Private`findChildren<T\\>(`entities`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\> \| -`options` \| Required<Options<T\\>\\> \| +`options` \| Required<Options<T\\>\\> \| -Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L211) +Defined in: [packages/core/src/entity/EntityLoader.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L211) ___ ### findChildrenFromPivotTable -▸ `Private`findChildrenFromPivotTable<T\\>(`filtered`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `options`: Required<Options<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +▸ `Private`findChildrenFromPivotTable<T\\>(`filtered`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `options`: Required<Options<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `filtered` \| T[] \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| -`options` \| Required<Options<T\\>\\> \| +`options` \| Required<Options<T\\>\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `populate?` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\> \| -Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:276](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L276) +Defined in: [packages/core/src/entity/EntityLoader.ts:276](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L276) ___ ### getChildReferences -▸ `Private`getChildReferences<T\\>(`entities`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `refresh`: boolean): [AnyEntity](../modules/core.md#anyentity)<any\\>[] +▸ `Private`getChildReferences<T\\>(`entities`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `refresh`: boolean): [AnyEntity](../modules/core.md#anyentity)<any\\>[] #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `refresh` \| boolean \| -Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] +Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] -Defined in: [packages/core/src/entity/EntityLoader.ts:326](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L326) +Defined in: [packages/core/src/entity/EntityLoader.ts:327](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L327) ___ ### initializeCollections -▸ `Private`initializeCollections<T\\>(`filtered`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T, `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ `Private`initializeCollections<T\\>(`filtered`: T[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T, `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `filtered` \| T[] \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `field` \| keyof T \| -`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void -Defined in: [packages/core/src/entity/EntityLoader.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L180) +Defined in: [packages/core/src/entity/EntityLoader.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L180) ___ ### initializeManyToMany -▸ `Private`initializeManyToMany<T\\>(`filtered`: T[], `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T): void +▸ `Private`initializeManyToMany<T\\>(`filtered`: T[], `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `filtered` \| T[] \| -`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `field` \| keyof T \| Returns: void -Defined in: [packages/core/src/entity/EntityLoader.ts:204](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L204) +Defined in: [packages/core/src/entity/EntityLoader.ts:204](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L204) ___ ### initializeOneToMany -▸ `Private`initializeOneToMany<T\\>(`filtered`: T[], `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T): void +▸ `Private`initializeOneToMany<T\\>(`filtered`: T[], `children`: [AnyEntity](../modules/core.md#anyentity)<any\\>[], `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `field`: keyof T): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `filtered` \| T[] \| -`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`children` \| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `field` \| keyof T \| Returns: void -Defined in: [packages/core/src/entity/EntityLoader.ts:190](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L190) +Defined in: [packages/core/src/entity/EntityLoader.ts:190](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L190) ___ @@ -301,20 +298,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `prefix` \| string \| '' \| -`visited` \| string[] \| ... \| +`visited` \| string[] \| - \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/entity/EntityLoader.ts:361](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L361) +Defined in: [packages/core/src/entity/EntityLoader.ts:362](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L362) ___ @@ -325,21 +322,21 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| - \| `prefix` \| string \| '' \| -`visited` \| string[] \| ... \| +`visited` \| string[] \| - \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/entity/EntityLoader.ts:387](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L387) +Defined in: [packages/core/src/entity/EntityLoader.ts:388](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L388) ___ @@ -352,18 +349,18 @@ merge multiple populates for the same entity with different children #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/entity/EntityLoader.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L89) +Defined in: [packages/core/src/entity/EntityLoader.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L89) ___ @@ -374,96 +371,96 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `populate` \| true \\\| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| - \| `lookup` \| boolean \| true \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/entity/EntityLoader.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L58) +Defined in: [packages/core/src/entity/EntityLoader.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L58) ___ ### populate -▸ populate<T\\>(`entityName`: string, `entities`: T[], `populate`: boolean \\\| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `options`: Options<T\\>): Promise<void\\> +▸ populate<T\\>(`entityName`: string, `entities`: T[], `populate`: boolean \\\| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `options`: Options<T\\>): Promise<void\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `entities` \| T[] \| `populate` \| boolean \\\| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| `options` \| Options<T\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L32) +Defined in: [packages/core/src/entity/EntityLoader.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L32) ___ ### populateField -▸ `Private`populateField<T\\>(`entityName`: string, `entities`: T[], `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<void\\> +▸ `Private`populateField<T\\>(`entityName`: string, `entities`: T[], `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `entities` \| T[] \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\> \| -`options` \| Required<Options<T\\>\\> \| +`options` \| Required<Options<T\\>\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:244](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L244) +Defined in: [packages/core/src/entity/EntityLoader.ts:244](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L244) ___ ### populateMany -▸ `Private`populateMany<T\\>(`entityName`: string, `entities`: T[], `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +▸ `Private`populateMany<T\\>(`entityName`: string, `entities`: T[], `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>, `options`: Required<Options<T\\>\\>): Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> preload everything in one call (this will update already existing references in IM) #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `entities` \| T[] \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\> \| -`options` \| Required<Options<T\\>\\> \| +`options` \| Required<Options<T\\>\\> \| -Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> +Returns: Promise<[AnyEntity](../modules/core.md#anyentity)<any\\>[]\\> -Defined in: [packages/core/src/entity/EntityLoader.ts:133](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityLoader.ts#L133) +Defined in: [packages/core/src/entity/EntityLoader.ts:133](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityLoader.ts#L133) diff --git a/core.entitymanager.md b/core.entitymanager.md index a6812a6..45e9297 100644 --- a/core.entitymanager.md +++ b/core.entitymanager.md @@ -2,6 +2,7 @@ id: "core.entitymanager" title: "Class: EntityManager<D>" sidebar_label: "EntityManager" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ such as UnitOfWork, Query Language and Repository API. ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| ## Hierarchy @@ -35,22 +36,22 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| - \| `driver` \| D \| - \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `useContext` \| boolean \| true \| -`eventManager` \| [EventManager](core.eventmanager.md) \| ... \| +`eventManager` \| [EventManager](core.eventmanager.md) \| - \| Returns: [EntityManager](core.entitymanager.md)<D\\> -Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L33) +Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L33) ## Properties @@ -58,7 +59,7 @@ Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm • `Private` `Readonly` comparator: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/EntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L27) +Defined in: [packages/core/src/EntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L27) ___ @@ -72,7 +73,7 @@ ___ • `Private` `Readonly` entityFactory: [EntityFactory](core.entityfactory.md) -Defined in: [packages/core/src/EntityManager.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L29) +Defined in: [packages/core/src/EntityManager.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L29) ___ @@ -80,23 +81,23 @@ ___ • `Private` `Readonly` entityLoader: [EntityLoader](core.entityloader.md) -Defined in: [packages/core/src/EntityManager.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L26) +Defined in: [packages/core/src/EntityManager.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L26) ___ ### filterParams -• `Private` filterParams: [Dictionary](../modules/core.md#dictionary)<[Dictionary](../modules/core.md#dictionary)<any\\>\\> +• `Private` filterParams: [Dictionary](../modules/core.md#dictionary)<[Dictionary](../modules/core.md#dictionary)<any\\>\\> -Defined in: [packages/core/src/EntityManager.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L32) +Defined in: [packages/core/src/EntityManager.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L32) ___ ### filters -• `Private` filters: [Dictionary](../modules/core.md#dictionary)<FilterDef<any\\>\\> +• `Private` filters: [Dictionary](../modules/core.md#dictionary)<FilterDef<any\\>\\> -Defined in: [packages/core/src/EntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L31) +Defined in: [packages/core/src/EntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L31) ___ @@ -104,7 +105,7 @@ ___ • `Readonly` id: number -Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L22) +Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L22) ___ @@ -112,15 +113,15 @@ ___ • `Readonly` name: string -Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L23) +Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L23) ___ ### repositoryMap -• `Private` `Readonly` repositoryMap: [Dictionary](../modules/core.md#dictionary)<[EntityRepository](core.entityrepository.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> +• `Private` `Readonly` repositoryMap: [Dictionary](../modules/core.md#dictionary)<[EntityRepository](core.entityrepository.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> -Defined in: [packages/core/src/EntityManager.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L25) +Defined in: [packages/core/src/EntityManager.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L25) ___ @@ -128,7 +129,7 @@ ___ • `Private` `Readonly` resultCache: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/EntityManager.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L30) +Defined in: [packages/core/src/EntityManager.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L30) ___ @@ -136,7 +137,7 @@ ___ • `Private` `Optional` transactionContext: any -Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L33) +Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L33) ___ @@ -144,7 +145,7 @@ ___ • `Private` `Readonly` unitOfWork: any -Defined in: [packages/core/src/EntityManager.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L28) +Defined in: [packages/core/src/EntityManager.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L28) ___ @@ -152,7 +153,7 @@ ___ • `Private` `Readonly` validator: [EntityValidator](core.entityvalidator.md) -Defined in: [packages/core/src/EntityManager.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L24) +Defined in: [packages/core/src/EntityManager.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L24) ___ @@ -160,77 +161,77 @@ ___ ▪ `Private` `Static` counter: number= 1 -Defined in: [packages/core/src/EntityManager.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L21) +Defined in: [packages/core/src/EntityManager.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L21) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string -Defined in: [packages/core/src/EntityManager.ts:940](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L940) +Defined in: [packages/core/src/EntityManager.ts:968](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L968) ___ ### addFilter -▸ addFilter<T1\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void +▸ addFilter<T1\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| -`entityName?` \| string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| +`entityName?` \| [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| `enabled?` \| boolean \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L145) +Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L145) -▸ addFilter<T1, T2\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>] \| `enabled?` \| boolean \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L150) +Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L150) -▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| `T3` \| [AnyEntity](../modules/core.md#anyentity)<T3\\> \| @@ -238,15 +239,15 @@ Name \| Type \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>] \| `enabled?` \| boolean \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L155) +Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L155) ___ @@ -257,44 +258,46 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| Returns: [FilterQuery](../modules/core.md#filterquery)<T\\> -Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L193) +Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L193) ___ ### applyFilters -▸ `Protected`applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> + +`internal` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| +`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> -Defined in: [packages/core/src/EntityManager.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L205) +Defined in: [packages/core/src/EntityManager.ts:218](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L218) ___ @@ -307,38 +310,38 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| T \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:532](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L532) +Defined in: [packages/core/src/EntityManager.ts:546](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L546) ___ ### begin -▸ begin(`ctx?`: any): Promise<void\\> +▸ begin(`ctx?`: any): Promise<void\\> Starts new transaction bound to this EntityManager. Use `ctx` parameter to provide the parent when nesting transactions. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:381](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L381) +Defined in: [packages/core/src/EntityManager.ts:394](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L394) ___ @@ -351,36 +354,36 @@ Checks whether given property can be populated on the entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `property` \| string \| Returns: boolean -Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L698) +Defined in: [packages/core/src/EntityManager.ts:712](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L712) ___ ### checkLockRequirements -▸ `Private`checkLockRequirements(`mode`: undefined \\\| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`checkLockRequirements(`mode`: undefined \\\| [LockMode](../enums/core.lockmode.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`mode` \| undefined \\\| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`mode` \| undefined \\\| [LockMode](../enums/core.lockmode.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:829](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L829) +Defined in: [packages/core/src/EntityManager.ts:857](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L857) ___ @@ -392,72 +395,73 @@ Clears the EntityManager. All entities that are currently managed by this Entity Returns: void -Defined in: [packages/core/src/EntityManager.ts:691](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L691) +Defined in: [packages/core/src/EntityManager.ts:705](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L705) ___ ### commit -▸ commit(): Promise<void\\> +▸ commit(): Promise<void\\> Commits the transaction bound to this EntityManager. Flushes before doing the actual commit query. -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:388](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L388) +Defined in: [packages/core/src/EntityManager.ts:401](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L401) ___ ### count -▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/EntityManager.ts:582](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L582) +Defined in: [packages/core/src/EntityManager.ts:596](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L596) ___ ### create -▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: undefined \\\| boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> +▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| { `managed?`: undefined \\\| boolean } \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| object \| +`options.managed?` \| boolean \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> -Defined in: [packages/core/src/EntityManager.ts:525](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L525) +Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L539) ___ @@ -470,21 +474,21 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L88) +Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L88) ▸ find<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -493,14 +497,14 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -510,7 +514,7 @@ Name \| Type \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L93) +Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L93) ___ @@ -524,21 +528,21 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> -Defined in: [packages/core/src/EntityManager.ts:248](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L248) +Defined in: [packages/core/src/EntityManager.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L261) ▸ findAndCount<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -548,14 +552,14 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -565,7 +569,7 @@ Name \| Type \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> -Defined in: [packages/core/src/EntityManager.ts:254](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L254) +Defined in: [packages/core/src/EntityManager.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L267) ___ @@ -578,21 +582,21 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| Returns: Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:273](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L273) +Defined in: [packages/core/src/EntityManager.ts:286](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L286) ▸ findOne<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -601,14 +605,14 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -616,7 +620,7 @@ Name \| Type \| Returns: Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L278) +Defined in: [packages/core/src/EntityManager.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L291) ___ @@ -631,21 +635,21 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:334](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L334) +Defined in: [packages/core/src/EntityManager.ts:347](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L347) ▸ findOneOrFail<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -656,14 +660,14 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -671,20 +675,20 @@ Name \| Type \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:341](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L341) +Defined in: [packages/core/src/EntityManager.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L354) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:684](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L684) +Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L698) ___ @@ -697,13 +701,13 @@ Returns new EntityManager instance with its own identity map #### Parameters: Name \| Type \| Default value \| Description \| ------- \| ------ \| ------ \| ------ \| +:------ \| :------ \| :------ \| :------ \| `clear` \| boolean \| true \| do we want clear identity map? defaults to true \| `useContext` \| boolean \| false \| use request context? should be used only for top level request scope EM, defaults to false \| Returns: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)] -Defined in: [packages/core/src/EntityManager.ts:755](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L755) +Defined in: [packages/core/src/EntityManager.ts:769](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L769) ___ @@ -715,7 +719,7 @@ Gets the EntityComparator. Returns: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L825) +Defined in: [packages/core/src/EntityManager.ts:853](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L853) ___ @@ -728,12 +732,12 @@ Gets the Connection instance, by default returns write connection #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| Returns: ReturnType<D[getConnection]\\> -Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L52) +Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L52) ___ @@ -745,7 +749,7 @@ Gets the EntityManager based on current transaction/request context. Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L786) +Defined in: [packages/core/src/EntityManager.ts:800](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L800) ___ @@ -758,7 +762,7 @@ Driver is singleton, for one MikroORM instance, only one driver is created. Returns: D -Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L45) +Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L45) ___ @@ -770,7 +774,7 @@ Gets the EntityFactory used by the EntityManager. Returns: [EntityFactory](core.entityfactory.md) -Defined in: [packages/core/src/EntityManager.ts:779](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L779) +Defined in: [packages/core/src/EntityManager.ts:793](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L793) ___ @@ -780,7 +784,7 @@ ___ Returns: [EventManager](core.eventmanager.md) -Defined in: [packages/core/src/EntityManager.ts:797](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L797) +Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L811) ___ @@ -793,18 +797,18 @@ Returns filter parameters for given filter set in this context. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L181) +Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L181) ___ @@ -816,7 +820,7 @@ Gets the MetadataStorage. Returns: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L818) +Defined in: [packages/core/src/EntityManager.ts:846](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L846) ___ @@ -828,7 +832,7 @@ Gets the platform instance. Just like the driver, platform is singleton, one for Returns: ReturnType<D[getPlatform]\\> -Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L59) +Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L59) ___ @@ -841,14 +845,14 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| @@ -856,7 +860,7 @@ Name \| Type \| Returns: [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> -Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L539) +Defined in: [packages/core/src/EntityManager.ts:553](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L553) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[]): T @@ -865,19 +869,19 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:544](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L544) +Defined in: [packages/core/src/EntityManager.ts:558](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L558) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false, `convertCustomTypes?`: boolean): T @@ -886,13 +890,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| @@ -900,7 +904,7 @@ Name \| Type \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:549](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L549) +Defined in: [packages/core/src/EntityManager.ts:563](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L563) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped?`: boolean, `convertCustomTypes?`: boolean): T \\\| [Reference](core.reference.md)<T\\> @@ -909,13 +913,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped?` \| boolean \| @@ -923,7 +927,7 @@ Name \| Type \| Returns: T \\\| [Reference](core.reference.md)<T\\> -Defined in: [packages/core/src/EntityManager.ts:554](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L554) +Defined in: [packages/core/src/EntityManager.ts:568](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L568) ___ @@ -936,19 +940,19 @@ Gets repository for given entity. You can pass either string name or entity clas #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](core.entityrepository.md)<T\\\\> \| +`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](core.entityrepository.md)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [GetRepository](../modules/core.md#getrepository)<T, U\\> -Defined in: [packages/core/src/EntityManager.ts:66](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L66) +Defined in: [packages/core/src/EntityManager.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L66) ___ @@ -961,12 +965,12 @@ Gets the transaction context (driver dependent object used to make sure queries #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| unknown \| any \| Returns: undefined \\\| T -Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L811) +Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L825) ___ @@ -978,7 +982,7 @@ Gets the UnitOfWork used by the EntityManager to coordinate operations. Returns: [UnitOfWork](core.unitofwork.md) -Defined in: [packages/core/src/EntityManager.ts:772](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L772) +Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L786) ___ @@ -990,7 +994,7 @@ Gets EntityValidator instance Returns: [EntityValidator](core.entityvalidator.md) -Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L81) +Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L81) ___ @@ -1002,53 +1006,53 @@ Checks whether this EntityManager is currently operating inside a database trans Returns: boolean -Defined in: [packages/core/src/EntityManager.ts:804](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L804) +Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L818) ___ ### lock -▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> +▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> Runs your callback wrapped inside a database transaction. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `lockMode` \| [LockMode](../enums/core.lockmode.md) \| `lockVersion?` \| number \\\| Date \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:405](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L405) +Defined in: [packages/core/src/EntityManager.ts:418](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L418) ___ ### lockAndPopulate -▸ `Private`lockAndPopulate<T, P\\>(`entityName`: string, `entity`: T, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ `Private`lockAndPopulate<T, P\\>(`entityName`: string, `entity`: T, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `entity` \| T \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:843](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L843) +Defined in: [packages/core/src/EntityManager.ts:871](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L871) ___ @@ -1061,19 +1065,19 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:468](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L468) +Defined in: [packages/core/src/EntityManager.ts:481](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L481) ___ @@ -1087,19 +1091,19 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `refresh?` \| boolean \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:487](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L487) +Defined in: [packages/core/src/EntityManager.ts:501](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L501) ▸ merge<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `refresh?`: boolean, `convertCustomTypes?`: boolean): T @@ -1109,13 +1113,13 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| @@ -1123,33 +1127,33 @@ Name \| Type \| Returns: T -Defined in: [packages/core/src/EntityManager.ts:493](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L493) +Defined in: [packages/core/src/EntityManager.ts:507](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L507) ___ ### nativeDelete -▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> +▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/EntityManager.ts:456](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L456) +Defined in: [packages/core/src/EntityManager.ts:469](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L469) ___ @@ -1162,18 +1166,18 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> -Defined in: [packages/core/src/EntityManager.ts:412](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L412) +Defined in: [packages/core/src/EntityManager.ts:425](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L425) ▸ nativeInsert<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<[Primary](../modules/core.md#primary)<T\\>\\> @@ -1182,52 +1186,52 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> -Defined in: [packages/core/src/EntityManager.ts:417](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L417) +Defined in: [packages/core/src/EntityManager.ts:430](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L430) ___ ### nativeUpdate -▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> +▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/EntityManager.ts:442](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L442) +Defined in: [packages/core/src/EntityManager.ts:455](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L455) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](core.entitymanager.md)<D\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](core.entitymanager.md)<D\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1235,18 +1239,18 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| Returns: [EntityManager](core.entitymanager.md)<D\\> -Defined in: [packages/core/src/EntityManager.ts:603](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L603) +Defined in: [packages/core/src/EntityManager.ts:617](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L617) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -1254,18 +1258,18 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:628](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L628) +Defined in: [packages/core/src/EntityManager.ts:642](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L642) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1275,167 +1279,167 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:638](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L638) +Defined in: [packages/core/src/EntityManager.ts:652](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L652) ___ ### populate -▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/EntityManager.ts:718](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L718) +Defined in: [packages/core/src/EntityManager.ts:732](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L732) -▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/EntityManager.ts:723](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L723) +Defined in: [packages/core/src/EntityManager.ts:737](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L737) -▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/EntityManager.ts:728](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L728) +Defined in: [packages/core/src/EntityManager.ts:742](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L742) ___ ### preparePopulate -▸ `Private`preparePopulate<T\\>(`entityName`: string, `populate?`: boolean \\\| readonly string[] \\\| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) \\\| readonly keyof T[] \\\| PopulateChildren<T\\>, `strategy?`: [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined)): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] +▸ `Private`preparePopulate<T\\>(`entityName`: string, `populate?`: readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>, `strategy?`: [LoadStrategy](../enums/core.loadstrategy.md)): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| -`populate?` \| boolean \\\| readonly string[] \\\| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| -`strategy?` \| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) \| +`populate?` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| +`strategy?` \| [LoadStrategy](../enums/core.loadstrategy.md) \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/EntityManager.ts:854](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L854) +Defined in: [packages/core/src/EntityManager.ts:882](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L882) ___ ### preparePopulateObject -▸ `Private`preparePopulateObject<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate`: PopulateMap<T\\>, `strategy?`: [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined)): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] +▸ `Private`preparePopulateObject<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate`: boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>, `strategy?`: [LoadStrategy](../enums/core.loadstrategy.md)): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| -`populate` \| PopulateMap<T\\> \| -`strategy?` \| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) \| +`populate` \| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| +`strategy?` \| [LoadStrategy](../enums/core.loadstrategy.md) \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/core/src/EntityManager.ts:883](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L883) +Defined in: [packages/core/src/EntityManager.ts:911](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L911) ___ ### processWhere -▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> -Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L185) +Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L185) ___ @@ -1451,24 +1455,24 @@ To remove entities by condition, use `em.nativeDelete()`. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [Reference](core.reference.md)<T\\> \\\| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: [EntityManager](core.entitymanager.md)<D\\> -Defined in: [packages/core/src/EntityManager.ts:648](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L648) +Defined in: [packages/core/src/EntityManager.ts:662](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L662) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -1476,18 +1480,18 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:666](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L666) +Defined in: [packages/core/src/EntityManager.ts:680](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L680) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -1497,30 +1501,42 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:676](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L676) +Defined in: [packages/core/src/EntityManager.ts:690](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L690) + +___ + +### resetTransactionContext + +▸ resetTransactionContext(): void + +Resets the transaction context. + +Returns: void + +Defined in: [packages/core/src/EntityManager.ts:839](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L839) ___ ### rollback -▸ rollback(): Promise<void\\> +▸ rollback(): Promise<void\\> Rollbacks the transaction bound to this EntityManager. -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:397](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L397) +Defined in: [packages/core/src/EntityManager.ts:410](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L410) ___ ### setFilterParams -▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void +▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void Sets filter parameter values globally inside context defined by this entity manager. If you want to set shared value for all contexts, be sure to use the root entity manager. @@ -1528,33 +1544,52 @@ If you want to set shared value for all contexts, be sure to use the root entity #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: void + +Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L174) + +___ + +### setTransactionContext + +▸ setTransactionContext(`ctx`: any): void + +Sets the transaction context. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`ctx` \| any \| Returns: void -Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L174) +Defined in: [packages/core/src/EntityManager.ts:832](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L832) ___ ### storeCache -▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> +▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> `internal` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| -`key` \| { `key`: string } \| +`key` \| object \| +`key.key` \| string \| `data` \| unknown \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L932) +Defined in: [packages/core/src/EntityManager.ts:960](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L960) ___ @@ -1567,45 +1602,45 @@ Runs your callback wrapped inside a database transaction. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| - \| -`ctx` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| +`ctx` \| any \| Returns: Promise<T\\> -Defined in: [packages/core/src/EntityManager.ts:364](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L364) +Defined in: [packages/core/src/EntityManager.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L377) ___ ### tryCache -▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: R ; `key`: string }\\> `internal` #### Type parameters: Name \| ------- \| +:------ \| `T` \| `R` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| `key` \| unknown \| `refresh?` \| boolean \| `merge?` \| boolean \| -Returns: Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +Returns: Promise<undefined \\\| { `data?`: R ; `key`: string }\\> -Defined in: [packages/core/src/EntityManager.ts:904](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L904) +Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L932) diff --git a/core.entitymetadata.md b/core.entitymetadata.md index af88f5c..8fe3591 100644 --- a/core.entitymetadata.md +++ b/core.entitymetadata.md @@ -2,6 +2,7 @@ id: "core.entitymetadata" title: "Class: EntityMetadata<T>" sidebar_label: "EntityMetadata" +custom_edit_url: null hide_title: true --- @@ -12,34 +13,30 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| -## Hierarchy - -* EntityMetadata - ## Constructors ### constructor -\\+ new EntityMetadata<T\\>(`meta?`: Partial<[EntityMetadata](core.entitymetadata.md)<any\\>\\>): [EntityMetadata](core.entitymetadata.md)<T\\> +\\+ new EntityMetadata<T\\>(`meta?`: Partial<[EntityMetadata](core.entitymetadata.md)<any\\>\\>): [EntityMetadata](core.entitymetadata.md)<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| Partial<[EntityMetadata](core.entitymetadata.md)<any\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`meta` \| Partial<[EntityMetadata](core.entitymetadata.md)<any\\>\\> \| Returns: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/typings.ts:191](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L191) +Defined in: [packages/core/src/typings.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L191) ## Properties @@ -47,7 +44,7 @@ Defined in: [packages/core/src/typings.ts:191](https://github.com/mikro-orm/mikr • abstract: boolean -Defined in: [packages/core/src/typings.ts:307](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L307) +Defined in: [packages/core/src/typings.ts:307](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L307) ___ @@ -55,7 +52,7 @@ ___ • class: [Constructor](../modules/core.md#constructor)<T\\> -Defined in: [packages/core/src/typings.ts:306](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L306) +Defined in: [packages/core/src/typings.ts:306](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L306) ___ @@ -63,7 +60,7 @@ ___ • className: string -Defined in: [packages/core/src/typings.ts:279](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L279) +Defined in: [packages/core/src/typings.ts:279](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L279) ___ @@ -71,15 +68,15 @@ ___ • collection: string -Defined in: [packages/core/src/typings.ts:290](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L290) +Defined in: [packages/core/src/typings.ts:290](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L290) ___ ### comment -• `Optional` comment: undefined \\\| string +• `Optional` comment: string -Defined in: [packages/core/src/typings.ts:310](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L310) +Defined in: [packages/core/src/typings.ts:310](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L310) ___ @@ -87,7 +84,7 @@ ___ • comparableProps: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/typings.ts:299](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L299) +Defined in: [packages/core/src/typings.ts:299](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L299) ___ @@ -95,7 +92,7 @@ ___ • compositePK: boolean -Defined in: [packages/core/src/typings.ts:293](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L293) +Defined in: [packages/core/src/typings.ts:293](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L293) ___ @@ -103,7 +100,7 @@ ___ • constructorParams: string[] -Defined in: [packages/core/src/typings.ts:286](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L286) +Defined in: [packages/core/src/typings.ts:286](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L286) ___ @@ -111,31 +108,39 @@ ___ • customRepository: () => [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> -Defined in: [packages/core/src/typings.ts:303](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L303) +#### Type declaration: + +▸ (): [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> + +Returns: [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> + +Defined in: [packages/core/src/typings.ts:303](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L303) + +Defined in: [packages/core/src/typings.ts:303](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L303) ___ ### discriminatorColumn -• `Optional` discriminatorColumn: undefined \\\| string +• `Optional` discriminatorColumn: string -Defined in: [packages/core/src/typings.ts:282](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L282) +Defined in: [packages/core/src/typings.ts:282](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L282) ___ ### discriminatorMap -• `Optional` discriminatorMap: undefined \\\| [Dictionary](../modules/core.md#dictionary)<string\\> +• `Optional` discriminatorMap: [Dictionary](../modules/core.md#dictionary)<string\\> -Defined in: [packages/core/src/typings.ts:284](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L284) +Defined in: [packages/core/src/typings.ts:284](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L284) ___ ### discriminatorValue -• `Optional` discriminatorValue: undefined \\\| string +• `Optional` discriminatorValue: string -Defined in: [packages/core/src/typings.ts:283](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L283) +Defined in: [packages/core/src/typings.ts:283](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L283) ___ @@ -143,7 +148,7 @@ ___ • embeddable: boolean -Defined in: [packages/core/src/typings.ts:285](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L285) +Defined in: [packages/core/src/typings.ts:285](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L285) ___ @@ -151,15 +156,15 @@ ___ • extends: string -Defined in: [packages/core/src/typings.ts:289](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L289) +Defined in: [packages/core/src/typings.ts:289](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L289) ___ ### filters -• filters: [Dictionary](../modules/core.md#dictionary)<FilterDef<T\\>\\> +• filters: [Dictionary](../modules/core.md#dictionary)<FilterDef<T\\>\\> -Defined in: [packages/core/src/typings.ts:309](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L309) +Defined in: [packages/core/src/typings.ts:309](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L309) ___ @@ -167,15 +172,15 @@ ___ • forceConstructor: boolean -Defined in: [packages/core/src/typings.ts:287](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L287) +Defined in: [packages/core/src/typings.ts:287](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L287) ___ ### hooks -• hooks: Partial<Record<onInit \\\| beforeCreate \\\| afterCreate \\\| beforeUpdate \\\| afterUpdate \\\| beforeDelete \\\| afterDelete \\\| beforeFlush \\\| onFlush \\\| afterFlush \\\| beforeTransactionStart \\\| afterTransactionStart \\\| beforeTransactionCommit \\\| afterTransactionCommit \\\| beforeTransactionRollback \\\| afterTransactionRollback, string & keyof T[]\\>\\> +• hooks: Partial<Record<onInit \\\| beforeCreate \\\| afterCreate \\\| beforeUpdate \\\| afterUpdate \\\| beforeDelete \\\| afterDelete \\\| beforeFlush \\\| onFlush \\\| afterFlush \\\| beforeTransactionStart \\\| afterTransactionStart \\\| beforeTransactionCommit \\\| afterTransactionCommit \\\| beforeTransactionRollback \\\| afterTransactionRollback, string & keyof T[]\\>\\> -Defined in: [packages/core/src/typings.ts:304](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L304) +Defined in: [packages/core/src/typings.ts:304](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L304) ___ @@ -183,23 +188,23 @@ ___ • hydrateProps: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/typings.ts:300](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L300) +Defined in: [packages/core/src/typings.ts:300](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L300) ___ ### indexes -• indexes: { `name?`: undefined \\\| string ; `options?`: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\> ; `properties`: keyof T & string \\\| keyof T & string[] ; `type?`: undefined \\\| string }[] +• indexes: { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `properties`: keyof T & string \\\| keyof T & string[] ; `type?`: string }[] -Defined in: [packages/core/src/typings.ts:301](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L301) +Defined in: [packages/core/src/typings.ts:301](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L301) ___ ### name -• `Optional` name: undefined \\\| string +• `Optional` name: string -Defined in: [packages/core/src/typings.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L278) +Defined in: [packages/core/src/typings.ts:278](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L278) ___ @@ -207,7 +212,7 @@ ___ • path: string -Defined in: [packages/core/src/typings.ts:291](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L291) +Defined in: [packages/core/src/typings.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L291) ___ @@ -215,7 +220,7 @@ ___ • pivotTable: boolean -Defined in: [packages/core/src/typings.ts:281](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L281) +Defined in: [packages/core/src/typings.ts:281](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L281) ___ @@ -223,7 +228,7 @@ ___ • primaryKeys: keyof T & string[] -Defined in: [packages/core/src/typings.ts:292](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L292) +Defined in: [packages/core/src/typings.ts:292](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L292) ___ @@ -231,15 +236,15 @@ ___ • properties: { [K in string]: EntityProperty<T\\>} -Defined in: [packages/core/src/typings.ts:296](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L296) +Defined in: [packages/core/src/typings.ts:296](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L296) ___ ### propertyOrder -• `Readonly` propertyOrder: Map<string, number\\> +• `Readonly` propertyOrder: Map<string, number\\> -Defined in: [packages/core/src/typings.ts:191](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L191) +Defined in: [packages/core/src/typings.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L191) ___ @@ -247,7 +252,7 @@ ___ • props: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/typings.ts:297](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L297) +Defined in: [packages/core/src/typings.ts:297](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L297) ___ @@ -255,15 +260,15 @@ ___ • prototype: T -Defined in: [packages/core/src/typings.ts:305](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L305) +Defined in: [packages/core/src/typings.ts:305](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L305) ___ ### readonly -• `Optional` readonly: undefined \\\| boolean +• `Optional` readonly: boolean -Defined in: [packages/core/src/typings.ts:312](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L312) +Defined in: [packages/core/src/typings.ts:312](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L312) ___ @@ -271,7 +276,7 @@ ___ • relations: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/typings.ts:298](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L298) +Defined in: [packages/core/src/typings.ts:298](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L298) ___ @@ -279,15 +284,15 @@ ___ • root: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/typings.ts:313](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L313) +Defined in: [packages/core/src/typings.ts:313](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L313) ___ ### selfReferencing -• `Optional` selfReferencing: undefined \\\| boolean +• `Optional` selfReferencing: boolean -Defined in: [packages/core/src/typings.ts:311](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L311) +Defined in: [packages/core/src/typings.ts:311](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L311) ___ @@ -295,7 +300,7 @@ ___ • serializedPrimaryKey: keyof T & string -Defined in: [packages/core/src/typings.ts:295](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L295) +Defined in: [packages/core/src/typings.ts:295](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L295) ___ @@ -303,7 +308,7 @@ ___ • tableName: string -Defined in: [packages/core/src/typings.ts:280](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L280) +Defined in: [packages/core/src/typings.ts:280](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L280) ___ @@ -311,15 +316,15 @@ ___ • toJsonParams: string[] -Defined in: [packages/core/src/typings.ts:288](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L288) +Defined in: [packages/core/src/typings.ts:288](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L288) ___ ### uniques -• uniques: { `name?`: undefined \\\| string ; `options?`: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\> ; `properties`: keyof T & string \\\| keyof T & string[] }[] +• uniques: { `name?`: string ; `options?`: [Dictionary](../modules/core.md#dictionary)<any\\> ; `properties`: keyof T & string \\\| keyof T & string[] }[] -Defined in: [packages/core/src/typings.ts:302](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L302) +Defined in: [packages/core/src/typings.ts:302](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L302) ___ @@ -327,7 +332,7 @@ ___ • useCache: boolean -Defined in: [packages/core/src/typings.ts:308](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L308) +Defined in: [packages/core/src/typings.ts:308](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L308) ___ @@ -335,7 +340,7 @@ ___ • versionProperty: keyof T & string -Defined in: [packages/core/src/typings.ts:294](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L294) +Defined in: [packages/core/src/typings.ts:294](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L294) ## Methods @@ -346,13 +351,13 @@ Defined in: [packages/core/src/typings.ts:294](https://github.com/mikro-orm/mikr #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| `sync` \| boolean \| true \| Returns: void -Defined in: [packages/core/src/typings.ts:204](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L204) +Defined in: [packages/core/src/typings.ts:204](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L204) ___ @@ -362,7 +367,7 @@ ___ Returns: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/typings.ts:224](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L224) +Defined in: [packages/core/src/typings.ts:224](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L224) ___ @@ -373,12 +378,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/typings.ts:247](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L247) +Defined in: [packages/core/src/typings.ts:247](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L247) ___ @@ -389,13 +394,13 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `name` \| string \| - \| `sync` \| boolean \| true \| Returns: void -Defined in: [packages/core/src/typings.ts:214](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L214) +Defined in: [packages/core/src/typings.ts:214](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L214) ___ @@ -406,9 +411,9 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `initIndexes` \| boolean \| false \| Returns: void -Defined in: [packages/core/src/typings.ts:228](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L228) +Defined in: [packages/core/src/typings.ts:228](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L228) diff --git a/core.entityrepository.md b/core.entityrepository.md index c085451..7403064 100644 --- a/core.entityrepository.md +++ b/core.entityrepository.md @@ -2,6 +2,7 @@ id: "core.entityrepository" title: "Class: EntityRepository<T>" sidebar_label: "EntityRepository" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| ## Hierarchy @@ -32,19 +33,19 @@ Name \| Type \| #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `_em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [EntityRepository](core.entityrepository.md)<T\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L7) +Defined in: [packages/core/src/entity/EntityRepository.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L7) ## Properties @@ -62,11 +63,11 @@ ___ ### em -• em(): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +• `Protected`get em(): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L278) +Defined in: [packages/core/src/entity/EntityRepository.ts:278](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L278) ## Methods @@ -79,13 +80,13 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T -Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L259) +Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L259) ___ @@ -98,31 +99,31 @@ Checks whether given property can be populated on the entity. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `property` \| string \| Returns: boolean -Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L223) +Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L223) ___ ### count -▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L274) +Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L274) ___ @@ -135,18 +136,18 @@ Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| string[] \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| string[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L252) +Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L252) ___ @@ -159,19 +160,19 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L81) +Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L81) ▸ find<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -180,13 +181,13 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -195,7 +196,7 @@ Name \| Type \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L86) +Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L86) ___ @@ -208,18 +209,18 @@ Finds all entities of given type. You can pass additional options via the `optio #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L118) +Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L118) ▸ findAll<P\\>(`populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -228,13 +229,13 @@ Finds all entities of given type. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `limit?` \| number \| @@ -242,13 +243,13 @@ Name \| Type \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L123) +Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L123) ___ ### findAndCount -▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> +▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple where first element is the array of entities and the second is the count. @@ -256,19 +257,19 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L99) +Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L99) ▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -278,13 +279,13 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -293,7 +294,7 @@ Name \| Type \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L105) +Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L105) ___ @@ -306,20 +307,20 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L41) +Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L41) ▸ findOne<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -328,20 +329,20 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L46) +Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L46) ___ @@ -356,20 +357,20 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L60) +Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L60) ▸ findOneOrFail<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -380,35 +381,35 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L67) +Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L67) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. This method is a shortcut for `em.flush()`, in other words, it will flush the whole UoW, not just entities registered via this particular repository. -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L166) +Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L166) ___ @@ -421,19 +422,19 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| Returns: [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L201) +Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L201) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>): T @@ -442,18 +443,18 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| Returns: T -Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L206) +Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L206) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false): T @@ -462,19 +463,19 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| Returns: T -Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L211) +Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L211) ___ @@ -487,12 +488,12 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T -Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L194) +Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L194) ___ @@ -506,32 +507,33 @@ via second parameter. By default it will return already loaded entities without #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| T \\\| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| `convertCustomTypes?` \| boolean \| Returns: T -Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L267) +Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L267) ___ ### nativeDelete -▸ nativeDelete(`where`: any): Promise<number\\> +▸ nativeDelete(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| -`where` \| any \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options?` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L187) +Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L187) ___ @@ -544,37 +546,38 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L173) +Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L173) ___ ### nativeUpdate -▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<number\\> +▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options?` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L180) +Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L180) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -582,18 +585,18 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L16) +Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L16) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -601,18 +604,18 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L24) +Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L24) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -622,97 +625,97 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void -Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L34) +Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L34) ___ ### populate -▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L230) +Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L230) -▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L235) +Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L235) -▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L240) +Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L240) ___ ### remove -▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -722,18 +725,18 @@ To remove entities by condition, use `em.nativeDelete()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L138) +Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L138) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -741,18 +744,18 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L146) +Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L146) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -762,9 +765,9 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L156) +Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L156) diff --git a/core.entitytransformer.md b/core.entitytransformer.md index ed2c621..ee38893 100644 --- a/core.entitytransformer.md +++ b/core.entitytransformer.md @@ -2,6 +2,7 @@ id: "core.entitytransformer" title: "Class: EntityTransformer" sidebar_label: "EntityTransformer" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityTransformer -## Hierarchy - -* EntityTransformer - ## Constructors ### constructor @@ -30,20 +27,20 @@ hide_title: true #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `prop` \| keyof T & string \| `ignoreFields` \| string[] \| Returns: boolean -Defined in: [packages/core/src/entity/EntityTransformer.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L155) +Defined in: [packages/core/src/entity/EntityTransformer.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L155) ___ @@ -54,20 +51,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| keyof T \| `entity` \| T \| `raw` \| boolean \| Returns: undefined \\\| T[keyof T] -Defined in: [packages/core/src/entity/EntityTransformer.ts:216](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L216) +Defined in: [packages/core/src/entity/EntityTransformer.ts:216](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L216) ___ @@ -78,13 +75,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| keyof T \| `entity` \| T \| `platform` \| [Platform](core.platform.md) \| @@ -92,7 +89,7 @@ Name \| Type \| Returns: undefined \\\| T[keyof T] -Defined in: [packages/core/src/entity/EntityTransformer.ts:200](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L200) +Defined in: [packages/core/src/entity/EntityTransformer.ts:200](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L200) ___ @@ -103,20 +100,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| keyof T & string \| `entity` \| T \| `raw` \| boolean \| Returns: undefined \\\| T[keyof T] -Defined in: [packages/core/src/entity/EntityTransformer.ts:172](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L172) +Defined in: [packages/core/src/entity/EntityTransformer.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L172) ___ @@ -127,20 +124,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `prop` \| keyof T & string \| `platform?` \| [Platform](core.platform.md) \| Returns: keyof T & string -Defined in: [packages/core/src/entity/EntityTransformer.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L160) +Defined in: [packages/core/src/entity/EntityTransformer.ts:160](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L160) ___ @@ -151,17 +148,17 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| -`ignoreFields` \| string[] \| ... \| +`ignoreFields` \| string[] \| - \| `raw` \| boolean \| false \| Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/entity/EntityTransformer.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L85) +Defined in: [packages/core/src/entity/EntityTransformer.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L85) diff --git a/core.entityvalidator.md b/core.entityvalidator.md index 990eef0..5fc0a24 100644 --- a/core.entityvalidator.md +++ b/core.entityvalidator.md @@ -2,6 +2,7 @@ id: "core.entityvalidator" title: "Class: EntityValidator" sidebar_label: "EntityValidator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).EntityValidator -## Hierarchy - -* EntityValidator - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `strict` \| boolean \| Returns: [EntityValidator](core.entityvalidator.md) -Defined in: [packages/core/src/entity/EntityValidator.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L6) +Defined in: [packages/core/src/entity/EntityValidator.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L6) ## Methods @@ -38,12 +35,12 @@ Defined in: [packages/core/src/entity/EntityValidator.ts:6](https://github.com/m #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `givenValue` \| number \| Returns: number \\\| boolean -Defined in: [packages/core/src/entity/EntityValidator.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L147) +Defined in: [packages/core/src/entity/EntityValidator.ts:147](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L147) ___ @@ -54,12 +51,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `givenValue` \| string \| Returns: string \\\| Date -Defined in: [packages/core/src/entity/EntityValidator.ts:130](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L130) +Defined in: [packages/core/src/entity/EntityValidator.ts:130](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L130) ___ @@ -70,12 +67,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `givenValue` \| string \| Returns: string \\\| number -Defined in: [packages/core/src/entity/EntityValidator.ts:142](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L142) +Defined in: [packages/core/src/entity/EntityValidator.ts:142](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L142) ___ @@ -86,96 +83,96 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `expectedType` \| string \| `givenType` \| string \| `givenValue` \| any \| Returns: any -Defined in: [packages/core/src/entity/EntityValidator.ts:114](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L114) +Defined in: [packages/core/src/entity/EntityValidator.ts:114](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L114) ___ ### getValue -▸ `Private`getValue(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): any +▸ `Private`getValue(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): any #### Parameters: Name \| Type \| ------- \| ------ \| -`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: any -Defined in: [packages/core/src/entity/EntityValidator.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L91) +Defined in: [packages/core/src/entity/EntityValidator.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L91) ___ ### setValue -▸ `Private`setValue(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `v`: any): any +▸ `Private`setValue(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `v`: any): any #### Parameters: Name \| Type \| ------- \| ------ \| -`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `v` \| any \| Returns: any -Defined in: [packages/core/src/entity/EntityValidator.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L99) +Defined in: [packages/core/src/entity/EntityValidator.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L99) ___ ### validate -▸ validate<T\\>(`entity`: T, `payload`: any, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ validate<T\\>(`entity`: T, `payload`: any, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `payload` \| any \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityValidator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L10) +Defined in: [packages/core/src/entity/EntityValidator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L10) ___ ### validateCollection -▸ `Private`validateCollection<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`validateCollection<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityValidator.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L108) +Defined in: [packages/core/src/entity/EntityValidator.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L108) ___ @@ -186,18 +183,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityValidator.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L85) +Defined in: [packages/core/src/entity/EntityValidator.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L85) ___ @@ -208,58 +205,58 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `params` \| any \| - \| `type` \| string \| 'search condition' \| `field?` \| string \| - \| Returns: void -Defined in: [packages/core/src/entity/EntityValidator.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L61) +Defined in: [packages/core/src/entity/EntityValidator.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L61) ___ ### validatePrimaryKey -▸ validatePrimaryKey<T\\>(`entity`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ validatePrimaryKey<T\\>(`entity`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| [EntityData](../modules/core.md#entitydata)<T\\> \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityValidator.ts:77](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L77) +Defined in: [packages/core/src/entity/EntityValidator.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L77) ___ ### validateProperty -▸ validateProperty<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `givenValue`: any, `entity`: T): any +▸ validateProperty<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `givenValue`: any, `entity`: T): any #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `givenValue` \| any \| `entity` \| T \| Returns: any -Defined in: [packages/core/src/entity/EntityValidator.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityValidator.ts#L40) +Defined in: [packages/core/src/entity/EntityValidator.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityValidator.ts#L40) diff --git a/core.enumarraytype.md b/core.enumarraytype.md index ef55d6d..6e1cec7 100644 --- a/core.enumarraytype.md +++ b/core.enumarraytype.md @@ -2,6 +2,7 @@ id: "core.enumarraytype" title: "Class: EnumArrayType<T>" sidebar_label: "EnumArrayType" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| string \\\| number \| string \| ## Hierarchy @@ -30,22 +31,22 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| string \\\| number \| string \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`owner` \| string \| - \| -`items?` \| T[] \| - \| -`hydrate` \| (`i`: string) => T \| ... \| +Name \| Type \| +:------ \| :------ \| +`owner` \| string \| +`items?` \| T[] \| +`hydrate` \| (`i`: string) => T \| Returns: [EnumArrayType](core.enumarraytype.md)<T\\> -Inherited from: [ArrayType](core.arraytype.md) +Overrides: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/EnumArrayType.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/EnumArrayType.ts#L14) +Defined in: [packages/core/src/types/EnumArrayType.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/EnumArrayType.ts#L14) ## Methods @@ -57,7 +58,7 @@ Defined in: [packages/core/src/types/EnumArrayType.ts:14](https://github.com/mik Inherited from: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/ArrayType.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L41) +Defined in: [packages/core/src/types/ArrayType.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L41) ___ @@ -68,7 +69,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| null \\\| T[] \| `platform` \| [Platform](core.platform.md) \| `fromQuery?` \| boolean \| @@ -77,7 +78,28 @@ Name \| Type \| Overrides: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/EnumArrayType.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/EnumArrayType.ts#L22) +Defined in: [packages/core/src/types/EnumArrayType.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/EnumArrayType.ts#L22) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [ArrayType](core.arraytype.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -88,7 +110,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| null \\\| string \\\| T[] \| `platform` \| [Platform](core.platform.md) \| @@ -96,26 +118,47 @@ Name \| Type \| Inherited from: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/ArrayType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L29) +Defined in: [packages/core/src/types/ArrayType.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L29) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [ArrayType](core.arraytype.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Inherited from: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/ArrayType.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L49) +Defined in: [packages/core/src/types/ArrayType.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L49) ___ @@ -126,14 +169,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| T[] \| Returns: T[] Inherited from: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/ArrayType.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/ArrayType.ts#L45) +Defined in: [packages/core/src/types/ArrayType.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/ArrayType.ts#L45) ___ @@ -144,18 +187,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [ArrayType](core.arraytype.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.eventmanager.md b/core.eventmanager.md index 0d3da83..e78cf15 100644 --- a/core.eventmanager.md +++ b/core.eventmanager.md @@ -2,6 +2,7 @@ id: "core.eventmanager" title: "Class: EventManager" sidebar_label: "EventManager" +custom_edit_url: null hide_title: true --- @@ -9,41 +10,37 @@ hide_title: true [core](../modules/core.md).EventManager -## Hierarchy - -* EventManager - ## Constructors ### constructor -\\+ new EventManager(`subscribers`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[]): [EventManager](core.eventmanager.md) +\\+ new EventManager(`subscribers`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[]): [EventManager](core.eventmanager.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`subscribers` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[] \| +:------ \| :------ \| +`subscribers` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[] \| Returns: [EventManager](core.eventmanager.md) -Defined in: [packages/core/src/events/EventManager.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L9) +Defined in: [packages/core/src/events/EventManager.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L9) ## Properties ### entities -• `Private` `Readonly` entities: Map<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>, string[]\\> +• `Private` `Readonly` entities: Map<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>, string[]\\> -Defined in: [packages/core/src/events/EventManager.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L9) +Defined in: [packages/core/src/events/EventManager.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L9) ___ ### listeners -• `Private` `Readonly` listeners: Partial<Record<[EventType](../enums/core.eventtype.md), [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[]\\>\\> +• `Private` `Readonly` listeners: Partial<Record<[EventType](../enums/core.eventtype.md), [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>[]\\>\\> -Defined in: [packages/core/src/events/EventManager.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L8) +Defined in: [packages/core/src/events/EventManager.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L8) ## Methods @@ -54,73 +51,73 @@ Defined in: [packages/core/src/events/EventManager.ts:8](https://github.com/mikr #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| [TransactionEventType](../modules/core.md#transactioneventtype) \| `args` \| [TransactionEventArgs](../interfaces/core.transactioneventargs.md) \| Returns: unknown -Defined in: [packages/core/src/events/EventManager.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L25) +Defined in: [packages/core/src/events/EventManager.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L25) ▸ dispatchEvent<T\\>(`event`: [onInit](../enums/core.eventtype.md#oninit), `args`: Partial<[EventArgs](../interfaces/core.eventargs.md)<T\\>\\>): unknown #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| [onInit](../enums/core.eventtype.md#oninit) \| `args` \| Partial<[EventArgs](../interfaces/core.eventargs.md)<T\\>\\> \| Returns: unknown -Defined in: [packages/core/src/events/EventManager.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L26) +Defined in: [packages/core/src/events/EventManager.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L26) -▸ dispatchEvent<T\\>(`event`: [EventType](../enums/core.eventtype.md), `args`: Partial<[FlushEventArgs](../interfaces/core.flusheventargs.md)\\> \\\| Partial<[EventArgs](../interfaces/core.eventargs.md)<T\\>\\>): Promise<unknown\\> +▸ dispatchEvent<T\\>(`event`: [EventType](../enums/core.eventtype.md), `args`: Partial<[FlushEventArgs](../interfaces/core.flusheventargs.md) \\\| [EventArgs](../interfaces/core.eventargs.md)<T\\>\\>): Promise<unknown\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| [EventType](../enums/core.eventtype.md) \| -`args` \| Partial<[FlushEventArgs](../interfaces/core.flusheventargs.md)\\> \\\| Partial<[EventArgs](../interfaces/core.eventargs.md)<T\\>\\> \| +`args` \| Partial<[FlushEventArgs](../interfaces/core.flusheventargs.md) \\\| [EventArgs](../interfaces/core.eventargs.md)<T\\>\\> \| -Returns: Promise<unknown\\> +Returns: Promise<unknown\\> -Defined in: [packages/core/src/events/EventManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L27) +Defined in: [packages/core/src/events/EventManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L27) ___ ### getSubscribedEntities -▸ `Private`getSubscribedEntities(`listener`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>): string[] +▸ `Private`getSubscribedEntities(`listener`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>): string[] #### Parameters: Name \| Type \| ------- \| ------ \| -`listener` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\> \| +:------ \| :------ \| +`listener` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\> \| Returns: string[] -Defined in: [packages/core/src/events/EventManager.ts:70](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L70) +Defined in: [packages/core/src/events/EventManager.ts:70](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L70) ___ @@ -131,32 +128,32 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| [EventType](../enums/core.eventtype.md) \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: boolean -Defined in: [packages/core/src/events/EventManager.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L51) +Defined in: [packages/core/src/events/EventManager.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L51) ___ ### registerSubscriber -▸ registerSubscriber(`subscriber`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>): void +▸ registerSubscriber(`subscriber`: [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`subscriber` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\> \| +:------ \| :------ \| +`subscriber` \| [EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\> \| Returns: void -Defined in: [packages/core/src/events/EventManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventManager.ts#L15) +Defined in: [packages/core/src/events/EventManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventManager.ts#L15) diff --git a/core.exceptionconverter.md b/core.exceptionconverter.md index f2948f1..9758b6a 100644 --- a/core.exceptionconverter.md +++ b/core.exceptionconverter.md @@ -2,6 +2,7 @@ id: "core.exceptionconverter" title: "Class: ExceptionConverter" sidebar_label: "ExceptionConverter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).ExceptionConverter -## Hierarchy - -* ExceptionConverter - ## Constructors ### constructor @@ -25,14 +22,14 @@ hide_title: true ### convertException -▸ convertException(`exception`: Error & [Dictionary](../modules/core.md#dictionary)<any\\>): [DriverException](core.driverexception.md) +▸ convertException(`exception`: Error & [Dictionary](../modules/core.md#dictionary)<any\\>): [DriverException](core.driverexception.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`exception` \| Error & [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`exception` \| Error & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [DriverException](core.driverexception.md) -Defined in: [packages/core/src/platforms/ExceptionConverter.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/ExceptionConverter.ts#L7) +Defined in: [packages/core/src/platforms/ExceptionConverter.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/ExceptionConverter.ts#L7) diff --git a/core.filecacheadapter.md b/core.filecacheadapter.md index 177bce1..1eae44d 100644 --- a/core.filecacheadapter.md +++ b/core.filecacheadapter.md @@ -2,6 +2,7 @@ id: "core.filecacheadapter" title: "Class: FileCacheAdapter" sidebar_label: "FileCacheAdapter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).FileCacheAdapter -## Hierarchy - -* FileCacheAdapter - ## Implements * [CacheAdapter](../interfaces/core.cacheadapter.md) @@ -26,14 +23,15 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| { `cacheDir`: string } \| - \| +:------ \| :------ \| :------ \| +`options` \| object \| - \| +`options.cacheDir` \| string \| - \| `baseDir` \| string \| - \| `pretty` \| boolean \| false \| Returns: [FileCacheAdapter](core.filecacheadapter.md) -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L9) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L9) ## Properties @@ -41,90 +39,92 @@ Defined in: [packages/core/src/cache/FileCacheAdapter.ts:9](https://github.com/m • `Private` `Readonly` VERSION: string -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L9) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L9) ## Methods ### clear -▸ clear(): Promise<void\\> +▸ clear(): Promise<void\\> Clears all items stored in the cache. -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L51) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L51) ___ ### get -▸ get(`name`: string): Promise<any\\> +▸ get(`name`: string): Promise<any\\> Gets the items under `name` key from the cache. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<any\\> +Returns: Promise<any\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L18) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L18) ___ ### getHash -▸ `Private`getHash(`origin`: string): Promise<null \\\| string\\> +▸ `Private`getHash(`origin`: string): Promise<null \\\| string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `origin` \| string \| -Returns: Promise<null \\\| string\\> +Returns: Promise<null \\\| string\\> -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L62) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L62) ___ ### path -▸ `Private`path(`name`: string): Promise<string\\> +▸ `Private`path(`name`: string): Promise<string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L57) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L57) ___ ### set -▸ set(`name`: string, `data`: any, `origin`: string): Promise<void\\> +▸ set(`name`: string, `data`: any, `origin`: string): Promise<void\\> -`inheritdoc` +Sets the item to the cache. `origin` is used for cache invalidation and should reflect the change in data. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `data` \| any \| `origin` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> + +Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/FileCacheAdapter.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/FileCacheAdapter.ts#L38) +Defined in: [packages/core/src/cache/FileCacheAdapter.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/FileCacheAdapter.ts#L38) diff --git a/core.foreignkeyconstraintviolationexception.md b/core.foreignkeyconstraintviolationexception.md index b51251e..2b6acf9 100644 --- a/core.foreignkeyconstraintviolationexception.md +++ b/core.foreignkeyconstraintviolationexception.md @@ -2,6 +2,7 @@ id: "core.foreignkeyconstraintviolationexception" title: "Class: ForeignKeyConstraintViolationException" sidebar_label: "ForeignKeyConstraintViolationException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a foreign key constraint violation detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [ForeignKeyConstraintViolationException](core.foreignkeyconstraintviolationexception.md) Inherited from: [ConstraintViolationException](core.constraintviolationexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[code](core.constraintviolationexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errmsg](core.constraintviolationexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errno](core.constraintviolationexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[prepareStackTrace](core.constraintviolationexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlMessage](core.constraintviolationexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlState](core.constraintviolationexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[stack](core.constraintviolationexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.hydrator.md b/core.hydrator.md index 0523277..2ea0386 100644 --- a/core.hydrator.md +++ b/core.hydrator.md @@ -2,6 +2,7 @@ id: "core.hydrator" title: "Class: Hydrator" sidebar_label: "Hydrator" +custom_edit_url: null hide_title: true --- @@ -28,14 +29,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `platform` \| [Platform](core.platform.md) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/Hydrator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L8) +Defined in: [packages/core/src/hydration/Hydrator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L8) ## Properties @@ -64,19 +65,19 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `type` \| reference \\\| full \\\| returning \| Returns: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] -Defined in: [packages/core/src/hydration/Hydrator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L34) +Defined in: [packages/core/src/hydration/Hydrator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L34) ___ @@ -89,13 +90,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| @@ -106,26 +107,28 @@ Name \| Type \| Default value \| Returns: void -Defined in: [packages/core/src/hydration/Hydrator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L17) +Implementation of: void + +Defined in: [packages/core/src/hydration/Hydrator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L17) ___ ### hydrateProperty -▸ `Protected`hydrateProperty<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `factory`: [EntityFactory](core.entityfactory.md), `newEntity?`: boolean, `convertCustomTypes?`: boolean): void +▸ `Protected`hydrateProperty<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `factory`: [EntityFactory](core.entityfactory.md), `newEntity?`: boolean, `convertCustomTypes?`: boolean): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `factory` \| [EntityFactory](core.entityfactory.md) \| `newEntity?` \| boolean \| @@ -133,7 +136,7 @@ Name \| Type \| Returns: void -Defined in: [packages/core/src/hydration/Hydrator.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L47) +Defined in: [packages/core/src/hydration/Hydrator.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L47) ___ @@ -146,13 +149,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -161,4 +164,6 @@ Name \| Type \| Returns: void -Defined in: [packages/core/src/hydration/Hydrator.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L28) +Implementation of: void + +Defined in: [packages/core/src/hydration/Hydrator.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L28) diff --git a/core.identitymap.md b/core.identitymap.md index 5b82c2f..313f05a 100644 --- a/core.identitymap.md +++ b/core.identitymap.md @@ -2,6 +2,7 @@ id: "core.identitymap" title: "Class: IdentityMap" sidebar_label: "IdentityMap" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).IdentityMap -## Hierarchy - -* IdentityMap - ## Constructors ### constructor @@ -25,19 +22,19 @@ hide_title: true ### registry -• `Private` `Readonly` registry: Map<[Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, Map<string, [AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> +• `Private` `Readonly` registry: Map<[Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, Map<string, [AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L5) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L5) ## Methods ### [Symbol.iterator] -▸ [Symbol.iterator](): IterableIterator<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ [Symbol.iterator](): IterableIterator<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: IterableIterator<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: IterableIterator<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L47) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L47) ___ @@ -47,7 +44,7 @@ ___ Returns: void -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L33) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L33) ___ @@ -58,18 +55,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| Returns: void -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L11) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L11) ___ @@ -82,18 +79,18 @@ For back compatibility only. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `hash` \| string \| Returns: undefined \\\| T -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L68) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L68) ___ @@ -104,41 +101,41 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `hash` \| string \| Returns: undefined \\\| T -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L15) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L15) ___ ### getStore -▸ getStore<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>): Map<string, T\\> +▸ getStore<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>): Map<string, T\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| -Returns: Map<string, T\\> +Returns: Map<string, T\\> -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L20) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L20) ___ @@ -148,7 +145,7 @@ ___ Returns: string[] -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L55) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L55) ___ @@ -159,25 +156,25 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| Returns: void -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L7) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L7) ___ ### values -▸ values(): [AnyEntity](../modules/core.md#anyentity)<any\\>[] +▸ values(): [AnyEntity](../modules/core.md#anyentity)<any\\>[] -Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] +Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] -Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/IdentityMap.ts#L37) +Defined in: [packages/core/src/unit-of-work/IdentityMap.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/IdentityMap.ts#L37) diff --git a/core.invalidfieldnameexception.md b/core.invalidfieldnameexception.md index 6840a0f..c523cd1 100644 --- a/core.invalidfieldnameexception.md +++ b/core.invalidfieldnameexception.md @@ -2,6 +2,7 @@ id: "core.invalidfieldnameexception" title: "Class: InvalidFieldNameException" sidebar_label: "InvalidFieldNameException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for an invalid specified field name in a statement detected in the dri #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [InvalidFieldNameException](core.invalidfieldnameexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.javascriptmetadataprovider.md b/core.javascriptmetadataprovider.md index 9b49dae..fd05747 100644 --- a/core.javascriptmetadataprovider.md +++ b/core.javascriptmetadataprovider.md @@ -2,6 +2,7 @@ id: "core.javascriptmetadataprovider" title: "Class: JavaScriptMetadataProvider" sidebar_label: "JavaScriptMetadataProvider" +custom_edit_url: null hide_title: true --- @@ -26,14 +27,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [IConfiguration](../interfaces/core.iconfiguration.md) \| Returns: [JavaScriptMetadataProvider](core.javascriptmetadataprovider.md) Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L9) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L9) ## Properties @@ -47,93 +48,93 @@ Inherited from: [MetadataProvider](core.metadataprovider.md).[config](core.metad ### getSchema -▸ `Private`getSchema(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): any +▸ `Private`getSchema(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): any #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: any -Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L55) +Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L55) ___ ### initProperties -▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> +▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L23) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L23) ___ ### initProperty -▸ `Private`initProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `propName`: string): void +▸ `Private`initProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `propName`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `propName` \| string \| Returns: void -Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L43) +Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L43) ___ ### loadEntityMetadata -▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> +▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L11) +Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L11) ___ ### loadFromCache -▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void Re-hydrates missing attributes like `onUpdate` (functions are lost when caching to JSON) #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L28) +Defined in: [packages/core/src/metadata/JavaScriptMetadataProvider.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/JavaScriptMetadataProvider.ts#L28) ___ @@ -145,4 +146,4 @@ ___ Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L19) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L19) diff --git a/core.jsontype.md b/core.jsontype.md index 3c79ab5..bf6a2b7 100644 --- a/core.jsontype.md +++ b/core.jsontype.md @@ -2,6 +2,7 @@ id: "core.jsontype" title: "Class: JsonType" sidebar_label: "JsonType" +custom_edit_url: null hide_title: true --- @@ -11,7 +12,7 @@ hide_title: true ## Hierarchy -* [Type](core.type.md)<unknown, string \\\| null\\> +* [Type](core.type.md)<unknown, string \\\| null\\> ↳ JsonType @@ -38,7 +39,7 @@ Possible values: string \| number \| boolean \| date \| any \| buffer \| array Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L26) +Defined in: [packages/core/src/types/Type.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L36) ___ @@ -49,7 +50,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| unknown \| `platform` \| [Platform](core.platform.md) \| @@ -57,7 +58,28 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/JsonType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/JsonType.ts#L8) +Defined in: [packages/core/src/types/JsonType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/JsonType.ts#L8) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -68,7 +90,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| unknown \| `platform` \| [Platform](core.platform.md) \| @@ -76,26 +98,47 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/JsonType.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/JsonType.ts#L16) +Defined in: [packages/core/src/types/JsonType.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/JsonType.ts#L16) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/JsonType.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/JsonType.ts#L24) +Defined in: [packages/core/src/types/JsonType.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/JsonType.ts#L24) ___ @@ -109,7 +152,7 @@ By default uses the runtime value. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| unknown \| `platform` \| [Platform](core.platform.md) \| @@ -117,7 +160,7 @@ Name \| Type \| Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L34) +Defined in: [packages/core/src/types/Type.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L44) ___ @@ -128,18 +171,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.lockwaittimeoutexception.md b/core.lockwaittimeoutexception.md index 57588b2..468766e 100644 --- a/core.lockwaittimeoutexception.md +++ b/core.lockwaittimeoutexception.md @@ -2,6 +2,7 @@ id: "core.lockwaittimeoutexception" title: "Class: LockWaitTimeoutException" sidebar_label: "LockWaitTimeoutException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a lock wait timeout error of a transaction detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [LockWaitTimeoutException](core.lockwaittimeoutexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.logger.md b/core.logger.md index 3f28d3d..d36da04 100644 --- a/core.logger.md +++ b/core.logger.md @@ -2,6 +2,7 @@ id: "core.logger" title: "Class: Logger" sidebar_label: "Logger" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).Logger -## Hierarchy - -* Logger - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `logger` \| (`message`: string) => void \| - \| `debugMode` \| boolean \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] \| false \| Returns: [Logger](core.logger.md) -Defined in: [packages/core/src/utils/Logger.ts:3](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Logger.ts#L3) +Defined in: [packages/core/src/utils/Logger.ts:3](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Logger.ts#L3) ## Properties @@ -45,12 +42,12 @@ Defined in: [packages/core/src/utils/Logger.ts:3](https://github.com/mikro-orm/m #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `namespace` \| [LoggerNamespace](../modules/core.md#loggernamespace) \| Returns: boolean -Defined in: [packages/core/src/utils/Logger.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Logger.ts#L28) +Defined in: [packages/core/src/utils/Logger.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Logger.ts#L28) ___ @@ -63,13 +60,13 @@ Logs a message inside given namespace. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `namespace` \| [LoggerNamespace](../modules/core.md#loggernamespace) \| `message` \| string \| Returns: void -Defined in: [packages/core/src/utils/Logger.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Logger.ts#L11) +Defined in: [packages/core/src/utils/Logger.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Logger.ts#L11) ___ @@ -82,9 +79,9 @@ Sets active namespaces. Pass `true` to enable all logging. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `debugMode` \| boolean \\\| [LoggerNamespace](../modules/core.md#loggernamespace)[] \| Returns: void -Defined in: [packages/core/src/utils/Logger.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Logger.ts#L24) +Defined in: [packages/core/src/utils/Logger.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Logger.ts#L24) diff --git a/core.memorycacheadapter.md b/core.memorycacheadapter.md index ab2e8f1..8feb6a6 100644 --- a/core.memorycacheadapter.md +++ b/core.memorycacheadapter.md @@ -2,6 +2,7 @@ id: "core.memorycacheadapter" title: "Class: MemoryCacheAdapter" sidebar_label: "MemoryCacheAdapter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).MemoryCacheAdapter -## Hierarchy - -* MemoryCacheAdapter - ## Implements * [CacheAdapter](../interfaces/core.cacheadapter.md) @@ -26,80 +23,75 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| -`options` \| { `expiration`: number } \| +:------ \| :------ \| +`options` \| object \| +`options.expiration` \| number \| Returns: [MemoryCacheAdapter](core.memorycacheadapter.md) -Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/MemoryCacheAdapter.ts#L5) +Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/MemoryCacheAdapter.ts#L5) ## Properties ### data -• `Private` `Readonly` data: Map<string, { `data`: any ; `expiration`: number }\\> +• `Private` `Readonly` data: Map<string, { `data`: any ; `expiration`: number }\\> -Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/MemoryCacheAdapter.ts#L5) +Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/MemoryCacheAdapter.ts#L5) ## Methods ### clear -▸ clear(): Promise<void\\> +▸ clear(): Promise<void\\> Clears all items stored in the cache. -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/MemoryCacheAdapter.ts#L36) +Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/MemoryCacheAdapter.ts#L36) ___ ### get -▸ get<T\\>(`name`: string): Promise<undefined \\\| T\\> +▸ get(`name`: string): Promise<undefined \\\| T\\> Gets the items under `name` key from the cache. -#### Type parameters: - -Name \| Default \| ------- \| ------ \| -`T` \| any \| - #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<undefined \\\| T\\> +Returns: Promise<undefined \\\| T\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/MemoryCacheAdapter.ts#L12) +Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/MemoryCacheAdapter.ts#L12) ___ ### set -▸ set(`name`: string, `data`: any, `origin`: string, `expiration?`: number): Promise<void\\> +▸ set(`name`: string, `data`: any, `origin`: string, `expiration?`: number): Promise<void\\> Sets the item to the cache. `origin` is used for cache invalidation and should reflect the change in data. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `data` \| any \| `origin` \| string \| `expiration?` \| number \| -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/MemoryCacheAdapter.ts#L29) +Defined in: [packages/core/src/cache/MemoryCacheAdapter.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/MemoryCacheAdapter.ts#L29) diff --git a/core.metadatadiscovery.md b/core.metadatadiscovery.md index 0e4c2d8..d07c1e3 100644 --- a/core.metadatadiscovery.md +++ b/core.metadatadiscovery.md @@ -2,6 +2,7 @@ id: "core.metadatadiscovery" title: "Class: MetadataDiscovery" sidebar_label: "MetadataDiscovery" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).MetadataDiscovery -## Hierarchy - -* MetadataDiscovery - ## Constructors ### constructor @@ -22,14 +19,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `platform` \| [Platform](core.platform.md) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [MetadataDiscovery](core.metadatadiscovery.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L24) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L24) ## Properties @@ -37,15 +34,15 @@ Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:24](https://github. • `Private` `Readonly` cache: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L20) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L20) ___ ### discovered -• `Private` `Readonly` discovered: [EntityMetadata](core.entitymetadata.md)<any\\>[] +• `Private` `Readonly` discovered: [EntityMetadata](core.entitymetadata.md)<any\\>[] -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L24) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L24) ___ @@ -53,7 +50,7 @@ ___ • `Private` `Readonly` logger: [Logger](core.logger.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L21) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L21) ___ @@ -61,7 +58,7 @@ ___ • `Private` `Readonly` metadataProvider: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L19) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L19) ___ @@ -69,15 +66,15 @@ ___ • `Private` `Readonly` namingStrategy: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L18) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L18) ___ ### schemaHelper -• `Private` `Readonly` schemaHelper: undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } +• `Private` `Readonly` schemaHelper: undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L22) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L22) ___ @@ -85,125 +82,125 @@ ___ • `Private` `Readonly` validator: [MetadataValidator](core.metadatavalidator.md) -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L23) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L23) ## Methods ### applyNamingStrategy -▸ `Private`applyNamingStrategy(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`applyNamingStrategy(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:250](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L250) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:250](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L250) ___ ### autoWireBidirectionalProperties -▸ `Private`autoWireBidirectionalProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`autoWireBidirectionalProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:505](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L505) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:507](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L507) ___ ### createDiscriminatorProperty -▸ `Private`createDiscriminatorProperty(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`createDiscriminatorProperty(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:663](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L663) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:676](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L676) ___ ### defineBaseEntityProperties -▸ `Private`defineBaseEntityProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): number +▸ `Private`defineBaseEntityProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): number #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: number -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:518](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L518) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:520](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L520) ___ ### defineFixedOrderProperty -▸ `Private`defineFixedOrderProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +▸ `Private`defineFixedOrderProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:440](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L440) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:442](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L442) ___ ### definePivotProperty -▸ `Private`definePivotProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string, `type`: string, `inverse`: string, `owner`: boolean): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +▸ `Private`definePivotProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string, `type`: string, `inverse`: string, `owner`: boolean): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `name` \| string \| `type` \| string \| `inverse` \| string \| `owner` \| boolean \| -Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:463](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L463) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:465](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L465) ___ ### definePivotTableEntity -▸ `Private`definePivotTableEntity(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> +▸ `Private`definePivotTableEntity(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [EntityMetadata](core.entitymetadata.md)<any\\> +Returns: [EntityMetadata](core.entitymetadata.md)<any\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:405](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L405) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:407](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L407) ___ @@ -214,99 +211,99 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `preferTsNode` \| boolean \| true \| Returns: Promise<[MetadataStorage](core.metadatastorage.md)\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L30) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L30) ___ ### discoverDirectories -▸ `Private`discoverDirectories(`paths`: string[]): Promise<void\\> +▸ `Private`discoverDirectories(`paths`: string[]): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `paths` \| string[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L99) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L99) ___ ### discoverEntity -▸ `Private`discoverEntity<T\\>(`entity`: EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>, `path?`: string): Promise<void\\> +▸ `Private`discoverEntity<T\\>(`entity`: EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>, `path?`: string): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| +:------ \| :------ \| +`entity` \| EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| `path?` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:202](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L202) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:202](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L202) ___ ### discoverReferences -▸ `Private`discoverReferences(`refs`: [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]): Promise<void\\> +▸ `Private`discoverReferences(`refs`: [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`refs` \| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| +:------ \| :------ \| +`refs` \| [Constructor](../modules/core.md#constructor)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:148](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L148) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:148](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L148) ___ ### findEntities -▸ `Private`findEntities(`preferTsNode`: boolean): Promise<[EntityMetadata](core.entitymetadata.md)<any\\>[]\\> +▸ `Private`findEntities(`preferTsNode`: boolean): Promise<[EntityMetadata](core.entitymetadata.md)<any\\>[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `preferTsNode` \| boolean \| -Returns: Promise<[EntityMetadata](core.entitymetadata.md)<any\\>[]\\> +Returns: Promise<[EntityMetadata](core.entitymetadata.md)<any\\>[]\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L68) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L68) ___ ### getDefaultVersionValue -▸ `Private`getDefaultVersionValue(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string +▸ `Private`getDefaultVersionValue(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: string -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:673](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L673) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:686](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L686) ___ @@ -317,119 +314,120 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| `name` \| string \| Returns: any[] -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:822](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L822) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:840](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L840) ___ ### getSchema -▸ `Private`getSchema<T\\>(`entity`: [Constructor](../modules/core.md#constructor)<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>): [EntitySchema](core.entityschema.md)<T, undefined\\> +▸ `Private`getSchema<T\\>(`entity`: [Constructor](../modules/core.md#constructor)<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>): [EntitySchema](core.entityschema.md)<T, undefined\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [Constructor](../modules/core.md#constructor)<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| +:------ \| :------ \| +`entity` \| [Constructor](../modules/core.md#constructor)<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| -Returns: [EntitySchema](core.entityschema.md)<T, undefined\\> +Returns: [EntitySchema](core.entityschema.md)<T, undefined\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:179](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L179) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:179](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L179) ___ ### initColumnType -▸ `Private`initColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `path?`: string): void +▸ `Private`initColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `path?`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `path?` \| string \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:755](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L755) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:773](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L773) ___ ### initCustomType -▸ `Private`initCustomType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initCustomType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:709](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L709) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:722](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L722) ___ ### initDefaultValue -▸ `Private`initDefaultValue(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initDefaultValue(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:686](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L686) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:699](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L699) ___ ### initEmbeddables -▸ `Private`initEmbeddables(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `embeddedProp`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `visited?`: WeakSet<[EntityProperty](../interfaces/core.entityproperty.md)<any\\>\\>): void +▸ `Private`initEmbeddables(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `embeddedProp`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `visited?`: WeakSet<[EntityProperty](../interfaces/core.entityproperty.md)<any\\>\\>): void #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| - \| -`embeddedProp` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| -`visited` \| WeakSet<[EntityProperty](../interfaces/core.entityproperty.md)<any\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`embeddedProp` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`visited` \| WeakSet<[EntityProperty](../interfaces/core.entityproperty.md)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:558](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L558) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:560](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L560) ___ ### initEnumValues -▸ `Private`initEnumValues(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `path`: string): void +▸ `Private`initEnumValues(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `path`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `path` \| string \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:793](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L793) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:811](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L811) ___ @@ -440,243 +438,243 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:394](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L394) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:396](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L396) ___ ### initFieldName -▸ `Private`initFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:268](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L268) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:268](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L268) ___ ### initManyToManyFieldName -▸ `Private`initManyToManyFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string): string[] +▸ `Private`initManyToManyFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string): string[] #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `name` \| string \| Returns: string[] -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:297](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L297) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:297](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L297) ___ ### initManyToManyFields -▸ `Private`initManyToManyFields(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initManyToManyFields(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:302](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L302) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:302](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L302) ___ ### initManyToOneFieldName -▸ `Private`initManyToOneFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string): string[] +▸ `Private`initManyToOneFieldName(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `name`: string): string[] #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `name` \| string \| Returns: string[] -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:282](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L282) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:282](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L282) ___ ### initManyToOneFields -▸ `Private`initManyToOneFields(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initManyToOneFields(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:332](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L332) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:334](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L334) ___ ### initOneToManyFields -▸ `Private`initOneToManyFields(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initOneToManyFields(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:346](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L346) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:348](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L348) ___ ### initRelation -▸ `Private`initRelation(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initRelation(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:745](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L745) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:763](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L763) ___ ### initSingleTableInheritance -▸ `Private`initSingleTableInheritance(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `metadata`: [EntityMetadata](core.entitymetadata.md)<any\\>[]): void +▸ `Private`initSingleTableInheritance(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `metadata`: [EntityMetadata](core.entitymetadata.md)<any\\>[]): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`metadata` \| [EntityMetadata](core.entitymetadata.md)<any\\>[] \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`metadata` \| [EntityMetadata](core.entitymetadata.md)<any\\>[] \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:613](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L613) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:626](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L626) ___ ### initUnsigned -▸ `Private`initUnsigned(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initUnsigned(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:807](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L807) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:825](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L825) ___ ### initVersionProperty -▸ `Private`initVersionProperty(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Private`initVersionProperty(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:700](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L700) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:713](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L713) ___ ### prepare -▸ `Private`prepare<T\\>(`entity`: EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>): EntityClass<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> +▸ `Private`prepare<T\\>(`entity`: EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\>): EntityClass<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| +:------ \| :------ \| +`entity` \| EntityClass<T\\> \\\| EntityClassGroup<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> \| -Returns: EntityClass<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> +Returns: EntityClass<T\\> \\\| [EntitySchema](core.entityschema.md)<T, undefined\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:163](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L163) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:163](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L163) ___ ### processEntity -▸ `Private`processEntity(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\>[] +▸ `Private`processEntity(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\>[] #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [EntityMetadata](core.entitymetadata.md)<any\\>[] +Returns: [EntityMetadata](core.entitymetadata.md)<any\\>[] -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:359](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L359) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:361](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L361) ___ ### saveToCache -▸ `Private`saveToCache<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): Promise<void\\> +▸ `Private`saveToCache<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:236](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L236) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:236](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L236) ___ @@ -687,15 +685,15 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: boolean -Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:853](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataDiscovery.ts#L853) +Defined in: [packages/core/src/metadata/MetadataDiscovery.ts:871](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataDiscovery.ts#L871) diff --git a/core.metadataprovider.md b/core.metadataprovider.md index ee122a9..9829214 100644 --- a/core.metadataprovider.md +++ b/core.metadataprovider.md @@ -2,6 +2,7 @@ id: "core.metadataprovider" title: "Class: MetadataProvider" sidebar_label: "MetadataProvider" +custom_edit_url: null hide_title: true --- @@ -28,12 +29,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [IConfiguration](../interfaces/core.iconfiguration.md) \| Returns: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L9) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L9) ## Properties @@ -45,52 +46,52 @@ Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.co ### initProperties -▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> +▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L23) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L23) ___ ### loadEntityMetadata -▸ `Abstract`loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> +▸ `Abstract`loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/metadata/MetadataProvider.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L13) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L13) ___ ### loadFromCache -▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataProvider.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L15) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L15) ___ @@ -100,4 +101,4 @@ ___ Returns: boolean -Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L19) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L19) diff --git a/core.metadatastorage.md b/core.metadatastorage.md index 45cb456..b36eb67 100644 --- a/core.metadatastorage.md +++ b/core.metadatastorage.md @@ -2,6 +2,7 @@ id: "core.metadatastorage" title: "Class: MetadataStorage" sidebar_label: "MetadataStorage" +custom_edit_url: null hide_title: true --- @@ -9,49 +10,45 @@ hide_title: true [core](../modules/core.md).MetadataStorage -## Hierarchy - -* MetadataStorage - ## Constructors ### constructor -\\+ new MetadataStorage(`metadata?`: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\>): [MetadataStorage](core.metadatastorage.md) +\\+ new MetadataStorage(`metadata?`: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\>): [MetadataStorage](core.metadatastorage.md) #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`metadata` \| [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`metadata` \| [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> \| Returns: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/metadata/MetadataStorage.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L12) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L12) ## Properties ### metadata -• `Private` `Readonly` metadata: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +• `Private` `Readonly` metadata: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L12) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L12) ___ ### metadata -▪ `Private` `Readonly` `Static` metadata: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +▪ `Private` `Readonly` `Static` metadata: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L10) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L10) ___ ### subscribers -▪ `Private` `Readonly` `Static` subscribers: [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> +▪ `Private` `Readonly` `Static` subscribers: [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L11) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L11) ## Methods @@ -62,12 +59,12 @@ Defined in: [packages/core/src/metadata/MetadataStorage.ts:11](https://github.co #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataStorage.ts:103](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L103) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:103](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L103) ___ @@ -78,18 +75,18 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \| Returns: undefined \\\| [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L87) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L87) ___ @@ -100,30 +97,30 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| string \| - \| `init` \| boolean \| false \| `validate` \| boolean \| true \| Returns: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L75) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:75](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L75) ___ ### getAll -▸ getAll(): [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +▸ getAll(): [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Returns: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +Returns: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L59) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L59) ___ @@ -134,19 +131,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: undefined \\\| [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L63) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L63) ___ @@ -157,12 +154,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \| Returns: boolean -Defined in: [packages/core/src/metadata/MetadataStorage.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L91) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L91) ___ @@ -173,29 +170,29 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \| Returns: void -Defined in: [packages/core/src/metadata/MetadataStorage.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L99) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L99) ___ ### set -▸ set(`entity`: string, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> +▸ set(`entity`: string, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [EntityMetadata](core.entitymetadata.md)<any\\> +Returns: [EntityMetadata](core.entitymetadata.md)<any\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:95](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L95) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L95) ___ @@ -205,68 +202,68 @@ ___ Returns: void -Defined in: [packages/core/src/metadata/MetadataStorage.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L54) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L54) ___ ### getMetadata -▸ `Static`getMetadata(): [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +▸ `Static`getMetadata(): [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Returns: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> +Returns: [Dictionary](../modules/core.md#dictionary)<[EntityMetadata](core.entitymetadata.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L18) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L18) ▸ `Static`getMetadata<T\\>(`entity`: string, `path`: string): [EntityMetadata](core.entitymetadata.md)<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \| `path` \| string \| Returns: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L19) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L19) ___ ### getMetadataFromDecorator -▸ `Static`getMetadataFromDecorator<T\\>(`target`: T & [Dictionary](../modules/core.md#dictionary)<any\\>): [EntityMetadata](core.entitymetadata.md)<T\\> +▸ `Static`getMetadataFromDecorator<T\\>(`target`: T & [Dictionary](../modules/core.md#dictionary)<any\\>): [EntityMetadata](core.entitymetadata.md)<T\\> #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| -`target` \| T & [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`target` \| T & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [EntityMetadata](core.entitymetadata.md)<T\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L38) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L38) ___ ### getSubscriberMetadata -▸ `Static`getSubscriberMetadata(): [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> +▸ `Static`getSubscriberMetadata(): [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> -Returns: [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> +Returns: [Dictionary](../modules/core.md#dictionary)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\> -Defined in: [packages/core/src/metadata/MetadataStorage.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L46) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L46) ___ @@ -276,7 +273,7 @@ ___ Returns: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/metadata/MetadataStorage.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L50) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L50) ___ @@ -287,9 +284,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: boolean -Defined in: [packages/core/src/metadata/MetadataStorage.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataStorage.ts#L34) +Defined in: [packages/core/src/metadata/MetadataStorage.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataStorage.ts#L34) diff --git a/core.metadatavalidator.md b/core.metadatavalidator.md index bee3e15..f691b0f 100644 --- a/core.metadatavalidator.md +++ b/core.metadatavalidator.md @@ -2,6 +2,7 @@ id: "core.metadatavalidator" title: "Class: MetadataValidator" sidebar_label: "MetadataValidator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).MetadataValidator -## Hierarchy - -* MetadataValidator - ## Constructors ### constructor @@ -25,36 +22,36 @@ hide_title: true ### validateBidirectional -▸ `Private`validateBidirectional(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void +▸ `Private`validateBidirectional(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L75) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:75](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L75) ___ ### validateDiscovered -▸ validateDiscovered(`discovered`: [EntityMetadata](core.entitymetadata.md)<any\\>[], `warnWhenNoEntities`: boolean): void +▸ validateDiscovered(`discovered`: [EntityMetadata](core.entitymetadata.md)<any\\>[], `warnWhenNoEntities`: boolean): void #### Parameters: Name \| Type \| ------- \| ------ \| -`discovered` \| [EntityMetadata](core.entitymetadata.md)<any\\>[] \| +:------ \| :------ \| +`discovered` \| [EntityMetadata](core.entitymetadata.md)<any\\>[] \| `warnWhenNoEntities` \| boolean \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L39) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L39) ___ @@ -65,109 +62,109 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `name` \| string \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L20) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L20) ___ ### validateIndexes -▸ `Private`validateIndexes(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `indexes`: { `properties`: string \\\| string[] }[], `type`: index \\\| unique): void +▸ `Private`validateIndexes(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `indexes`: { `properties`: string \\\| string[] }[], `type`: index \\\| unique): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `indexes` \| { `properties`: string \\\| string[] }[] \| `type` \| index \\\| unique \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L122) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:133](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L133) ___ ### validateInverseSide -▸ `Private`validateInverseSide(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owner`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void +▸ `Private`validateInverseSide(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owner`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -`owner` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`owner` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L105) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L105) ___ ### validateOwningSide -▸ `Private`validateOwningSide(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `inverse`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void +▸ `Private`validateOwningSide(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `inverse`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -`inverse` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`inverse` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L85) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L85) ___ ### validateReference -▸ `Private`validateReference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void +▸ `Private`validateReference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `metadata`: [MetadataStorage](core.metadatastorage.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L63) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L63) ___ ### validateVersionField -▸ `Private`validateVersionField(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`validateVersionField(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L132) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L143) ___ ### validateSingleDecorator -▸ `Static`validateSingleDecorator(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `propertyName`: string, `reference`: [ReferenceType](../enums/core.referencetype.md)): void +▸ `Static`validateSingleDecorator(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `propertyName`: string, `reference`: [ReferenceType](../enums/core.referencetype.md)): void Validate there is only one property decorator. This disallows using `@Property()` together with e.g. `@ManyToOne()` on the same property. One should use only `@ManyToOne()` in such case. @@ -176,11 +173,11 @@ We allow the existence of the property in metadata if the reference type is the #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `propertyName` \| string \| `reference` \| [ReferenceType](../enums/core.referencetype.md) \| Returns: void -Defined in: [packages/core/src/metadata/MetadataValidator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataValidator.ts#L14) +Defined in: [packages/core/src/metadata/MetadataValidator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataValidator.ts#L14) diff --git a/core.mikroorm.md b/core.mikroorm.md index e069bcb..743b84c 100644 --- a/core.mikroorm.md +++ b/core.mikroorm.md @@ -2,6 +2,7 @@ id: "core.mikroorm" title: "Class: MikroORM<D>" sidebar_label: "MikroORM" +custom_edit_url: null hide_title: true --- @@ -14,13 +15,9 @@ Helper class for bootstrapping the MikroORM. ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| -## Hierarchy - -* MikroORM - ## Constructors ### constructor @@ -30,18 +27,18 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| [Options](../modules/core.md#options)<D\\> \\\| [Configuration](core.configuration.md)<D\\> \| Returns: [MikroORM](core.mikroorm.md)<D\\> -Defined in: [packages/core/src/MikroORM.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L47) +Defined in: [packages/core/src/MikroORM.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L50) ## Properties @@ -49,7 +46,7 @@ Defined in: [packages/core/src/MikroORM.ts:47](https://github.com/mikro-orm/mikr • `Readonly` config: [Configuration](core.configuration.md)<D\\> -Defined in: [packages/core/src/MikroORM.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L16) +Defined in: [packages/core/src/MikroORM.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L16) ___ @@ -57,7 +54,7 @@ ___ • `Private` `Readonly` driver: D -Defined in: [packages/core/src/MikroORM.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L18) +Defined in: [packages/core/src/MikroORM.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L18) ___ @@ -65,7 +62,7 @@ ___ • em: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)] & [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/MikroORM.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L15) +Defined in: [packages/core/src/MikroORM.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L15) ___ @@ -73,7 +70,7 @@ ___ • `Private` `Readonly` logger: [Logger](core.logger.md) -Defined in: [packages/core/src/MikroORM.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L19) +Defined in: [packages/core/src/MikroORM.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L19) ___ @@ -81,25 +78,25 @@ ___ • `Private` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/MikroORM.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L17) +Defined in: [packages/core/src/MikroORM.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L17) ## Methods ### close -▸ close(`force?`: boolean): Promise<void\\> +▸ close(`force?`: boolean): Promise<void\\> Closes the database connection. #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `force` \| boolean \| false \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/MikroORM.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L94) +Defined in: [packages/core/src/MikroORM.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L97) ___ @@ -111,7 +108,7 @@ Connects to the database. Returns: Promise<D\\> -Defined in: [packages/core/src/MikroORM.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L69) +Defined in: [packages/core/src/MikroORM.ts:72](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L72) ___ @@ -124,12 +121,12 @@ Gets the EntityGenerator. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| IEntityGenerator \| IEntityGenerator \| Returns: T -Defined in: [packages/core/src/MikroORM.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L115) +Defined in: [packages/core/src/MikroORM.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L118) ___ @@ -141,7 +138,7 @@ Gets the MetadataStorage. Returns: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/MikroORM.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L101) +Defined in: [packages/core/src/MikroORM.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L104) ___ @@ -154,12 +151,12 @@ Gets the Migrator. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| IMigrator \| IMigrator \| Returns: T -Defined in: [packages/core/src/MikroORM.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L124) +Defined in: [packages/core/src/MikroORM.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L127) ___ @@ -172,24 +169,24 @@ Gets the SchemaGenerator. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| ISchemaGenerator \| ISchemaGenerator \| Returns: T -Defined in: [packages/core/src/MikroORM.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L108) +Defined in: [packages/core/src/MikroORM.ts:111](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L111) ___ ### isConnected -▸ isConnected(): Promise<boolean\\> +▸ isConnected(): Promise<boolean\\> Checks whether the database connection is active. -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: [packages/core/src/MikroORM.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L87) +Defined in: [packages/core/src/MikroORM.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L90) ___ @@ -203,16 +200,16 @@ If you omit the `options` parameter, your CLI config will be used. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `options?` \| [Options](../modules/core.md#options)<D\\> \\\| [Configuration](core.configuration.md)<D\\> \| - \| `connect` \| boolean \| true \| Returns: Promise<[MikroORM](core.mikroorm.md)<D\\>\\> -Defined in: [packages/core/src/MikroORM.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/MikroORM.ts#L25) +Defined in: [packages/core/src/MikroORM.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/MikroORM.ts#L25) diff --git a/core.mongonamingstrategy.md b/core.mongonamingstrategy.md index c68bc8f..352b1ec 100644 --- a/core.mongonamingstrategy.md +++ b/core.mongonamingstrategy.md @@ -2,6 +2,7 @@ id: "core.mongonamingstrategy" title: "Class: MongoNamingStrategy" sidebar_label: "MongoNamingStrategy" +custom_edit_url: null hide_title: true --- @@ -34,14 +35,14 @@ Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `timestamp` \| string \| Returns: string Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) ___ @@ -52,14 +53,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L5) ___ @@ -70,7 +71,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `file` \| string \| - \| `separator` \| string \| '-' \| @@ -78,7 +79,7 @@ Name \| Type \| Default value \| Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) ___ @@ -89,14 +90,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L9) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L9) ___ @@ -107,7 +108,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `referencedColumnName?` \| string \| @@ -115,7 +116,7 @@ Name \| Type \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L13) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L13) ___ @@ -126,7 +127,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sourceEntity` \| string \| `targetEntity` \| string \| `propertyName` \| string \| @@ -135,7 +136,7 @@ Name \| Type \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L17) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L17) ___ @@ -146,14 +147,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L21) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L21) ___ @@ -165,4 +166,4 @@ ___ Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L25) +Defined in: [packages/core/src/naming-strategy/MongoNamingStrategy.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/MongoNamingStrategy.ts#L25) diff --git a/core.nonuniquefieldnameexception.md b/core.nonuniquefieldnameexception.md index 1f135fe..ae6aa04 100644 --- a/core.nonuniquefieldnameexception.md +++ b/core.nonuniquefieldnameexception.md @@ -2,6 +2,7 @@ id: "core.nonuniquefieldnameexception" title: "Class: NonUniqueFieldNameException" sidebar_label: "NonUniqueFieldNameException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a non-unique/ambiguous specified field name in a statement detecte #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [NonUniqueFieldNameException](core.nonuniquefieldnameexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.notfounderror.md b/core.notfounderror.md index 700affd..352da13 100644 --- a/core.notfounderror.md +++ b/core.notfounderror.md @@ -2,6 +2,7 @@ id: "core.notfounderror" title: "Class: NotFoundError<T>" sidebar_label: "NotFoundError" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity) \| [AnyEntity](../modules/core.md#anyentity) \| ## Hierarchy @@ -30,13 +31,13 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `message` \| string \| `entity?` \| T \| @@ -44,7 +45,7 @@ Name \| Type \| Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L4) +Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L4) ## Properties @@ -70,11 +71,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ValidationError](core.validationerror.md).[prepareStackTrace](core.validationerror.md#preparestacktrace) @@ -84,7 +100,7 @@ ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ValidationError](core.validationerror.md).[stack](core.validationerror.md#stack) @@ -111,7 +127,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| @@ -125,285 +141,304 @@ ___ ### getEntity -▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> Gets instance of entity that caused this error. -Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L17) ___ ### cannotCommit -▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L92) +Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L96) ___ ### cannotModifyInverseCollection -▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L79) + +___ + +### cannotModifyReadonlyCollection + +▸ `Static`cannotModifyReadonlyCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L79) +Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L88) ___ ### cannotUseOperatorsInsideEmbeddables -▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L96) +Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L100) ___ ### entityNotManaged -▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L43) +Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L43) ___ ### findOneFailed -▸ `Static`findOneFailed(`name`: string, `where`: string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Dictionary](../modules/core.md#dictionary)<any\\>): [NotFoundError](core.notfounderror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`findOneFailed(`name`: string, `where`: IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\>): [NotFoundError](core.notfounderror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`where` \| string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`where` \| IPrimaryKeyValue \\\| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: [NotFoundError](core.notfounderror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [NotFoundError](core.notfounderror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L211) +Defined in: [packages/core/src/errors.ts:219](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L219) ___ ### fromCollectionNotInitialized -▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L28) ___ ### fromMergeWithoutPK -▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L35) +Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L35) ___ ### fromWrongPropertyType -▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `property` \| string \| `expectedType` \| string \| `givenType` \| string \| `givenValue` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L21) +Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L21) ___ ### invalidCompositeIdentifier -▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L88) +Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L92) ___ ### invalidEmbeddableQuery -▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| `embeddableType` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L100) +Defined in: [packages/core/src/errors.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L104) ___ ### invalidPropertyName -▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `invalid` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L65) +Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L65) ___ ### invalidType -▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| +:------ \| :------ \| +`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| `value` \| any \| `mode` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L69) +Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L69) ___ ### notDiscoveredEntity -▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| -`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L52) +Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L52) ___ ### notEntity -▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `data` \| any \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L47) +Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L47) ___ ### transactionRequired -▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L39) +Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L39) diff --git a/core.notnullconstraintviolationexception.md b/core.notnullconstraintviolationexception.md index 57b5ba6..5e9e9ce 100644 --- a/core.notnullconstraintviolationexception.md +++ b/core.notnullconstraintviolationexception.md @@ -2,6 +2,7 @@ id: "core.notnullconstraintviolationexception" title: "Class: NotNullConstraintViolationException" sidebar_label: "NotNullConstraintViolationException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a NOT NULL constraint violation detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [NotNullConstraintViolationException](core.notnullconstraintviolationexception.md) Inherited from: [ConstraintViolationException](core.constraintviolationexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[code](core.constraintviolationexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errmsg](core.constraintviolationexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errno](core.constraintviolationexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[prepareStackTrace](core.constraintviolationexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlMessage](core.constraintviolationexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlState](core.constraintviolationexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[stack](core.constraintviolationexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.nullcacheadapter.md b/core.nullcacheadapter.md index 89a2074..654c552 100644 --- a/core.nullcacheadapter.md +++ b/core.nullcacheadapter.md @@ -2,6 +2,7 @@ id: "core.nullcacheadapter" title: "Class: NullCacheAdapter" sidebar_label: "NullCacheAdapter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).NullCacheAdapter -## Hierarchy - -* NullCacheAdapter - ## Implements * [CacheAdapter](../interfaces/core.cacheadapter.md) @@ -29,52 +26,54 @@ hide_title: true ### clear -▸ clear(): Promise<void\\> +▸ clear(): Promise<void\\> Clears all items stored in the cache. -Returns: Promise<void\\> +Returns: Promise<void\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/NullCacheAdapter.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/NullCacheAdapter.ts#L22) +Defined in: [packages/core/src/cache/NullCacheAdapter.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/NullCacheAdapter.ts#L22) ___ ### get -▸ get(`name`: string): Promise<any\\> +▸ get(`name`: string): Promise<any\\> Gets the items under `name` key from the cache. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<any\\> +Returns: Promise<any\\> Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/NullCacheAdapter.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/NullCacheAdapter.ts#L8) +Defined in: [packages/core/src/cache/NullCacheAdapter.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/NullCacheAdapter.ts#L8) ___ ### set -▸ set(`name`: string, `data`: any, `origin`: string): Promise<void\\> +▸ set(`name`: string, `data`: any, `origin`: string): Promise<void\\> -`inheritdoc` +Sets the item to the cache. `origin` is used for cache invalidation and should reflect the change in data. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `data` \| any \| `origin` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> + +Implementation of: [CacheAdapter](../interfaces/core.cacheadapter.md) -Defined in: [packages/core/src/cache/NullCacheAdapter.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/NullCacheAdapter.ts#L15) +Defined in: [packages/core/src/cache/NullCacheAdapter.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/NullCacheAdapter.ts#L15) diff --git a/core.nullhighlighter.md b/core.nullhighlighter.md index dcc032d..de6687b 100644 --- a/core.nullhighlighter.md +++ b/core.nullhighlighter.md @@ -2,6 +2,7 @@ id: "core.nullhighlighter" title: "Class: NullHighlighter" sidebar_label: "NullHighlighter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).NullHighlighter -## Hierarchy - -* NullHighlighter - ## Implements * [Highlighter](../interfaces/core.highlighter.md) @@ -34,11 +31,11 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `text` \| string \| Returns: string Implementation of: [Highlighter](../interfaces/core.highlighter.md) -Defined in: [packages/core/src/utils/NullHighlighter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/NullHighlighter.ts#L5) +Defined in: [packages/core/src/utils/NullHighlighter.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/NullHighlighter.ts#L5) diff --git a/core.objecthydrator.md b/core.objecthydrator.md index e11c741..6b823a1 100644 --- a/core.objecthydrator.md +++ b/core.objecthydrator.md @@ -2,6 +2,7 @@ id: "core.objecthydrator" title: "Class: ObjectHydrator" sidebar_label: "ObjectHydrator" +custom_edit_url: null hide_title: true --- @@ -24,7 +25,7 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `platform` \| [Platform](core.platform.md) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| @@ -33,7 +34,7 @@ Name \| Type \| Inherited from: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/Hydrator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L8) +Defined in: [packages/core/src/hydration/Hydrator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L8) ## Properties @@ -47,17 +48,17 @@ ___ ### hydrators -• `Private` `Readonly` hydrators: { `full`: Map<string, EntityHydrator<any\\>\\> ; `reference`: Map<string, EntityHydrator<any\\>\\> ; `returning`: Map<string, EntityHydrator<any\\>\\> } +• `Private` `Readonly` hydrators: object #### Type declaration: Name \| Type \| ------- \| ------ \| -`full` \| Map<string, EntityHydrator<any\\>\\> \| -`reference` \| Map<string, EntityHydrator<any\\>\\> \| -`returning` \| Map<string, EntityHydrator<any\\>\\> \| +:------ \| :------ \| +`full` \| Map<string, EntityHydrator<any\\>\\> \| +`reference` \| Map<string, EntityHydrator<any\\>\\> \| +`returning` \| Map<string, EntityHydrator<any\\>\\> \| -Defined in: [packages/core/src/hydration/ObjectHydrator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/ObjectHydrator.ts#L13) +Defined in: [packages/core/src/hydration/ObjectHydrator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/ObjectHydrator.ts#L13) ___ @@ -79,23 +80,23 @@ Inherited from: [Hydrator](core.hydrator.md).[platform](core.hydrator.md#platfor ### createCollectionItemMapper -▸ `Private`createCollectionItemMapper<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string[] +▸ `Private`createCollectionItemMapper<T\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string[] #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: string[] -Defined in: [packages/core/src/hydration/ObjectHydrator.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/ObjectHydrator.ts#L211) +Defined in: [packages/core/src/hydration/ObjectHydrator.ts:263](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/ObjectHydrator.ts#L263) ___ @@ -108,19 +109,19 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `type` \| reference \\\| full \\\| returning \| Returns: EntityHydrator<T\\> -Defined in: [packages/core/src/hydration/ObjectHydrator.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/ObjectHydrator.ts#L38) +Defined in: [packages/core/src/hydration/ObjectHydrator.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/ObjectHydrator.ts#L38) ___ @@ -131,13 +132,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `type` \| reference \\\| full \\\| returning \| @@ -145,7 +146,7 @@ Name \| Type \| Inherited from: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/Hydrator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L34) +Defined in: [packages/core/src/hydration/Hydrator.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L34) ___ @@ -158,13 +159,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| @@ -177,26 +178,26 @@ Name \| Type \| Default value \| Overrides: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/ObjectHydrator.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/ObjectHydrator.ts#L22) +Defined in: [packages/core/src/hydration/ObjectHydrator.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/ObjectHydrator.ts#L22) ___ ### hydrateProperty -▸ `Protected`hydrateProperty<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `factory`: [EntityFactory](core.entityfactory.md), `newEntity?`: boolean, `convertCustomTypes?`: boolean): void +▸ `Protected`hydrateProperty<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `factory`: [EntityFactory](core.entityfactory.md), `newEntity?`: boolean, `convertCustomTypes?`: boolean): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `factory` \| [EntityFactory](core.entityfactory.md) \| `newEntity?` \| boolean \| @@ -206,7 +207,7 @@ Name \| Type \| Inherited from: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/Hydrator.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/Hydrator.ts#L47) +Defined in: [packages/core/src/hydration/Hydrator.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/Hydrator.ts#L47) ___ @@ -219,13 +220,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| @@ -236,4 +237,4 @@ Name \| Type \| Default value \| Overrides: [Hydrator](core.hydrator.md) -Defined in: [packages/core/src/hydration/ObjectHydrator.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/hydration/ObjectHydrator.ts#L30) +Defined in: [packages/core/src/hydration/ObjectHydrator.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/hydration/ObjectHydrator.ts#L30) diff --git a/core.optimisticlockerror.md b/core.optimisticlockerror.md index e702d7c..7712989 100644 --- a/core.optimisticlockerror.md +++ b/core.optimisticlockerror.md @@ -2,6 +2,7 @@ id: "core.optimisticlockerror" title: "Class: OptimisticLockError<T>" sidebar_label: "OptimisticLockError" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity) \| [AnyEntity](../modules/core.md#anyentity) \| ## Hierarchy @@ -30,13 +31,13 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `message` \| string \| `entity?` \| T \| @@ -44,7 +45,7 @@ Name \| Type \| Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L4) +Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L4) ## Properties @@ -70,11 +71,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ValidationError](core.validationerror.md).[prepareStackTrace](core.validationerror.md#preparestacktrace) @@ -84,7 +100,7 @@ ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ValidationError](core.validationerror.md).[stack](core.validationerror.md#stack) @@ -111,7 +127,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| @@ -125,318 +141,337 @@ ___ ### getEntity -▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> Gets instance of entity that caused this error. -Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L17) ___ ### cannotCommit -▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L92) +Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L96) ___ ### cannotModifyInverseCollection -▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Inherited from: [ValidationError](core.validationerror.md) + +Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L79) + +___ + +### cannotModifyReadonlyCollection + +▸ `Static`cannotModifyReadonlyCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L79) +Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L88) ___ ### cannotUseOperatorsInsideEmbeddables -▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L96) +Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L100) ___ ### entityNotManaged -▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L43) +Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L43) ___ ### fromCollectionNotInitialized -▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L28) ___ ### fromMergeWithoutPK -▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L35) +Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L35) ___ ### fromWrongPropertyType -▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `property` \| string \| `expectedType` \| string \| `givenType` \| string \| `givenValue` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L21) +Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L21) ___ ### invalidCompositeIdentifier -▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L88) +Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L92) ___ ### invalidEmbeddableQuery -▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| `embeddableType` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L100) +Defined in: [packages/core/src/errors.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L104) ___ ### invalidPropertyName -▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `invalid` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L65) +Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L65) ___ ### invalidType -▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| +:------ \| :------ \| +`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| `value` \| any \| `mode` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L69) +Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L69) ___ ### lockFailed -▸ `Static`lockFailed(`entityOrName`: string \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`lockFailed(`entityOrName`: string \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entityOrName` \| string \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entityOrName` \| string \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:112](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L112) +Defined in: [packages/core/src/errors.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L116) ___ ### lockFailedVersionMismatch -▸ `Static`lockFailedVersionMismatch(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `expectedLockVersion`: number \\\| Date, `actualLockVersion`: number \\\| Date): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`lockFailedVersionMismatch(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `expectedLockVersion`: number \\\| Date, `actualLockVersion`: number \\\| Date): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `expectedLockVersion` \| number \\\| Date \| `actualLockVersion` \| number \\\| Date \| -Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L119) +Defined in: [packages/core/src/errors.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L123) ___ ### notDiscoveredEntity -▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| -`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L52) +Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L52) ___ ### notEntity -▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `data` \| any \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L47) +Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L47) ___ ### notVersioned -▸ `Static`notVersioned(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notVersioned(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [OptimisticLockError](core.optimisticlockerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L108) +Defined in: [packages/core/src/errors.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L112) ___ ### transactionRequired -▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> Inherited from: [ValidationError](core.validationerror.md) -Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L39) +Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L39) diff --git a/core.platform.md b/core.platform.md index 2c048a3..0f5f3b1 100644 --- a/core.platform.md +++ b/core.platform.md @@ -2,6 +2,7 @@ id: "core.platform" title: "Class: Platform" sidebar_label: "Platform" +custom_edit_url: null hide_title: true --- @@ -29,7 +30,7 @@ hide_title: true • `Protected` config: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/platforms/Platform.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L11) +Defined in: [packages/core/src/platforms/Platform.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L11) ___ @@ -37,15 +38,15 @@ ___ • `Protected` `Readonly` exceptionConverter: [ExceptionConverter](core.exceptionconverter.md) -Defined in: [packages/core/src/platforms/Platform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L10) +Defined in: [packages/core/src/platforms/Platform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L10) ___ ### timezone -• `Protected` `Optional` timezone: undefined \\\| string +• `Protected` `Optional` timezone: string -Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L12) +Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L12) ## Methods @@ -55,7 +56,7 @@ Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikr Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L120) +Defined in: [packages/core/src/platforms/Platform.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L120) ___ @@ -65,7 +66,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L46) +Defined in: [packages/core/src/platforms/Platform.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L46) ___ @@ -75,7 +76,29 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L124) +Defined in: [packages/core/src/platforms/Platform.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L124) + +___ + +### cloneEmbeddable + +▸ cloneEmbeddable<T\\>(`data`: T): T + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| T \| + +Returns: T + +Defined in: [packages/core/src/platforms/Platform.ts:204](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L204) ___ @@ -86,12 +109,12 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `marshall` \| boolean \| false \| Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:168](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L168) +Defined in: [packages/core/src/platforms/Platform.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L172) ___ @@ -104,12 +127,12 @@ Converts scalar primary key representation to native driver wrapper (e.g. string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| IPrimaryKeyValue \| Returns: IPrimaryKeyValue -Defined in: [packages/core/src/platforms/Platform.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L78) +Defined in: [packages/core/src/platforms/Platform.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L78) ___ @@ -119,7 +142,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:140](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L140) +Defined in: [packages/core/src/platforms/Platform.ts:140](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L140) ___ @@ -129,7 +152,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L136) +Defined in: [packages/core/src/platforms/Platform.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L136) ___ @@ -139,7 +162,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L156) +Defined in: [packages/core/src/platforms/Platform.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L156) ___ @@ -152,12 +175,12 @@ Returns the SQL specific for the platform to get the current timestamp #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L96) +Defined in: [packages/core/src/platforms/Platform.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L96) ___ @@ -168,12 +191,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L100) +Defined in: [packages/core/src/platforms/Platform.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L100) ___ @@ -183,7 +206,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:176](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L176) +Defined in: [packages/core/src/platforms/Platform.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L180) ___ @@ -193,7 +216,7 @@ ___ Returns: [ExceptionConverter](core.exceptionconverter.md) -Defined in: [packages/core/src/platforms/Platform.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L180) +Defined in: [packages/core/src/platforms/Platform.ts:184](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L184) ___ @@ -203,7 +226,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L160) +Defined in: [packages/core/src/platforms/Platform.ts:160](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L160) ___ @@ -211,9 +234,9 @@ ___ ▸ getNamingStrategy(): function -Returns: function +Returns: () => [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/core/src/platforms/Platform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L26) +Defined in: [packages/core/src/platforms/Platform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L26) ___ @@ -223,7 +246,7 @@ ___ Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L108) +Defined in: [packages/core/src/platforms/Platform.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L108) ___ @@ -234,12 +257,12 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| Returns: [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> -Defined in: [packages/core/src/platforms/Platform.ts:172](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L172) +Defined in: [packages/core/src/platforms/Platform.ts:176](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L176) ___ @@ -250,38 +273,56 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: ISchemaGenerator -Defined in: [packages/core/src/platforms/Platform.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L184) +Defined in: [packages/core/src/platforms/Platform.ts:188](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L188) ___ ### getSchemaHelper -▸ getSchemaHelper(): undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } +▸ getSchemaHelper(): undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } -Returns: undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } +Returns: undefined \\\| { `getTypeDefinition`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean) => string } -Defined in: [packages/core/src/platforms/Platform.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L38) +Defined in: [packages/core/src/platforms/Platform.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L38) + +___ + +### getSearchJsonPropertyKey + +▸ getSearchJsonPropertyKey(`path`: string[], `type`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`path` \| string[] \| +`type` \| string \| + +Returns: string + +Defined in: [packages/core/src/platforms/Platform.ts:168](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L168) ___ ### getSearchJsonPropertySQL -▸ getSearchJsonPropertySQL(`path`: string): string +▸ getSearchJsonPropertySQL(`path`: string, `type`: string): string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| +`type` \| string \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:164](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L164) +Defined in: [packages/core/src/platforms/Platform.ts:164](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L164) ___ @@ -294,12 +335,12 @@ Used when serializing via toObject and toJSON methods, allows to use different P #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L85) +Defined in: [packages/core/src/platforms/Platform.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L85) ___ @@ -310,28 +351,28 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L104) +Defined in: [packages/core/src/platforms/Platform.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L104) ___ ### isBigIntProperty -▸ isBigIntProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): boolean +▸ isBigIntProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L128) +Defined in: [packages/core/src/platforms/Platform.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L128) ___ @@ -342,12 +383,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L132) +Defined in: [packages/core/src/platforms/Platform.ts:132](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L132) ___ @@ -358,36 +399,36 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `values` \| string[] \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:144](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L144) +Defined in: [packages/core/src/platforms/Platform.ts:144](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L144) ___ ### normalizePrimaryKey -▸ normalizePrimaryKey<T\\>(`data`: string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Primary](../modules/core.md#primary)<T\\>): T +▸ normalizePrimaryKey<T\\>(`data`: IPrimaryKeyValue \\\| [Primary](../modules/core.md#primary)<T\\>): T Normalizes primary key wrapper to scalar value (e.g. mongodb's ObjectId to string) #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| string \\\| number \| string \\\\\| number \| +:------ \| :------ \| :------ \| +`T` \| string \\\| number \| string \\\| number \| #### Parameters: Name \| Type \| ------- \| ------ \| -`data` \| string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Primary](../modules/core.md#primary)<T\\> \| +:------ \| :------ \| +`data` \| IPrimaryKeyValue \\\| [Primary](../modules/core.md#primary)<T\\> \| Returns: T -Defined in: [packages/core/src/platforms/Platform.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L71) +Defined in: [packages/core/src/platforms/Platform.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L71) ___ @@ -398,12 +439,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| unknown \| Returns: string \\\| number \\\| Date -Defined in: [packages/core/src/platforms/Platform.ts:188](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L188) +Defined in: [packages/core/src/platforms/Platform.ts:192](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L192) ___ @@ -414,30 +455,46 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `id` \| string \| - \| `quote` \| string \| '\\`' \| Returns: string -Defined in: [packages/core/src/platforms/Platform.ts:192](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L192) +Defined in: [packages/core/src/platforms/Platform.ts:196](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L196) + +___ + +### quoteValue + +▸ quoteValue(`value`: any): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: string + +Defined in: [packages/core/src/platforms/Platform.ts:200](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L200) ___ ### quoteVersionValue -▸ quoteVersionValue(`value`: number \\\| Date, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string \\\| number \\\| Date +▸ quoteVersionValue(`value`: number \\\| Date, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string \\\| number \\\| Date #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| number \\\| Date \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: string \\\| number \\\| Date -Defined in: [packages/core/src/platforms/Platform.ts:112](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L112) +Defined in: [packages/core/src/platforms/Platform.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L112) ___ @@ -447,7 +504,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L42) +Defined in: [packages/core/src/platforms/Platform.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L42) ___ @@ -457,7 +514,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L116) +Defined in: [packages/core/src/platforms/Platform.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L116) ___ @@ -468,12 +525,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void -Defined in: [packages/core/src/platforms/Platform.ts:196](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L196) +Defined in: [packages/core/src/platforms/Platform.ts:208](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L208) ___ @@ -483,7 +540,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L18) +Defined in: [packages/core/src/platforms/Platform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L18) ___ @@ -494,12 +551,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| string \| Returns: string[] -Defined in: [packages/core/src/platforms/Platform.ts:148](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L148) +Defined in: [packages/core/src/platforms/Platform.ts:148](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L148) ___ @@ -511,7 +568,7 @@ Whether or not the driver supports retuning list of created PKs back when multi- Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L53) +Defined in: [packages/core/src/platforms/Platform.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L53) ___ @@ -523,7 +580,7 @@ Whether or not the driver supports updating many records at once Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L60) +Defined in: [packages/core/src/platforms/Platform.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L60) ___ @@ -533,7 +590,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L34) +Defined in: [packages/core/src/platforms/Platform.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L34) ___ @@ -543,7 +600,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L64) +Defined in: [packages/core/src/platforms/Platform.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L64) ___ @@ -553,7 +610,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L89) +Defined in: [packages/core/src/platforms/Platform.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L89) ___ @@ -563,7 +620,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L22) +Defined in: [packages/core/src/platforms/Platform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L22) ___ @@ -573,7 +630,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L14) +Defined in: [packages/core/src/platforms/Platform.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L14) ___ @@ -583,4 +640,4 @@ ___ Returns: boolean -Defined in: [packages/core/src/platforms/Platform.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L30) +Defined in: [packages/core/src/platforms/Platform.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L30) diff --git a/core.readonlyexception.md b/core.readonlyexception.md index 34f7a67..cd2f80b 100644 --- a/core.readonlyexception.md +++ b/core.readonlyexception.md @@ -2,6 +2,7 @@ id: "core.readonlyexception" title: "Class: ReadOnlyException" sidebar_label: "ReadOnlyException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a write operation attempt on a read-only database element detected #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [ReadOnlyException](core.readonlyexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.reference.md b/core.reference.md index a251763..20c4052 100644 --- a/core.reference.md +++ b/core.reference.md @@ -2,6 +2,7 @@ id: "core.reference" title: "Class: Reference<T>" sidebar_label: "Reference" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| ## Hierarchy @@ -30,18 +31,18 @@ Name \| Type \| #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: [Reference](core.reference.md)<T\\> -Defined in: [packages/core/src/entity/Reference.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L6) +Defined in: [packages/core/src/entity/Reference.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L6) ## Methods @@ -51,7 +52,7 @@ Defined in: [packages/core/src/entity/Reference.ts:6](https://github.com/mikro-o Returns: T -Defined in: [packages/core/src/entity/Reference.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L108) +Defined in: [packages/core/src/entity/Reference.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L108) ___ @@ -62,18 +63,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `K` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| K \| Returns: T[K] -Defined in: [packages/core/src/entity/Reference.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L116) +Defined in: [packages/core/src/entity/Reference.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L116) ___ @@ -83,7 +84,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/entity/Reference.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L120) +Defined in: [packages/core/src/entity/Reference.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L120) ___ @@ -96,7 +97,7 @@ Returns the entity. Returns: Promise<T\\> -Defined in: [packages/core/src/entity/Reference.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L67) +Defined in: [packages/core/src/entity/Reference.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L67) ▸ load<K\\>(`prop`: K): Promise<T[K]\\> @@ -106,18 +107,18 @@ Returns the requested property instead of the whole entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `K` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| K \| Returns: Promise<T[K]\\> -Defined in: [packages/core/src/entity/Reference.ts:73](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L73) +Defined in: [packages/core/src/entity/Reference.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L73) ___ @@ -128,12 +129,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populated?` \| boolean \| Returns: void -Defined in: [packages/core/src/entity/Reference.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L124) +Defined in: [packages/core/src/entity/Reference.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L124) ___ @@ -144,28 +145,28 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [IdentifiedReference](../modules/core.md#identifiedreference)<T, [PrimaryProperty](../modules/core.md#primaryproperty)<T\\>\\> \| Returns: void -Defined in: [packages/core/src/entity/Reference.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L91) +Defined in: [packages/core/src/entity/Reference.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L91) ___ ### toJSON -▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/entity/Reference.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L128) +Defined in: [packages/core/src/entity/Reference.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L128) ___ @@ -175,7 +176,7 @@ ___ Returns: T -Defined in: [packages/core/src/entity/Reference.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L104) +Defined in: [packages/core/src/entity/Reference.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L104) ___ @@ -186,19 +187,19 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`PK` \| unknown \| [PrimaryProperty](../modules/core.md#primaryproperty)<T\\\\> \| +`PK` \| unknown \| [PrimaryProperty](../modules/core.md#primaryproperty)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> \| Returns: [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK\\> -Defined in: [packages/core/src/entity/Reference.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L30) +Defined in: [packages/core/src/entity/Reference.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L30) ___ @@ -211,18 +212,18 @@ Checks whether the argument is instance or `Reference` wrapper. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| Returns: data is Reference<T\\> -Defined in: [packages/core/src/entity/Reference.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L41) +Defined in: [packages/core/src/entity/Reference.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L41) ___ @@ -235,18 +236,18 @@ Returns wrapped entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ref` \| T \\\| [Reference](core.reference.md)<T\\> \| Returns: T -Defined in: [packages/core/src/entity/Reference.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L59) +Defined in: [packages/core/src/entity/Reference.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L59) ___ @@ -259,16 +260,16 @@ Wraps the entity in a `Reference` wrapper if the property is defined as `wrapped #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [Reference](core.reference.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: T \\\| [Reference](core.reference.md)<T\\> -Defined in: [packages/core/src/entity/Reference.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L48) +Defined in: [packages/core/src/entity/Reference.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L48) diff --git a/core.reflectmetadataprovider.md b/core.reflectmetadataprovider.md index e0a5987..7c73bbe 100644 --- a/core.reflectmetadataprovider.md +++ b/core.reflectmetadataprovider.md @@ -2,6 +2,7 @@ id: "core.reflectmetadataprovider" title: "Class: ReflectMetadataProvider" sidebar_label: "ReflectMetadataProvider" +custom_edit_url: null hide_title: true --- @@ -24,14 +25,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [IConfiguration](../interfaces/core.iconfiguration.md) \| Returns: [ReflectMetadataProvider](core.reflectmetadataprovider.md) Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L9) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L9) ## Properties @@ -45,75 +46,75 @@ Inherited from: [MetadataProvider](core.metadataprovider.md).[config](core.metad ### initProperties -▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> +▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `fallback`: (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\>): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`fallback` \| (`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>) => void \\\| Promise<void\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L23) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L23) ___ ### initPropertyType -▸ `Protected`initPropertyType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void +▸ `Protected`initPropertyType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: void -Defined in: [packages/core/src/metadata/ReflectMetadataProvider.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/ReflectMetadataProvider.ts#L12) +Defined in: [packages/core/src/metadata/ReflectMetadataProvider.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/ReflectMetadataProvider.ts#L12) ___ ### loadEntityMetadata -▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> +▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/ReflectMetadataProvider.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/ReflectMetadataProvider.ts#L8) +Defined in: [packages/core/src/metadata/ReflectMetadataProvider.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/ReflectMetadataProvider.ts#L8) ___ ### loadFromCache -▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L15) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L15) ___ @@ -125,4 +126,4 @@ ___ Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L19) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L19) diff --git a/core.requestcontext.md b/core.requestcontext.md index 6c24eb9..0e9f990 100644 --- a/core.requestcontext.md +++ b/core.requestcontext.md @@ -2,6 +2,7 @@ id: "core.requestcontext" title: "Class: RequestContext" sidebar_label: "RequestContext" +custom_edit_url: null hide_title: true --- @@ -13,25 +14,21 @@ For node 14 and above it is suggested to use `AsyncLocalStorage` instead, `see` https://mikro-orm.io/docs/async-local-storage/ -## Hierarchy - -* RequestContext - ## Constructors ### constructor -\\+ new RequestContext(`map`: Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): [RequestContext](core.requestcontext.md) +\\+ new RequestContext(`map`: Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\>): [RequestContext](core.requestcontext.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`map` \| Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| +:------ \| :------ \| +`map` \| Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> \| Returns: [RequestContext](core.requestcontext.md) -Defined in: [packages/core/src/utils/RequestContext.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L14) +Defined in: [packages/core/src/utils/RequestContext.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L14) ## Properties @@ -39,13 +36,13 @@ Defined in: [packages/core/src/utils/RequestContext.ts:14](https://github.com/mi • `Readonly` id: number -Defined in: [packages/core/src/utils/RequestContext.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L14) +Defined in: [packages/core/src/utils/RequestContext.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L14) ___ ### map -• `Readonly` map: Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> +• `Readonly` map: Map<string, [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>\\> ___ @@ -53,19 +50,19 @@ ___ ▪ `Private` `Static` counter: number= 1 -Defined in: [packages/core/src/utils/RequestContext.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L13) +Defined in: [packages/core/src/utils/RequestContext.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L13) ## Accessors ### em -• em(): undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +• get em(): undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Returns default EntityManager. Returns: undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/utils/RequestContext.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L21) +Defined in: [packages/core/src/utils/RequestContext.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L21) ## Methods @@ -78,19 +75,19 @@ Creates new RequestContext instance and runs the code inside its domain. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>[] \| `next` \| (...`args`: any[]) => void \| Returns: void -Defined in: [packages/core/src/utils/RequestContext.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L28) +Defined in: [packages/core/src/utils/RequestContext.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L28) ___ ### createAsync -▸ `Static`createAsync(`em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>[], `next`: (...`args`: any[]) => Promise<void\\>): Promise<void\\> +▸ `Static`createAsync(`em`: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>[], `next`: (...`args`: any[]) => Promise<void\\>): Promise<void\\> Creates new RequestContext instance and runs the code inside its domain. Async variant, when the `next` handler needs to be awaited (like in Koa). @@ -98,13 +95,13 @@ Async variant, when the `next` handler needs to be awaited (like in Koa). #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>[] \| -`next` \| (...`args`: any[]) => Promise<void\\> \| +`next` \| (...`args`: any[]) => Promise<void\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/utils/RequestContext.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L37) +Defined in: [packages/core/src/utils/RequestContext.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L37) ___ @@ -115,12 +112,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\>[] \| Returns: [ORMDomain](../modules/core.md#ormdomain) -Defined in: [packages/core/src/utils/RequestContext.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L60) +Defined in: [packages/core/src/utils/RequestContext.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L60) ___ @@ -132,7 +129,7 @@ Returns current RequestContext (if available). Returns: undefined \\\| [RequestContext](core.requestcontext.md) -Defined in: [packages/core/src/utils/RequestContext.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L47) +Defined in: [packages/core/src/utils/RequestContext.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L47) ___ @@ -145,9 +142,9 @@ Returns current EntityManager (if available). #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `name` \| string \| 'default' \| Returns: undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/utils/RequestContext.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L55) +Defined in: [packages/core/src/utils/RequestContext.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L55) diff --git a/core.serializationcontext.md b/core.serializationcontext.md index b69b551..7c62b90 100644 --- a/core.serializationcontext.md +++ b/core.serializationcontext.md @@ -2,6 +2,7 @@ id: "core.serializationcontext" title: "Class: SerializationContext<T>" sidebar_label: "SerializationContext" +custom_edit_url: null hide_title: true --- @@ -16,13 +17,9 @@ are defined in populate hint). If not, we proceed and call `leave` afterwards. ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| -## Hierarchy - -* SerializationContext - ## Constructors ### constructor @@ -32,18 +29,18 @@ Name \| Type \| #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: [SerializationContext](core.serializationcontext.md)<T\\> -Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L15) +Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L15) ## Properties @@ -51,7 +48,7 @@ Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.co • `Readonly` path: [string, string][] -Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L15) +Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L15) ## Methods @@ -62,12 +59,12 @@ Defined in: [packages/core/src/entity/EntityTransformer.ts:15](https://github.co #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| string \| Returns: boolean -Defined in: [packages/core/src/entity/EntityTransformer.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L63) +Defined in: [packages/core/src/entity/EntityTransformer.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L63) ___ @@ -78,19 +75,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `U` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `prop` \| string \| Returns: void -Defined in: [packages/core/src/entity/EntityTransformer.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L34) +Defined in: [packages/core/src/entity/EntityTransformer.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L34) ___ @@ -101,29 +98,29 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `prop` \| string \| Returns: boolean -Defined in: [packages/core/src/entity/EntityTransformer.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L19) +Defined in: [packages/core/src/entity/EntityTransformer.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L19) ___ ### propagate -▸ `Static`propagate(`root`: [SerializationContext](core.serializationcontext.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ `Static`propagate(`root`: [SerializationContext](core.serializationcontext.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void When initializing new context, we need to propagate it to the whole entity graph recursively. #### Parameters: Name \| Type \| ------- \| ------ \| -`root` \| [SerializationContext](core.serializationcontext.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`root` \| [SerializationContext](core.serializationcontext.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/entity/EntityTransformer.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityTransformer.ts#L46) +Defined in: [packages/core/src/entity/EntityTransformer.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityTransformer.ts#L46) diff --git a/core.serverexception.md b/core.serverexception.md index af39524..ee04465 100644 --- a/core.serverexception.md +++ b/core.serverexception.md @@ -2,6 +2,7 @@ id: "core.serverexception" title: "Class: ServerException" sidebar_label: "ServerException" +custom_edit_url: null hide_title: true --- @@ -44,44 +45,44 @@ Base class for all server related errors detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [ServerException](core.serverexception.md) Inherited from: [DriverException](core.driverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [DriverException](core.driverexception.md).[code](core.driverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [DriverException](core.driverexception.md).[errmsg](core.driverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [DriverException](core.driverexception.md).[errno](core.driverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -107,11 +108,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [DriverException](core.driverexception.md).[prepareStackTrace](core.driverexception.md#preparestacktrace) @@ -121,27 +137,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [DriverException](core.driverexception.md).[sqlMessage](core.driverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [DriverException](core.driverexception.md).[sqlState](core.driverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [DriverException](core.driverexception.md).[stack](core.driverexception.md#stack) @@ -168,7 +184,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.syntaxerrorexception.md b/core.syntaxerrorexception.md index 5715f47..6c04c31 100644 --- a/core.syntaxerrorexception.md +++ b/core.syntaxerrorexception.md @@ -2,6 +2,7 @@ id: "core.syntaxerrorexception" title: "Class: SyntaxErrorException" sidebar_label: "SyntaxErrorException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a syntax error in a statement detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [SyntaxErrorException](core.syntaxerrorexception.md) Inherited from: [ServerException](core.serverexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ServerException](core.serverexception.md).[code](core.serverexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ServerException](core.serverexception.md).[errmsg](core.serverexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ServerException](core.serverexception.md).[errno](core.serverexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ServerException](core.serverexception.md).[prepareStackTrace](core.serverexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ServerException](core.serverexception.md).[sqlMessage](core.serverexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ServerException](core.serverexception.md).[sqlState](core.serverexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ServerException](core.serverexception.md).[stack](core.serverexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.tableexistsexception.md b/core.tableexistsexception.md index 0c06552..6c90f18 100644 --- a/core.tableexistsexception.md +++ b/core.tableexistsexception.md @@ -2,6 +2,7 @@ id: "core.tableexistsexception" title: "Class: TableExistsException" sidebar_label: "TableExistsException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for an already existing table referenced in a statement detected in th #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [TableExistsException](core.tableexistsexception.md) Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[code](core.databaseobjectexistsexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[errmsg](core.databaseobjectexistsexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[errno](core.databaseobjectexistsexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[prepareStackTrace](core.databaseobjectexistsexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[sqlMessage](core.databaseobjectexistsexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[sqlState](core.databaseobjectexistsexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [DatabaseObjectExistsException](core.databaseobjectexistsexception.md).[stack](core.databaseobjectexistsexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.tablenotfoundexception.md b/core.tablenotfoundexception.md index 3b59159..f7c8fcd 100644 --- a/core.tablenotfoundexception.md +++ b/core.tablenotfoundexception.md @@ -2,6 +2,7 @@ id: "core.tablenotfoundexception" title: "Class: TableNotFoundException" sidebar_label: "TableNotFoundException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for an unknown table referenced in a statement detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [TableNotFoundException](core.tablenotfoundexception.md) Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[code](core.databaseobjectnotfoundexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[errmsg](core.databaseobjectnotfoundexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[errno](core.databaseobjectnotfoundexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[prepareStackTrace](core.databaseobjectnotfoundexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[sqlMessage](core.databaseobjectnotfoundexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[sqlState](core.databaseobjectnotfoundexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [DatabaseObjectNotFoundException](core.databaseobjectnotfoundexception.md).[stack](core.databaseobjectnotfoundexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.timetype.md b/core.timetype.md index 4b682b7..7277e5d 100644 --- a/core.timetype.md +++ b/core.timetype.md @@ -2,6 +2,7 @@ id: "core.timetype" title: "Class: TimeType" sidebar_label: "TimeType" +custom_edit_url: null hide_title: true --- @@ -35,7 +36,7 @@ Inherited from: [Type](core.type.md) Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/TimeType.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/TimeType.ts#L16) +Defined in: [packages/core/src/types/TimeType.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/TimeType.ts#L16) ___ @@ -46,7 +47,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| `platform` \| [Platform](core.platform.md) \| @@ -54,7 +55,28 @@ Name \| Type \| Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/TimeType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/TimeType.ts#L8) +Defined in: [packages/core/src/types/TimeType.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/TimeType.ts#L8) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -67,7 +89,7 @@ Converts a value from its database representation to its JS representation of th #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| string \| `platform` \| [Platform](core.platform.md) \| @@ -75,26 +97,47 @@ Name \| Type \| Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L18) +Defined in: [packages/core/src/types/Type.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L18) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Inherited from: [Type](core.type.md) + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string Overrides: [Type](core.type.md) -Defined in: [packages/core/src/types/TimeType.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/TimeType.ts#L20) +Defined in: [packages/core/src/types/TimeType.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/TimeType.ts#L20) ___ @@ -108,7 +151,7 @@ By default uses the runtime value. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| string \| `platform` \| [Platform](core.platform.md) \| @@ -116,7 +159,7 @@ Name \| Type \| Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L34) +Defined in: [packages/core/src/types/Type.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L44) ___ @@ -127,18 +170,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> Inherited from: [Type](core.type.md) -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.transactioncontext.md b/core.transactioncontext.md index 2f0b9d6..b2d9375 100644 --- a/core.transactioncontext.md +++ b/core.transactioncontext.md @@ -2,6 +2,7 @@ id: "core.transactioncontext" title: "Class: TransactionContext" sidebar_label: "TransactionContext" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).TransactionContext -## Hierarchy - -* TransactionContext - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [TransactionContext](core.transactioncontext.md) -Defined in: [packages/core/src/utils/TransactionContext.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L9) +Defined in: [packages/core/src/utils/TransactionContext.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L9) ## Properties @@ -41,7 +38,7 @@ ___ • `Readonly` id: number -Defined in: [packages/core/src/utils/TransactionContext.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L9) +Defined in: [packages/core/src/utils/TransactionContext.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L9) ## Methods @@ -54,19 +51,19 @@ Creates new TransactionContext instance and runs the code inside its domain. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `next` \| (...`args`: any[]) => Promise<T\\> \| Returns: Promise<T\\> -Defined in: [packages/core/src/utils/TransactionContext.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L16) +Defined in: [packages/core/src/utils/TransactionContext.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L16) ___ @@ -78,7 +75,7 @@ Returns current TransactionContext (if available). Returns: undefined \\\| [TransactionContext](core.transactioncontext.md) -Defined in: [packages/core/src/utils/TransactionContext.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L31) +Defined in: [packages/core/src/utils/TransactionContext.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L31) ___ @@ -90,4 +87,4 @@ Returns current EntityManager (if available). Returns: undefined \\\| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/core/src/utils/TransactionContext.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L39) +Defined in: [packages/core/src/utils/TransactionContext.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L39) diff --git a/core.transactioneventbroadcaster.md b/core.transactioneventbroadcaster.md index 999c031..416a72e 100644 --- a/core.transactioneventbroadcaster.md +++ b/core.transactioneventbroadcaster.md @@ -2,6 +2,7 @@ id: "core.transactioneventbroadcaster" title: "Class: TransactionEventBroadcaster" sidebar_label: "TransactionEventBroadcaster" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).TransactionEventBroadcaster -## Hierarchy - -* TransactionEventBroadcaster - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `uow?` \| [UnitOfWork](core.unitofwork.md) \| Returns: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) -Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/TransactionEventBroadcaster.ts#L8) +Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/TransactionEventBroadcaster.ts#L8) ## Properties @@ -36,21 +33,21 @@ Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:8](https:// • `Private` `Readonly` eventManager: [EventManager](core.eventmanager.md) -Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/TransactionEventBroadcaster.ts#L8) +Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/TransactionEventBroadcaster.ts#L8) ## Methods ### dispatchEvent -▸ dispatchEvent(`event`: [TransactionEventType](../modules/core.md#transactioneventtype), `transaction?`: any): Promise<void\\> +▸ dispatchEvent(`event`: [TransactionEventType](../modules/core.md#transactioneventtype), `transaction?`: any): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| [TransactionEventType](../modules/core.md#transactioneventtype) \| `transaction?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/TransactionEventBroadcaster.ts#L13) +Defined in: [packages/core/src/events/TransactionEventBroadcaster.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/TransactionEventBroadcaster.ts#L13) diff --git a/core.type.md b/core.type.md index 3a3a35f..6c033bd 100644 --- a/core.type.md +++ b/core.type.md @@ -2,6 +2,7 @@ id: "core.type" title: "Class: Type<JSType, DBType>" sidebar_label: "Type" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `JSType` \| string \| `DBType` \| JSType \| @@ -41,7 +42,7 @@ Name \| Default \| #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `JSType` \| string \| `DBType` \| JSType \| @@ -51,9 +52,9 @@ Name \| Default \| ### types -▪ `Private` `Readonly` `Static` types: Map<any, any\\> +▪ `Private` `Readonly` `Static` types: Map<any, any\\> -Defined in: [packages/core/src/types/Type.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L6) +Defined in: [packages/core/src/types/Type.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L6) ## Methods @@ -66,7 +67,7 @@ Possible values: string \| number \| boolean \| date \| any \| buffer \| array Returns: string -Defined in: [packages/core/src/types/Type.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L26) +Defined in: [packages/core/src/types/Type.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L36) ___ @@ -79,14 +80,33 @@ Converts a value from its JS representation to its database representation of th #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| JSType \\\| DBType \| `platform` \| [Platform](core.platform.md) \| `fromQuery?` \| boolean \| Returns: DBType -Defined in: [packages/core/src/types/Type.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L11) +Defined in: [packages/core/src/types/Type.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L11) + +___ + +### convertToDatabaseValueSQL + +▸ `Optional`convertToDatabaseValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Converts a value from its JS representation to its database representation of this type. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Defined in: [packages/core/src/types/Type.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L25) ___ @@ -99,32 +119,51 @@ Converts a value from its database representation to its JS representation of th #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| JSType \\\| DBType \| `platform` \| [Platform](core.platform.md) \| Returns: JSType -Defined in: [packages/core/src/types/Type.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L18) +Defined in: [packages/core/src/types/Type.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L18) + +___ + +### convertToJSValueSQL + +▸ `Optional`convertToJSValueSQL(`key`: string, `platform`: [Platform](core.platform.md)): string + +Modifies the SQL expression (identifier, parameter) to convert to a JS value. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`key` \| string \| +`platform` \| [Platform](core.platform.md) \| + +Returns: string + +Defined in: [packages/core/src/types/Type.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L30) ___ ### getColumnType -▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string +▸ getColumnType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `platform`: [Platform](core.platform.md)): string Gets the SQL declaration snippet for a field of this type. #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `platform` \| [Platform](core.platform.md) \| Returns: string -Defined in: [packages/core/src/types/Type.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L41) +Defined in: [packages/core/src/types/Type.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L51) ___ @@ -138,13 +177,13 @@ By default uses the runtime value. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| JSType \| `platform` \| [Platform](core.platform.md) \| Returns: JSType \\\| DBType -Defined in: [packages/core/src/types/Type.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L34) +Defined in: [packages/core/src/types/Type.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L44) ___ @@ -155,16 +194,16 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `JSType` \| `DBType` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cls` \| [Constructor](../modules/core.md#constructor)<[Type](core.type.md)<JSType, DBType\\>\\> \| Returns: [Type](core.type.md)<JSType, DBType\\> -Defined in: [packages/core/src/types/Type.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/types/Type.ts#L46) +Defined in: [packages/core/src/types/Type.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/types/Type.ts#L56) diff --git a/core.underscorenamingstrategy.md b/core.underscorenamingstrategy.md index 6f56aa9..99d8dd0 100644 --- a/core.underscorenamingstrategy.md +++ b/core.underscorenamingstrategy.md @@ -2,6 +2,7 @@ id: "core.underscorenamingstrategy" title: "Class: UnderscoreNamingStrategy" sidebar_label: "UnderscoreNamingStrategy" +custom_edit_url: null hide_title: true --- @@ -34,14 +35,14 @@ Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `timestamp` \| string \| Returns: string Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L12) ___ @@ -52,14 +53,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L5) ___ @@ -70,7 +71,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `file` \| string \| - \| `separator` \| string \| '-' \| @@ -78,7 +79,7 @@ Name \| Type \| Default value \| Inherited from: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) +Defined in: [packages/core/src/naming-strategy/AbstractNamingStrategy.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/AbstractNamingStrategy.ts#L5) ___ @@ -89,14 +90,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L9) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L9) ___ @@ -107,7 +108,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `referencedColumnName?` \| string \| @@ -115,7 +116,7 @@ Name \| Type \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L13) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L13) ___ @@ -126,7 +127,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sourceEntity` \| string \| `targetEntity` \| string \| `propertyName` \| string \| @@ -135,7 +136,7 @@ Name \| Type \| Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L17) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L17) ___ @@ -146,14 +147,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L21) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L21) ___ @@ -165,7 +166,7 @@ ___ Overrides: [AbstractNamingStrategy](core.abstractnamingstrategy.md) -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L25) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L25) ___ @@ -176,9 +177,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L29) +Defined in: [packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/UnderscoreNamingStrategy.ts#L29) diff --git a/core.uniqueconstraintviolationexception.md b/core.uniqueconstraintviolationexception.md index 33445c0..5ba60ce 100644 --- a/core.uniqueconstraintviolationexception.md +++ b/core.uniqueconstraintviolationexception.md @@ -2,6 +2,7 @@ id: "core.uniqueconstraintviolationexception" title: "Class: UniqueConstraintViolationException" sidebar_label: "UniqueConstraintViolationException" +custom_edit_url: null hide_title: true --- @@ -26,44 +27,44 @@ Exception for a unique constraint violation detected in the driver. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `previous` \| Error \| Returns: [UniqueConstraintViolationException](core.uniqueconstraintviolationexception.md) Inherited from: [ConstraintViolationException](core.constraintviolationexception.md) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ## Properties ### code -• `Optional` code: undefined \\\| string +• `Optional` code: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[code](core.constraintviolationexception.md#code) -Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L6) +Defined in: [packages/core/src/exceptions.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L6) ___ ### errmsg -• `Optional` errmsg: undefined \\\| string +• `Optional` errmsg: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errmsg](core.constraintviolationexception.md#errmsg) -Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L10) +Defined in: [packages/core/src/exceptions.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L10) ___ ### errno -• `Optional` errno: undefined \\\| number +• `Optional` errno: number Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[errno](core.constraintviolationexception.md#errno) -Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L7) +Defined in: [packages/core/src/exceptions.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L7) ___ @@ -89,11 +90,26 @@ ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[prepareStackTrace](core.constraintviolationexception.md#preparestacktrace) @@ -103,27 +119,27 @@ ___ ### sqlMessage -• `Optional` sqlMessage: undefined \\\| string +• `Optional` sqlMessage: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlMessage](core.constraintviolationexception.md#sqlmessage) -Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L9) +Defined in: [packages/core/src/exceptions.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L9) ___ ### sqlState -• `Optional` sqlState: undefined \\\| string +• `Optional` sqlState: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[sqlState](core.constraintviolationexception.md#sqlstate) -Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/exceptions.ts#L8) +Defined in: [packages/core/src/exceptions.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/exceptions.ts#L8) ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string Inherited from: [ConstraintViolationException](core.constraintviolationexception.md).[stack](core.constraintviolationexception.md#stack) @@ -150,7 +166,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/core.unitofwork.md b/core.unitofwork.md index 7532401..757e79c 100644 --- a/core.unitofwork.md +++ b/core.unitofwork.md @@ -2,6 +2,7 @@ id: "core.unitofwork" title: "Class: UnitOfWork" sidebar_label: "UnitOfWork" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).UnitOfWork -## Hierarchy - -* UnitOfWork - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [UnitOfWork](core.unitofwork.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L32) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L32) ## Properties @@ -35,7 +32,7 @@ Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:32](https://github.com • `Private` `Readonly` changeSetComputer: [ChangeSetComputer](core.changesetcomputer.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L30) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L30) ___ @@ -43,23 +40,23 @@ ___ • `Private` `Readonly` changeSetPersister: [ChangeSetPersister](core.changesetpersister.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L31) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L31) ___ ### changeSets -• `Private` `Readonly` changeSets: Map<[AnyEntity](../modules/core.md#anyentity)<any\\>, [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> +• `Private` `Readonly` changeSets: Map<[AnyEntity](../modules/core.md#anyentity)<any\\>, [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L23) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L23) ___ ### collectionUpdates -• `Private` `Readonly` collectionUpdates: Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\> +• `Private` `Readonly` collectionUpdates: Set<[Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L24) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L24) ___ @@ -67,7 +64,7 @@ ___ • `Private` `Readonly` comparator: [EntityComparator](core.entitycomparator.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L29) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L29) ___ @@ -75,15 +72,15 @@ ___ • `Private` `Readonly` eventManager: [EventManager](core.eventmanager.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L28) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L28) ___ ### extraUpdates -• `Private` `Readonly` extraUpdates: Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> +• `Private` `Readonly` extraUpdates: Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L25) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L25) ___ @@ -93,7 +90,7 @@ ___ map of references to managed entities -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L18) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L18) ___ @@ -101,23 +98,23 @@ ___ • `Private` `Readonly` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L26) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L26) ___ ### orphanRemoveStack -• `Private` `Readonly` orphanRemoveStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +• `Private` `Readonly` orphanRemoveStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L22) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L22) ___ ### persistStack -• `Private` `Readonly` persistStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +• `Private` `Readonly` persistStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L20) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L20) ___ @@ -125,15 +122,15 @@ ___ • `Private` `Readonly` platform: [Platform](core.platform.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L27) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L27) ___ ### removeStack -• `Private` `Readonly` removeStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +• `Private` `Readonly` removeStack: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L21) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L21) ___ @@ -141,74 +138,76 @@ ___ • `Private` working: boolean= false -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L32) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L32) ## Methods ### cancelOrphanRemoval -▸ cancelOrphanRemoval(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ cancelOrphanRemoval(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:305](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L305) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:323](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L323) ___ ### cascade -▸ `Private`cascade<T\\>(`entity`: T, `type`: [Cascade](../enums/core.cascade.md), `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `options?`: { `checkRemoveStack?`: undefined \\\| boolean }): void +▸ `Private`cascade<T\\>(`entity`: T, `type`: [Cascade](../enums/core.cascade.md), `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `options?`: { `checkRemoveStack?`: boolean }): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| T \| - \| -`type` \| [Cascade](../enums/core.cascade.md) \| - \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| - \| -`options` \| { `checkRemoveStack?`: undefined \\\| boolean } \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`type` \| [Cascade](../enums/core.cascade.md) \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`options` \| object \| +`options.checkRemoveStack?` \| boolean \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:441](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L441) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:459](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L459) ___ ### cascadeReference -▸ `Private`cascadeReference<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `type`: [Cascade](../enums/core.cascade.md), `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `options`: { `checkRemoveStack?`: undefined \\\| boolean }): void +▸ `Private`cascadeReference<T\\>(`entity`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `type`: [Cascade](../enums/core.cascade.md), `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `options`: { `checkRemoveStack?`: boolean }): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `type` \| [Cascade](../enums/core.cascade.md) \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| -`options` \| { `checkRemoveStack?`: undefined \\\| boolean } \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`options` \| object \| +`options.checkRemoveStack?` \| boolean \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:459](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L459) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:477](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L477) ___ @@ -219,18 +218,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:352](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L352) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:370](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L370) ___ @@ -241,18 +240,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| Returns: boolean -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:337](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L337) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L355) ___ @@ -262,87 +261,87 @@ ___ Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L252) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:270](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L270) ___ ### commit -▸ commit(): Promise<void\\> +▸ commit(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:206](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L206) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:216](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L216) ___ ### commitCreateChangeSets -▸ `Private`commitCreateChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`commitCreateChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:591](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L591) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:613](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L613) ___ ### commitDeleteChangeSets -▸ `Private`commitDeleteChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> +▸ `Private`commitDeleteChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:646](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L646) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:668](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L668) ___ ### commitUpdateChangeSets -▸ `Private`commitUpdateChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any, `batched?`: boolean): Promise<void\\> +▸ `Private`commitUpdateChangeSets<T\\>(`changeSets`: [ChangeSet](core.changeset.md)<T\\>[], `ctx?`: any, `batched?`: boolean): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `changeSets` \| [ChangeSet](core.changeset.md)<T\\>[] \| - \| `ctx?` \| any \| - \| `batched` \| boolean \| true \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:629](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L629) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:651](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L651) ___ @@ -353,18 +352,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:148](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L148) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:158](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L158) ___ @@ -374,7 +373,7 @@ ___ Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:269](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L269) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:287](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L287) ___ @@ -385,42 +384,42 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `props` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\>[] \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:614](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L614) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:636](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L636) ___ ### findNewEntities -▸ `Private`findNewEntities<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void +▸ `Private`findNewEntities<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| T \| - \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:309](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L309) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:327](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L327) ___ @@ -431,44 +430,44 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:535](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L535) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:553](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L553) ___ ### getById -▸ getById<T\\>(`entityName`: string, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[]): T +▸ getById<T\\>(`entityName`: string, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[]): undefined \\\| T Returns entity from the identity map. For composite keys, you need to pass an array of PKs in the same order as they are defined in `meta.primaryKeys`. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \| -Returns: T +Returns: undefined \\\| T -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L81) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L87) ___ @@ -481,32 +480,32 @@ Orders change sets so FK constrains are maintained, ensures stable order (needed Returns: object Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `create` \| \| `delete` \| \| `update` \| \| -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:666](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L666) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:688](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L688) ___ ### getChangeSets -▸ getChangeSets(): [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] +▸ getChangeSets(): [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] -Returns: [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] +Returns: [ChangeSet](core.changeset.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L136) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L146) ___ ### getCollectionUpdates -▸ getCollectionUpdates(): [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>[] +▸ getCollectionUpdates(): [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>[] -Returns: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>[] +Returns: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>[] -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:140](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L140) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L150) ___ @@ -516,17 +515,17 @@ ___ Returns: string[] -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:682](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L682) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:704](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L704) ___ ### getExtraUpdates -▸ getExtraUpdates(): Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> +▸ getExtraUpdates(): Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> -Returns: Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> +Returns: Set<[[AnyEntity](../modules/core.md#anyentity)<any\\>, string, [Reference](core.reference.md)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Collection](core.collection.md)<any, unknown\\>]\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:144](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L144) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:154](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L154) ___ @@ -538,25 +537,25 @@ Returns map of all managed entities. Returns: [IdentityMap](core.identitymap.md) -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L101) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:111](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L111) ___ ### getOriginalEntityData -▸ getOriginalEntityData<T\\>(): [AnyEntity](../modules/core.md#anyentity)<any\\>[] +▸ getOriginalEntityData<T\\>(): [AnyEntity](../modules/core.md#anyentity)<any\\>[] `deprecated` use `uow.getOriginalEntityData(entity)` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| -Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] +Returns: [AnyEntity](../modules/core.md#anyentity)<any\\>[] -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L108) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L118) ▸ getOriginalEntityData<T\\>(`entity`: T): undefined \\\| [EntityData](../modules/core.md#entitydata)<T\\> @@ -565,38 +564,38 @@ Returns stored snapshot of entity state that is used for change set computation. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: undefined \\\| [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L113) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L123) ___ ### getPersistStack -▸ getPersistStack(): Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ getPersistStack(): Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L128) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L138) ___ ### getRemoveStack -▸ getRemoveStack(): Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ getRemoveStack(): Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: Set<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L132) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:142](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L142) ___ @@ -607,170 +606,173 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:367](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L367) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:385](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L385) ___ ### isCollectionSelfReferenced -▸ `Private`isCollectionSelfReferenced(`collection`: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): boolean +▸ `Private`isCollectionSelfReferenced(`collection`: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`collection` \| [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\> \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +:------ \| :------ \| +`collection` \| [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\> \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: boolean -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:487](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L487) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:505](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L505) ___ ### lock -▸ lock<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `version?`: number \\\| Date): Promise<void\\> +▸ lock<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `version?`: number \\\| Date): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `mode` \| [LockMode](../enums/core.lockmode.md) \| `version?` \| number \\\| Date \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:238](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L238) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:256](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L256) ___ ### lockOptimistic -▸ `Private`lockOptimistic<T\\>(`entity`: T, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `version`: number \\\| Date): Promise<void\\> +▸ `Private`lockOptimistic<T\\>(`entity`: T, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `version`: number \\\| Date): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `version` \| number \\\| Date \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:513](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L513) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:531](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L531) ___ ### lockPessimistic -▸ `Private`lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md)): Promise<void\\> +▸ `Private`lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md)): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `mode` \| [LockMode](../enums/core.lockmode.md) \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:505](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L505) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:523](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L523) ___ ### merge -▸ merge<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void +▸ merge<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| -`visited?` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`visited?` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L36) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L36) ___ ### persist -▸ persist<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `checkRemoveStack?`: boolean): void +▸ persist<T\\>(`entity`: T, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `checkRemoveStack?`: boolean): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| ... \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| - \| `checkRemoveStack` \| boolean \| false \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:179](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L179) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L189) ___ ### persistToDatabase -▸ `Private`persistToDatabase(`groups`: { `create`: ; `delete`: ; `update`: }, `tx?`: any): Promise<void\\> +▸ `Private`persistToDatabase(`groups`: { `create`: ; `delete`: ; `update`: }, `tx?`: any): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`groups` \| { `create`: ; `delete`: ; `update`: } \| +:------ \| :------ \| +`groups` \| object \| +`groups.create` \| - \| +`groups.delete` \| - \| +`groups.update` \| - \| `tx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:551](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L551) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:569](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L569) ___ @@ -780,80 +782,80 @@ ___ Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:431](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L431) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:449](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L449) ___ ### processReference -▸ `Private`processReference<T\\>(`parent`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `reference`: any, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void +▸ `Private`processReference<T\\>(`parent`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `reference`: any, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `parent` \| T \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `reference` \| any \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:377](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L377) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:395](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L395) ___ ### processToManyReference -▸ `Private`processToManyReference<T\\>(`reference`: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `parent`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>): void +▸ `Private`processToManyReference<T\\>(`reference`: [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\>, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>, `parent`: T, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`reference` \| [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\> \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +:------ \| :------ \| +`reference` \| [Collection](core.collection.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, unknown\\> \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| `parent` \| T \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:395](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L395) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:413](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L413) ___ ### processToOneReference -▸ `Private`processToOneReference<T\\>(`reference`: any, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void +▸ `Private`processToOneReference<T\\>(`reference`: any, `visited`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `reference` \| any \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:389](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L389) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:407](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L407) ___ @@ -864,18 +866,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:162](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L162) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L172) ___ @@ -888,13 +890,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data?` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| @@ -902,48 +904,48 @@ Name \| Type \| Returns: T -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L61) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L66) ___ ### remove -▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void +▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `visited?`: WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): void #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| - \| -`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`visited` \| WeakSet<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:193](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L193) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:203](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L203) ___ ### runHooks -▸ `Private`runHooks<T\\>(`type`: [EventType](../enums/core.eventtype.md), `changeSet`: [ChangeSet](core.changeset.md)<T\\>, `sync?`: boolean): Promise<unknown\\> +▸ `Private`runHooks<T\\>(`type`: [EventType](../enums/core.eventtype.md), `changeSet`: [ChangeSet](core.changeset.md)<T\\>, `sync?`: boolean): Promise<unknown\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `type` \| [EventType](../enums/core.eventtype.md) \| - \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| - \| `sync` \| boolean \| false \| -Returns: Promise<unknown\\> +Returns: Promise<unknown\\> -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:408](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L408) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:426](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L426) ___ @@ -954,52 +956,52 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `changeSet` \| [ChangeSet](core.changeset.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:293](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L293) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:311](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L311) ___ ### scheduleOrphanRemoval -▸ scheduleOrphanRemoval(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ scheduleOrphanRemoval(`entity?`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity?` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:299](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L299) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:317](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L317) ___ ### shouldCascade -▸ `Private`shouldCascade(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `type`: [Cascade](../enums/core.cascade.md)): boolean +▸ `Private`shouldCascade(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `type`: [Cascade](../enums/core.cascade.md)): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `type` \| [Cascade](../enums/core.cascade.md) \| Returns: boolean -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:492](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L492) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:510](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L510) ___ @@ -1010,33 +1012,33 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| `strict` \| boolean \| true \| Returns: null \\\| T -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L88) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L98) ___ ### unsetIdentity -▸ unsetIdentity(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ unsetIdentity(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void -Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:257](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/UnitOfWork.ts#L257) +Defined in: [packages/core/src/unit-of-work/UnitOfWork.ts:275](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/UnitOfWork.ts#L275) diff --git a/core.utils.md b/core.utils.md index 6489b4c..777b81b 100644 --- a/core.utils.md +++ b/core.utils.md @@ -2,6 +2,7 @@ id: "core.utils" title: "Class: Utils" sidebar_label: "Utils" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).Utils -## Hierarchy - -* Utils - ## Constructors ### constructor @@ -27,7 +24,7 @@ hide_title: true ▪ `Readonly` `Static` PK\\_SEPARATOR: ~~~= '~~~' -Defined in: [packages/core/src/utils/Utils.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L119) +Defined in: [packages/core/src/utils/Utils.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L119) ## Methods @@ -37,14 +34,14 @@ Defined in: [packages/core/src/utils/Utils.ts:119](https://github.com/mikro-orm/ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`path` \| string \| - \| -`baseDir` \| string \| ... \| +Name \| Type \| +:------ \| :------ \| +`path` \| string \| +`baseDir` \| string \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:609](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L609) +Defined in: [packages/core/src/utils/Utils.ts:612](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L612) ___ @@ -57,19 +54,19 @@ Normalize the argument to always be an array. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `data?` \| T \\\| T[] \| - \| `strict` \| boolean \| false \| Returns: T[] -Defined in: [packages/core/src/utils/Utils.ts:272](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L272) +Defined in: [packages/core/src/utils/Utils.ts:272](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L272) ___ @@ -80,20 +77,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| unknown[] \| `R` \| - \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fn` \| (...`args`: T) => R \| `...args` \| T \| Returns: R -Defined in: [packages/core/src/utils/Utils.ts:735](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L735) +Defined in: [packages/core/src/utils/Utils.ts:738](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L738) ___ @@ -106,18 +103,18 @@ Gets string name of given class. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `classOrName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:508](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L508) +Defined in: [packages/core/src/utils/Utils.ts:508](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L508) ___ @@ -130,35 +127,35 @@ Creates deep copy of given entity. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: T -Defined in: [packages/core/src/utils/Utils.ts:265](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L265) +Defined in: [packages/core/src/utils/Utils.ts:265](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L265) ___ ### createFunction -▸ `Static`createFunction(`context`: Map<string, any\\>, `code`: string): any +▸ `Static`createFunction(`context`: Map<string, any\\>, `code`: string): any #### Parameters: Name \| Type \| ------- \| ------ \| -`context` \| Map<string, any\\> \| +:------ \| :------ \| +`context` \| Map<string, any\\> \| `code` \| string \| Returns: any -Defined in: [packages/core/src/utils/Utils.ts:724](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L724) +Defined in: [packages/core/src/utils/Utils.ts:727](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L727) ___ @@ -169,20 +166,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| T \| `option` \| keyof T \| `defaultValue` \| any \| Returns: void -Defined in: [packages/core/src/utils/Utils.ts:631](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L631) +Defined in: [packages/core/src/utils/Utils.ts:634](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L634) ___ @@ -194,26 +191,26 @@ Tries to detect `ts-node` runtime. Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:519](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L519) +Defined in: [packages/core/src/utils/Utils.ts:519](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L519) ___ ### diff -▸ `Static`diff(`a`: [Dictionary](../modules/core.md#dictionary)<any\\>, `b`: [Dictionary](../modules/core.md#dictionary)<any\\>): Record<string \\\| number, any\\> +▸ `Static`diff(`a`: [Dictionary](../modules/core.md#dictionary)<any\\>, `b`: [Dictionary](../modules/core.md#dictionary)<any\\>): Record<string \\\| number, any\\> Computes difference between two objects, ignoring items missing in `b`. #### Parameters: Name \| Type \| ------- \| ------ \| -`a` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -`b` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`a` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`b` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: Record<string \\\| number, any\\> +Returns: Record<string \\\| number, any\\> -Defined in: [packages/core/src/utils/Utils.ts:248](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L248) +Defined in: [packages/core/src/utils/Utils.ts:248](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L248) ___ @@ -226,31 +223,31 @@ Checks if arguments are deeply (but not strictly) equal. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `a` \| any \| `b` \| any \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:191](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L191) +Defined in: [packages/core/src/utils/Utils.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L191) ___ ### extractEnumValues -▸ `Static`extractEnumValues(`target`: [Dictionary](../modules/core.md#dictionary)<any\\>): (string \\\| number)[] +▸ `Static`extractEnumValues(`target`: [Dictionary](../modules/core.md#dictionary)<any\\>): (string \\\| number)[] Extracts all possible values of a TS enum. Works with both string and numeric enums. #### Parameters: Name \| Type \| ------- \| ------ \| -`target` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`target` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: (string \\\| number)[] -Defined in: [packages/core/src/utils/Utils.ts:657](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L657) +Defined in: [packages/core/src/utils/Utils.ts:660](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L660) ___ @@ -263,20 +260,20 @@ Extracts primary key from `data`. Accepts objects or primary keys directly. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `data` \| any \| - \| `meta?` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| `strict` \| boolean \| false \| Returns: null \\\| string \\\| [Primary](../modules/core.md#primary)<T\\> -Defined in: [packages/core/src/utils/Utils.ts:364](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L364) +Defined in: [packages/core/src/utils/Utils.ts:364](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L364) ___ @@ -287,18 +284,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: T[] -Defined in: [packages/core/src/utils/Utils.ts:635](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L635) +Defined in: [packages/core/src/utils/Utils.ts:638](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L638) ___ @@ -309,18 +306,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `arrays` \| T[][] \| Returns: T[] -Defined in: [packages/core/src/utils/Utils.ts:673](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L673) +Defined in: [packages/core/src/utils/Utils.ts:676](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L676) ___ @@ -331,35 +328,35 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:388](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L388) +Defined in: [packages/core/src/utils/Utils.ts:388](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L388) ___ ### getGlobalStorage -▸ `Static`getGlobalStorage(`namespace`: string): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ `Static`getGlobalStorage(`namespace`: string): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `namespace` \| string \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/utils/Utils.ts:689](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L689) +Defined in: [packages/core/src/utils/Utils.ts:692](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L692) ___ @@ -369,13 +366,13 @@ ___ Returns: string -Defined in: [packages/core/src/utils/Utils.ts:710](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L710) +Defined in: [packages/core/src/utils/Utils.ts:713](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L713) ___ ### getObjectKeysSize -▸ `Static`getObjectKeysSize(`object`: [Dictionary](../modules/core.md#dictionary)<any\\>): number +▸ `Static`getObjectKeysSize(`object`: [Dictionary](../modules/core.md#dictionary)<any\\>): number Returns the number of properties on `obj`. This is 20x faster than Object.keys(obj).length. @@ -384,12 +381,12 @@ Returns the number of properties on `obj`. This is 20x faster than Object.keys(o #### Parameters: Name \| Type \| ------- \| ------ \| -`object` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`object` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: number -Defined in: [packages/core/src/utils/Utils.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L146) +Defined in: [packages/core/src/utils/Utils.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L146) ___ @@ -402,37 +399,37 @@ Gets the type of the argument. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:552](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L552) +Defined in: [packages/core/src/utils/Utils.ts:555](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L555) ___ ### getOrderedPrimaryKeys -▸ `Static`getOrderedPrimaryKeys<T\\>(`id`: [Primary](../modules/core.md#primary)<T\\> \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `platform?`: [Platform](core.platform.md), `convertCustomTypes?`: boolean): [Primary](../modules/core.md#primary)<T\\>[] +▸ `Static`getOrderedPrimaryKeys<T\\>(`id`: [Primary](../modules/core.md#primary)<T\\> \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `platform?`: [Platform](core.platform.md), `convertCustomTypes?`: boolean): [Primary](../modules/core.md#primary)<T\\>[] #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`id` \| [Primary](../modules/core.md#primary)<T\\> \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> \| +:------ \| :------ \| +`id` \| [Primary](../modules/core.md#primary)<T\\> \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `platform?` \| [Platform](core.platform.md) \| `convertCustomTypes?` \| boolean \| Returns: [Primary](../modules/core.md#primary)<T\\>[] -Defined in: [packages/core/src/utils/Utils.ts:449](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L449) +Defined in: [packages/core/src/utils/Utils.ts:449](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L449) ___ @@ -445,59 +442,59 @@ Returns array of functions argument names. Uses `escaya` for source code analysi #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `func` \| string \\\| { `toString`: () => string } \| `methodName?` \| string \| Returns: string[] -Defined in: [packages/core/src/utils/Utils.ts:300](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L300) +Defined in: [packages/core/src/utils/Utils.ts:300](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L300) ___ ### getPrimaryKeyCond -▸ `Static`getPrimaryKeyCond<T\\>(`entity`: T, `primaryKeys`: string[]): null \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> +▸ `Static`getPrimaryKeyCond<T\\>(`entity`: T, `primaryKeys`: string[]): null \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `primaryKeys` \| string[] \| -Returns: null \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> +Returns: null \\\| Record<string, [Primary](../modules/core.md#primary)<T\\>\\> -Defined in: [packages/core/src/utils/Utils.ts:429](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L429) +Defined in: [packages/core/src/utils/Utils.ts:429](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L429) ___ ### getPrimaryKeyCondFromArray -▸ `Static`getPrimaryKeyCondFromArray<T\\>(`pks`: [Primary](../modules/core.md#primary)<T\\>[], `primaryKeys`: string[]): Record<string, [Primary](../modules/core.md#primary)<T\\>\\> +▸ `Static`getPrimaryKeyCondFromArray<T\\>(`pks`: [Primary](../modules/core.md#primary)<T\\>[], `primaryKeys`: string[]): Record<string, [Primary](../modules/core.md#primary)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `pks` \| [Primary](../modules/core.md#primary)<T\\>[] \| `primaryKeys` \| string[] \| -Returns: Record<string, [Primary](../modules/core.md#primary)<T\\>\\> +Returns: Record<string, [Primary](../modules/core.md#primary)<T\\>\\> -Defined in: [packages/core/src/utils/Utils.ts:442](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L442) +Defined in: [packages/core/src/utils/Utils.ts:442](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L442) ___ @@ -508,12 +505,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `pks` \| string[] \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:403](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L403) +Defined in: [packages/core/src/utils/Utils.ts:403](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L403) ___ @@ -524,43 +521,43 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entity` \| T \| - \| `primaryKeys` \| string[] \| - \| `allowScalar` \| boolean \| false \| Returns: any -Defined in: [packages/core/src/utils/Utils.ts:411](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L411) +Defined in: [packages/core/src/utils/Utils.ts:411](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L411) ___ ### getRootEntity -▸ `Static`getRootEntity(`metadata`: IMetadataStorage, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> +▸ `Static`getRootEntity(`metadata`: IMetadataStorage, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [EntityMetadata](core.entitymetadata.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| IMetadataStorage \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [EntityMetadata](core.entitymetadata.md)<any\\> +Returns: [EntityMetadata](core.entitymetadata.md)<any\\> -Defined in: [packages/core/src/utils/Utils.ts:229](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L229) +Defined in: [packages/core/src/utils/Utils.ts:229](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L229) ___ ### hasObjectKeys -▸ `Static`hasObjectKeys(`object`: [Dictionary](../modules/core.md#dictionary)<any\\>): boolean +▸ `Static`hasObjectKeys(`object`: [Dictionary](../modules/core.md#dictionary)<any\\>): boolean Returns true if `obj` has at least one property. This is 20x faster than Object.keys(obj).length. @@ -569,12 +566,12 @@ Returns true if `obj` has at least one property. This is 20x faster than Object. #### Parameters: Name \| Type \| ------- \| ------ \| -`object` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`object` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:163](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L163) +Defined in: [packages/core/src/utils/Utils.ts:163](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L163) ___ @@ -585,37 +582,37 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| string \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:621](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L621) +Defined in: [packages/core/src/utils/Utils.ts:624](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L624) ___ ### isCollection -▸ `Static`isCollection<T, O\\>(`item`: any, `prop?`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `type?`: [SCALAR](../enums/core.referencetype.md#scalar) \\\| [ONE\\_TO\\_ONE](../enums/core.referencetype.md#one_to_one) \\\| [ONE\\_TO\\_MANY](../enums/core.referencetype.md#one_to_many) \\\| [MANY\\_TO\\_ONE](../enums/core.referencetype.md#many_to_one) \\\| [MANY\\_TO\\_MANY](../enums/core.referencetype.md#many_to_many) \\\| [EMBEDDED](../enums/core.referencetype.md#embedded)): item is Collection<T, O\\> +▸ `Static`isCollection<T, O\\>(`item`: any, `prop?`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `type?`: [ReferenceType](../enums/core.referencetype.md)): item is Collection<T, O\\> #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `O` \| unknown \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| any \| `prop?` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| -`type?` \| [SCALAR](../enums/core.referencetype.md#scalar) \\\| [ONE\\_TO\\_ONE](../enums/core.referencetype.md#one_to_one) \\\| [ONE\\_TO\\_MANY](../enums/core.referencetype.md#one_to_many) \\\| [MANY\\_TO\\_ONE](../enums/core.referencetype.md#many_to_one) \\\| [MANY\\_TO\\_MANY](../enums/core.referencetype.md#many_to_many) \\\| [EMBEDDED](../enums/core.referencetype.md#embedded) \| +`type?` \| [ReferenceType](../enums/core.referencetype.md) \| Returns: item is Collection<T, O\\> -Defined in: [packages/core/src/utils/Utils.ts:578](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L578) +Defined in: [packages/core/src/utils/Utils.ts:581](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L581) ___ @@ -628,19 +625,19 @@ Checks if the argument is not undefined #### Type parameters: Name \| Default \| ------- \| ------ \| -`T` \| Record<string, unknown\\\\> \| +:------ \| :------ \| +`T` \| Record<string, unknown\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `data` \| any \| - \| `considerNullUndefined` \| boolean \| false \| Returns: data is T -Defined in: [packages/core/src/utils/Utils.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L124) +Defined in: [packages/core/src/utils/Utils.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L124) ___ @@ -653,12 +650,12 @@ Checks whether the argument is empty (array without items, object without keys o #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:493](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L493) +Defined in: [packages/core/src/utils/Utils.ts:493](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L493) ___ @@ -671,19 +668,19 @@ Checks whether given object is an entity instance. #### Type parameters: Name \| Default \| ------- \| ------ \| -`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `data` \| any \| - \| `allowReference` \| boolean \| false \| Returns: data is T -Defined in: [packages/core/src/utils/Utils.ts:471](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L471) +Defined in: [packages/core/src/utils/Utils.ts:471](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L471) ___ @@ -694,12 +691,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `key` \| string \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:685](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L685) +Defined in: [packages/core/src/utils/Utils.ts:688](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L688) ___ @@ -712,19 +709,19 @@ Checks if the argument is instance of `Object`, but not one of the blacklisted t #### Type parameters: Name \| Default \| ------- \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\\\> \| +:------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `o` \| any \| `not` \| any[] \| Returns: o is T -Defined in: [packages/core/src/utils/Utils.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L138) +Defined in: [packages/core/src/utils/Utils.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L138) ___ @@ -737,18 +734,18 @@ Checks if the argument is number #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| number \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `s` \| any \| Returns: s is T -Defined in: [packages/core/src/utils/Utils.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L184) +Defined in: [packages/core/src/utils/Utils.ts:184](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L184) ___ @@ -761,18 +758,18 @@ Checks if the argument is instance of `Object`. Returns false for arrays. #### Type parameters: Name \| Default \| ------- \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\\\> \| +:------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `o` \| any \| Returns: o is T -Defined in: [packages/core/src/utils/Utils.ts:131](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L131) +Defined in: [packages/core/src/utils/Utils.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L131) ___ @@ -785,12 +782,12 @@ Checks whether the argument is ObjectId instance #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `key` \| any \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:486](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L486) +Defined in: [packages/core/src/utils/Utils.ts:486](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L486) ___ @@ -801,13 +798,13 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `key` \| string \| - \| `includeGroupOperators` \| boolean \| true \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:677](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L677) +Defined in: [packages/core/src/utils/Utils.ts:680](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L680) ___ @@ -820,12 +817,12 @@ Checks whether the value is POJO (e.g. `{ foo: 'bar' }`, and not instance of `Fo #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: value is Dictionary<any\\> -Defined in: [packages/core/src/utils/Utils.ts:560](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L560) +Defined in: [packages/core/src/utils/Utils.ts:563](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L563) ___ @@ -838,19 +835,19 @@ Checks whether the argument looks like primary key (string, number or ObjectId). #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `key` \| any \| - \| `allowComposite` \| boolean \| false \| Returns: key is Primary<T\\> -Defined in: [packages/core/src/utils/Utils.ts:353](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L353) +Defined in: [packages/core/src/utils/Utils.ts:353](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L353) ___ @@ -863,12 +860,12 @@ Checks if the argument is string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `s` \| any \| Returns: s is string -Defined in: [packages/core/src/utils/Utils.ts:177](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L177) +Defined in: [packages/core/src/utils/Utils.ts:177](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L177) ___ @@ -882,13 +879,13 @@ Analyses stack trace of error created inside the function call. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `stack?` \| string[] \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:531](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L531) +Defined in: [packages/core/src/utils/Utils.ts:531](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L531) ___ @@ -901,13 +898,13 @@ Merges all sources into the target recursively. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `target` \| any \| `...sources` \| any[] \| Returns: any -Defined in: [packages/core/src/utils/Utils.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L205) +Defined in: [packages/core/src/utils/Utils.ts:205](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L205) ___ @@ -918,29 +915,29 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...parts` \| string[] \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:586](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L586) +Defined in: [packages/core/src/utils/Utils.ts:589](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L589) ___ ### pathExists -▸ `Static`pathExists(`path`: string, `options?`: GlobbyOptions): Promise<boolean\\> +▸ `Static`pathExists(`path`: string, `options?`: GlobbyOptions): Promise<boolean\\> #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`path` \| string \| - \| -`options` \| GlobbyOptions \| ... \| +Name \| Type \| +:------ \| :------ \| +`path` \| string \| +`options` \| GlobbyOptions \| -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: [packages/core/src/utils/Utils.ts:645](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L645) +Defined in: [packages/core/src/utils/Utils.ts:648](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L648) ___ @@ -952,7 +949,7 @@ ___ Returns: any -Defined in: [packages/core/src/utils/Utils.ts:751](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L751) +Defined in: [packages/core/src/utils/Utils.ts:754](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L754) ___ @@ -963,13 +960,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `min` \| number \| `max` \| number \| Returns: number -Defined in: [packages/core/src/utils/Utils.ts:641](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L641) +Defined in: [packages/core/src/utils/Utils.ts:644](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L644) ___ @@ -980,13 +977,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| `relativeTo` \| string \| Returns: string -Defined in: [packages/core/src/utils/Utils.ts:593](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L593) +Defined in: [packages/core/src/utils/Utils.ts:596](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L596) ___ @@ -999,20 +996,20 @@ Renames object key, keeps order of properties. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| T \| `from` \| string \\\| keyof T \| `to` \| string \| Returns: void -Defined in: [packages/core/src/utils/Utils.ts:287](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L287) +Defined in: [packages/core/src/utils/Utils.ts:287](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L287) ___ @@ -1025,13 +1022,13 @@ Require a module from a specific location #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `id` \| string \| The module to require \| `from` \| string \| Location to start the node resolution \| Returns: any -Defined in: [packages/core/src/utils/Utils.ts:701](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L701) +Defined in: [packages/core/src/utils/Utils.ts:704](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L704) ___ @@ -1042,13 +1039,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `clause` \| () => any \| `data` \| any \| Returns: void -Defined in: [packages/core/src/utils/Utils.ts:625](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L625) +Defined in: [packages/core/src/utils/Utils.ts:628](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L628) ___ @@ -1061,20 +1058,20 @@ Executes the `cb` promise serially on every element of the `items` array and ret #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| `U` \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| Iterable<U\\> \| `cb` \| (`item`: U) => Promise<T\\> \| Returns: Promise<T[]\\> -Defined in: [packages/core/src/utils/Utils.ts:568](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L568) +Defined in: [packages/core/src/utils/Utils.ts:571](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L571) ___ @@ -1085,12 +1082,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `key` \| string \| Returns: string[] -Defined in: [packages/core/src/utils/Utils.ts:407](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L407) +Defined in: [packages/core/src/utils/Utils.ts:407](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L407) ___ @@ -1103,32 +1100,32 @@ Gets array without duplicates. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| string \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: T[] -Defined in: [packages/core/src/utils/Utils.ts:198](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L198) +Defined in: [packages/core/src/utils/Utils.ts:198](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L198) ___ ### walkNode -▸ `Private` `Static`walkNode(`node`: [Dictionary](../modules/core.md#dictionary)<any\\>, `checkNode`: (`node`: [Dictionary](../modules/core.md#dictionary)<any\\>) => void): void +▸ `Private` `Static`walkNode(`node`: [Dictionary](../modules/core.md#dictionary)<any\\>, `checkNode`: (`node`: [Dictionary](../modules/core.md#dictionary)<any\\>) => void): void #### Parameters: Name \| Type \| ------- \| ------ \| -`node` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -`checkNode` \| (`node`: [Dictionary](../modules/core.md#dictionary)<any\\>) => void \| +:------ \| :------ \| +`node` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`checkNode` \| (`node`: [Dictionary](../modules/core.md#dictionary)<any\\>) => void \| Returns: void -Defined in: [packages/core/src/utils/Utils.ts:332](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L332) +Defined in: [packages/core/src/utils/Utils.ts:332](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L332) diff --git a/core.validationerror.md b/core.validationerror.md index 596322e..355caef 100644 --- a/core.validationerror.md +++ b/core.validationerror.md @@ -2,6 +2,7 @@ id: "core.validationerror" title: "Class: ValidationError<T>" sidebar_label: "ValidationError" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity) \| [AnyEntity](../modules/core.md#anyentity) \| ## Hierarchy @@ -36,19 +37,21 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `message` \| string \| `entity?` \| T \| Returns: [ValidationError](core.validationerror.md)<T\\> -Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L4) +Overrides: void + +Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L4) ## Properties @@ -56,6 +59,8 @@ Defined in: [packages/core/src/errors.ts:4](https://github.com/mikro-orm/mikro-o • message: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:974 ___ @@ -64,17 +69,34 @@ ___ • name: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973 ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Defined in: node_modules/@types/node/globals.d.ts:11 @@ -82,7 +104,9 @@ ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string + +Inherited from: void Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975 @@ -105,7 +129,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| @@ -117,238 +141,255 @@ ___ ### getEntity -▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +▸ getEntity(): undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> Gets instance of entity that caused this error. -Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> +Returns: undefined \\\| [AnyEntity](../modules/core.md#anyentity)<any\\> -Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L17) ___ ### cannotCommit -▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotCommit(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L92) +Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L96) ___ ### cannotModifyInverseCollection -▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotModifyInverseCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| + +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> + +Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L79) + +___ + +### cannotModifyReadonlyCollection + +▸ `Static`cannotModifyReadonlyCollection(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`property` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L79) +Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L88) ___ ### cannotUseOperatorsInsideEmbeddables -▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`cannotUseOperatorsInsideEmbeddables(`className`: string, `propName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L96) +Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L100) ___ ### entityNotManaged -▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`entityNotManaged(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L43) +Defined in: [packages/core/src/errors.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L43) ___ ### fromCollectionNotInitialized -▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromCollectionNotInitialized(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L28) ___ ### fromMergeWithoutPK -▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Static`fromMergeWithoutPK(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L35) +Defined in: [packages/core/src/errors.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L35) ___ ### fromWrongPropertyType -▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`fromWrongPropertyType(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `property`: string, `expectedType`: string, `givenType`: string, `givenValue`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `property` \| string \| `expectedType` \| string \| `givenType` \| string \| `givenValue` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L21) +Defined in: [packages/core/src/errors.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L21) ___ ### invalidCompositeIdentifier -▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidCompositeIdentifier(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L88) +Defined in: [packages/core/src/errors.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L92) ___ ### invalidEmbeddableQuery -▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidEmbeddableQuery(`className`: string, `propName`: string, `embeddableType`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `propName` \| string \| `embeddableType` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L100) +Defined in: [packages/core/src/errors.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L104) ___ ### invalidPropertyName -▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidPropertyName(`entityName`: string, `invalid`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `invalid` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L65) +Defined in: [packages/core/src/errors.ts:65](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L65) ___ ### invalidType -▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`invalidType(`type`: [Constructor](../modules/core.md#constructor)<any\\>, `value`: any, `mode`: string): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| +:------ \| :------ \| +`type` \| [Constructor](../modules/core.md#constructor)<any\\> \| `value` \| any \| `mode` \| string \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L69) +Defined in: [packages/core/src/errors.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L69) ___ ### notDiscoveredEntity -▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notDiscoveredEntity(`data`: any, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| -`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L52) +Defined in: [packages/core/src/errors.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L52) ___ ### notEntity -▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`notEntity(`owner`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `data`: any): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`owner` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `data` \| any \| -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L47) +Defined in: [packages/core/src/errors.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L47) ___ ### transactionRequired -▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +▸ `Static`transactionRequired(): [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> +Returns: [ValidationError](core.validationerror.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> -Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/errors.ts#L39) +Defined in: [packages/core/src/errors.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/errors.ts#L39) diff --git a/entity_generator.entitygenerator.md b/entity_generator.entitygenerator.md index 3599957..f228816 100644 --- a/entity_generator.entitygenerator.md +++ b/entity_generator.entitygenerator.md @@ -1,7 +1,8 @@ --- -id: "entity-generator.entitygenerator" +id: "entity_generator.entitygenerator" title: "Class: EntityGenerator" sidebar_label: "EntityGenerator" +custom_edit_url: null hide_title: true --- @@ -9,25 +10,21 @@ hide_title: true [entity-generator](../modules/entity_generator.md).EntityGenerator -## Hierarchy - -* EntityGenerator - ## Constructors ### constructor -\\+ new EntityGenerator(`em`: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\>): [EntityGenerator](entity-generator.entitygenerator.md) +\\+ new EntityGenerator(`em`: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\>): [EntityGenerator](entity_generator.entitygenerator.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| -Returns: [EntityGenerator](entity-generator.entitygenerator.md) +Returns: [EntityGenerator](entity_generator.entitygenerator.md) -Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L14) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L14) ## Properties @@ -35,7 +32,7 @@ Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github • `Private` `Readonly` config: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/entity-generator/src/EntityGenerator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L8) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L8) ___ @@ -43,7 +40,7 @@ ___ • `Private` `Readonly` connection: [AbstractSqlConnection](knex.abstractsqlconnection.md) -Defined in: [packages/entity-generator/src/EntityGenerator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L12) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L12) ___ @@ -51,7 +48,7 @@ ___ • `Private` `Readonly` driver: [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> -Defined in: [packages/entity-generator/src/EntityGenerator.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L9) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L9) ___ @@ -59,7 +56,7 @@ ___ • `Private` `Readonly` helper: [SchemaHelper](knex.schemahelper.md) -Defined in: [packages/entity-generator/src/EntityGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L11) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L11) ___ @@ -67,7 +64,7 @@ ___ • `Private` `Readonly` namingStrategy: [NamingStrategy](../interfaces/core.namingstrategy.md) -Defined in: [packages/entity-generator/src/EntityGenerator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L13) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L13) ___ @@ -75,7 +72,7 @@ ___ • `Private` `Readonly` platform: [AbstractSqlPlatform](knex.abstractsqlplatform.md) -Defined in: [packages/entity-generator/src/EntityGenerator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L10) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L10) ___ @@ -83,7 +80,7 @@ ___ • `Private` `Readonly` sources: SourceFile[] -Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L14) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L14) ## Methods @@ -94,25 +91,27 @@ Defined in: [packages/entity-generator/src/EntityGenerator.ts:14](https://github #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `table` \| [DatabaseTable](knex.databasetable.md) \| Returns: void -Defined in: [packages/entity-generator/src/EntityGenerator.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L31) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L31) ___ ### generate -▸ generate(`options?`: { `baseDir?`: undefined \\\| string ; `save?`: undefined \\\| boolean }): Promise<string[]\\> +▸ generate(`options?`: { `baseDir?`: string ; `save?`: boolean }): Promise<string[]\\> #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| { `baseDir?`: undefined \\\| string ; `save?`: undefined \\\| boolean } \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| object \| +`options.baseDir?` \| string \| +`options.save?` \| boolean \| -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/entity-generator/src/EntityGenerator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/entity-generator/src/EntityGenerator.ts#L18) +Defined in: [packages/entity-generator/src/EntityGenerator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/entity-generator/src/EntityGenerator.ts#L18) diff --git a/knex.abstractsqlconnection.md b/knex.abstractsqlconnection.md index addf88f..8584cfb 100644 --- a/knex.abstractsqlconnection.md +++ b/knex.abstractsqlconnection.md @@ -2,6 +2,7 @@ id: "knex.abstractsqlconnection" title: "Class: AbstractSqlConnection" sidebar_label: "AbstractSqlConnection" +custom_edit_url: null hide_title: true --- @@ -24,26 +25,26 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `options?` \| [ConnectionOptions](../interfaces/core.connectionoptions.md) \| `type?` \| read \\\| write \| Returns: [AbstractSqlConnection](knex.abstractsqlconnection.md) -Inherited from: [Connection](core.connection.md) +Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L18) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L18) ## Properties ### client -• `Protected` client: Knex<any, unknown[]\\> +• `Protected` client: Knex<any, unknown[]\\> Overrides: [Connection](core.connection.md).[client](core.connection.md#client) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L18) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L18) ___ @@ -61,13 +62,13 @@ ___ Inherited from: [Connection](core.connection.md).[metadata](core.connection.md#metadata) -Defined in: [packages/core/src/connections/Connection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L12) +Defined in: [packages/core/src/connections/Connection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L12) ___ ### options -• `Protected` `Optional` `Readonly` options: undefined \\\| [ConnectionOptions](../interfaces/core.connectionoptions.md) +• `Protected` `Optional` `Readonly` options: [ConnectionOptions](../interfaces/core.connectionoptions.md) Inherited from: [Connection](core.connection.md).[options](core.connection.md#options) @@ -79,7 +80,7 @@ ___ Overrides: [Connection](core.connection.md).[platform](core.connection.md#platform) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L17) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L17) ___ @@ -93,106 +94,106 @@ Inherited from: [Connection](core.connection.md).[type](core.connection.md#type) ### begin -▸ begin(`ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<[Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>\\> +▸ begin(`ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<[Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<[Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>\\> +Returns: Promise<[Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L56) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L56) ___ ### close -▸ close(`force?`: boolean): Promise<void\\> +▸ close(`force?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `force?` \| boolean \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L29) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L29) ___ ### commit -▸ commit(`ctx`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> +▸ commit(`ctx`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`ctx` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`ctx` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:72](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L72) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:72](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L72) ___ ### connect -▸ `Abstract`connect(): Promise<void\\> +▸ `Abstract`connect(): Promise<void\\> Establishes connection to database -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L28) +Defined in: [packages/core/src/connections/Connection.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L28) ___ ### createKnexClient -▸ `Protected`createKnexClient(`type`: string): Knex<any, unknown[]\\> +▸ `Protected`createKnexClient(`type`: string): Knex<any, unknown[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type` \| string \| -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/AbstractSqlConnection.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L136) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L136) ___ ### execute -▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<T\\> +▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\\\>\\\\>[] \| +:------ \| :------ \| :------ \| +`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\> \| - \| -`params` \| any[] \| ... \| +:------ \| :------ \| :------ \| +`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| - \| +`params` \| any[] \| - \| `method` \| all \\\| get \\\| run \| 'all' \| `ctx?` \| any \| - \| @@ -200,7 +201,7 @@ Name \| Type \| Default value \| Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L101) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L101) ___ @@ -211,13 +212,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `cb` \| () => Promise<T\\> \| @@ -225,7 +226,7 @@ Name \| Type \| Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:90](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L90) +Defined in: [packages/core/src/connections/Connection.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L90) ___ @@ -237,7 +238,7 @@ ___ Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L75) +Defined in: [packages/core/src/connections/Connection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L75) ___ @@ -249,7 +250,7 @@ ___ Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L63) +Defined in: [packages/core/src/connections/Connection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L63) ___ @@ -263,33 +264,33 @@ Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L43) +Defined in: [packages/core/src/connections/Connection.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L43) ___ ### getKnex -▸ getKnex(): Knex<any, unknown[]\\> +▸ getKnex(): Knex<any, unknown[]\\> -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/AbstractSqlConnection.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L25) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L25) ___ ### getKnexOptions -▸ `Protected`getKnexOptions(`type`: string): [Config](../interfaces/knex.knex.config.md)<any\\> +▸ `Protected`getKnexOptions(`type`: string): [Config](../interfaces/knex.knex-1.config.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type` \| string \| -Returns: [Config](../interfaces/knex.knex.config.md)<any\\> +Returns: [Config](../interfaces/knex.knex-1.config.md)<any\\> -Defined in: [packages/knex/src/AbstractSqlConnection.ts:145](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L145) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:145](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L145) ___ @@ -300,43 +301,43 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `formatted` \| string \| Returns: string -Defined in: [packages/knex/src/AbstractSqlConnection.ts:153](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L153) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:153](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L153) ___ ### isConnected -▸ isConnected(): Promise<boolean\\> +▸ isConnected(): Promise<boolean\\> -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L33) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L33) ___ ### loadFile -▸ loadFile(`path`: string): Promise<void\\> +▸ loadFile(`path`: string): Promise<void\\> Execute raw SQL queries from file #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/AbstractSqlConnection.ts:127](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L127) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L127) ___ @@ -347,7 +348,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `query` \| string \| `took?` \| number \| @@ -355,7 +356,7 @@ Name \| Type \| Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L132) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:132](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L132) ___ @@ -369,26 +370,26 @@ support edge cases like `\\\\?` strings (as `positionBindings` was removing the `\\ Returns: void -Defined in: [packages/knex/src/AbstractSqlConnection.ts:172](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L172) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L172) ___ ### rollback -▸ rollback(`ctx`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> +▸ rollback(`ctx`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`ctx` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`ctx` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L87) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L87) ___ @@ -399,14 +400,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:82](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L82) +Defined in: [packages/core/src/connections/Connection.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L82) ___ @@ -417,40 +418,40 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `platform` \| [Platform](core.platform.md) \| Returns: void Inherited from: [Connection](core.connection.md) -Defined in: [packages/core/src/connections/Connection.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L86) +Defined in: [packages/core/src/connections/Connection.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L86) ___ ### transactional -▸ transactional<T\\>(`cb`: (`trx`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>) => Promise<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<T\\> +▸ transactional<T\\>(`cb`: (`trx`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>) => Promise<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `eventBroadcaster?`: [TransactionEventBroadcaster](core.transactioneventbroadcaster.md)): Promise<T\\> #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`cb` \| (`trx`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>) => Promise<T\\> \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`cb` \| (`trx`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>) => Promise<T\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| `eventBroadcaster?` \| [TransactionEventBroadcaster](core.transactioneventbroadcaster.md) \| Returns: Promise<T\\> Overrides: [Connection](core.connection.md) -Defined in: [packages/knex/src/AbstractSqlConnection.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L42) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L42) ___ @@ -461,16 +462,16 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `res` \| any \| `method` \| all \\\| get \\\| run \| Returns: T -Defined in: [packages/knex/src/AbstractSqlConnection.ts:197](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlConnection.ts#L197) +Defined in: [packages/knex/src/AbstractSqlConnection.ts:197](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlConnection.ts#L197) diff --git a/knex.abstractsqldriver.md b/knex.abstractsqldriver.md index 0727823..cdef69f 100644 --- a/knex.abstractsqldriver.md +++ b/knex.abstractsqldriver.md @@ -2,6 +2,7 @@ id: "knex.abstractsqldriver" title: "Class: AbstractSqlDriver<C>" sidebar_label: "AbstractSqlDriver" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `C` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| ## Hierarchy @@ -30,13 +31,13 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `C` \| [AbstractSqlConnection](knex.abstractsqlconnection.md)<C\\> \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| `platform` \| [AbstractSqlPlatform](knex.abstractsqlplatform.md) \| `connection` \| [Constructor](../modules/core.md#constructor)<C\\> \| @@ -44,19 +45,19 @@ Name \| Type \| Returns: [AbstractSqlDriver](knex.abstractsqldriver.md)<C\\> -Inherited from: [DatabaseDriver](core.databasedriver.md) +Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L19) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L19) ## Properties -### \\_\\_@EntityManagerType@43871 +### [EntityManagerType] -• \\_\\_@EntityManagerType@43871: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<C\\>\\> +• [EntityManagerType]: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<C\\>\\> -Overrides: [DatabaseDriver](core.databasedriver.md).[__@EntityManagerType@43871](core.databasedriver.md#__@entitymanagertype@43871) +Overrides: [DatabaseDriver](core.databasedriver.md).[[EntityManagerType]](core.databasedriver.md#[entitymanagertype]) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L15) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L15) ___ @@ -66,7 +67,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md).[comparator](core.databasedriver.md#comparator) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L21) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L21) ___ @@ -84,7 +85,7 @@ ___ Overrides: [DatabaseDriver](core.databasedriver.md).[connection](core.databasedriver.md#connection) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L17) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L17) ___ @@ -102,7 +103,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md).[logger](core.databasedriver.md#logger) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L20) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L20) ___ @@ -112,7 +113,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md).[metadata](core.databasedriver.md#metadata) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L22) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L22) ___ @@ -122,7 +123,7 @@ ___ Overrides: [DatabaseDriver](core.databasedriver.md).[platform](core.databasedriver.md#platform) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L19) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L19) ___ @@ -132,26 +133,26 @@ ___ Overrides: [DatabaseDriver](core.databasedriver.md).[replicas](core.databasedriver.md#replicas) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L18) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L18) ## Methods ### aggregate -▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> +▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `pipeline` \| any[] \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L49) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L49) ___ @@ -162,46 +163,46 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `collection` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| `relationPojo` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: void -Defined in: [packages/knex/src/AbstractSqlDriver.ts:157](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L157) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:158](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L158) ___ ### autoJoinOneToOneOwner -▸ `Protected`autoJoinOneToOneOwner<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `fields?`: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[]): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] +▸ `Protected`autoJoinOneToOneOwner<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `fields?`: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[]): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] 1:1 owner side needs to be marked for population so QB auto-joins the owner id #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| - \| -`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| - \| -`fields` \| (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] \| ... \| +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| +`fields` \| (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:419](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L419) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:425](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L425) ___ @@ -212,13 +213,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| `joinedProps` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| @@ -227,25 +228,51 @@ Name \| Type \| Returns: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:586](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L586) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:616](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L616) + +___ + +### buildJoinedPropsOrderBy + +▸ `Protected`buildJoinedPropsOrderBy<T\\>(`entityName`: string, `qb`: [QueryBuilder](knex.querybuilder.md)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `parentPath?`: string): [QueryOrderMap](../interfaces/core.queryordermap.md) + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`qb` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| +`parentPath?` \| string \| + +Returns: [QueryOrderMap](../interfaces/core.queryordermap.md) + +Defined in: [packages/knex/src/AbstractSqlDriver.ts:592](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L592) ___ ### close -▸ close(`force?`: boolean): Promise<void\\> +▸ close(`force?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `force?` \| boolean \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L93) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L93) ___ @@ -257,7 +284,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L71) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L71) ___ @@ -270,41 +297,41 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `exception` \| Error \| Returns: [DriverException](core.driverexception.md) Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:244](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L244) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:254](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L254) ___ ### count -▸ count<T\\>(`entityName`: string, `where`: any, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): Promise<number\\> +▸ count<T\\>(`entityName`: string, `where`: any, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): Promise<number\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| string \| - \| -`where` \| any \| - \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`where` \| any \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:171](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L171) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L172) ___ @@ -315,45 +342,45 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md), D\\> \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `useContext?` \| boolean \| Returns: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)] Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L32) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L32) ___ ### createQueryBuilder -▸ `Protected`createQueryBuilder<T\\>(`entityName`: string, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `write?`: boolean, `convertCustomTypes?`: boolean): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ `Protected`createQueryBuilder<T\\>(`entityName`: string, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `write?`: boolean, `convertCustomTypes?`: boolean): [QueryBuilder](knex.querybuilder.md)<T\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| `write?` \| boolean \| `convertCustomTypes?` \| boolean \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/AbstractSqlDriver.ts:500](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L500) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:506](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L506) ___ @@ -364,51 +391,51 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cb` \| (`c`: [ConnectionOptions](../interfaces/core.connectionoptions.md)) => C \| Returns: C[] Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L205) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:215](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L215) ___ ### ensureIndexes -▸ ensureIndexes(): Promise<void\\> +▸ ensureIndexes(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:117](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L117) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L127) ___ ### execute -▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<T\\> +▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run, `ctx?`: any): Promise<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\\\>\\\\>[] \| +:------ \| :------ \| :------ \| +`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\> \| - \| -`params` \| any[] \| ... \| +:------ \| :------ \| :------ \| +`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| - \| +`params` \| any[] \| - \| `method` \| all \\\| get \\\| run \| 'all' \| `ctx?` \| any \| - \| Returns: Promise<T\\> -Defined in: [packages/knex/src/AbstractSqlDriver.ts:412](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L412) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:418](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L418) ___ @@ -419,73 +446,73 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/knex/src/AbstractSqlDriver.ts:510](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L510) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:516](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L516) ___ ### find -▸ find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> +▸ find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| string \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| ... \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| Returns: Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L36) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L36) ___ ### findOne -▸ findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> +▸ findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +`options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| Returns: Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:74](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L74) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:75](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L75) ___ @@ -496,14 +523,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `type` \| read \\\| write \| 'write' \| Returns: C Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L83) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L83) ___ @@ -515,7 +542,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L113) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L123) ___ @@ -526,59 +553,59 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`qb` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| - \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| -`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| ... \| -`parentTableAlias?` \| string \| - \| -`parentJoinPath?` \| string \| - \| +Name \| Type \| +:------ \| :------ \| +`qb` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| +`parentTableAlias?` \| string \| +`parentJoinPath?` \| string \| Returns: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:460](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L460) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:466](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L466) ___ ### getPivotInverseProperty -▸ `Protected`getPivotInverseProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +▸ `Protected`getPivotInverseProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:190](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L190) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:200](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L200) ___ ### getPivotOrderBy -▸ `Protected`getPivotOrderBy(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): [QueryOrderMap](../interfaces/core.queryordermap.md) +▸ `Protected`getPivotOrderBy(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): [QueryOrderMap](../interfaces/core.queryordermap.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: [QueryOrderMap](../interfaces/core.queryordermap.md) Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:169](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L169) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:179](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L179) ___ @@ -590,7 +617,7 @@ ___ Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L28) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L28) ___ @@ -601,14 +628,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string[] Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:185](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L185) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:195](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L195) ___ @@ -619,13 +646,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `data` \| T \| `where?` \| boolean \| @@ -634,114 +661,114 @@ Name \| Type \| Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:121](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L121) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L131) ___ ### joinedProps -▸ `Protected`joinedProps<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[]): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] +▸ `Protected`joinedProps<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[]): [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:432](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L432) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:438](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L438) ___ ### loadFromPivotTable -▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> +▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| -`owners` \| [Primary](../modules/core.md#primary)<O\\>[][] \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| - \| -`ctx?` \| any \| - \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| - \| +Name \| Type \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`owners` \| [Primary](../modules/core.md#primary)<O\\>[][] \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| +`ctx?` \| any \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:381](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L381) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:382](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L382) ___ ### lockPessimistic -▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> +▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `mode` \| [LockMode](../enums/core.lockmode.md) \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:578](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L578) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:584](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L584) ___ ### mapJoinedProps -▸ `Private`mapJoinedProps<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `qb`: [QueryBuilder](knex.querybuilder.md)<T\\>, `root`: [EntityData](../modules/core.md#entitydata)<T\\>, `map`: [Dictionary](../modules/core.md#dictionary)<any\\>, `parentJoinPath?`: string): void +▸ `Private`mapJoinedProps<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `qb`: [QueryBuilder](knex.querybuilder.md)<T\\>, `root`: [EntityData](../modules/core.md#entitydata)<T\\>, `map`: [Dictionary](../modules/core.md#dictionary)<any\\>, `parentJoinPath?`: string): void #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| `qb` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| `root` \| [EntityData](../modules/core.md#entitydata)<T\\> \| -`map` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`map` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| `parentJoinPath?` \| string \| Returns: void -Defined in: [packages/knex/src/AbstractSqlDriver.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L104) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L105) ___ @@ -754,48 +781,48 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `tableAlias?` \| string \| Returns: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:485](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L485) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:491](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L491) ___ ### mapResult -▸ mapResult<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `qb?`: [QueryBuilder](knex.querybuilder.md)<T\\>, `map?`: [Dictionary](../modules/core.md#dictionary)<any\\>): null \\\| [EntityData](../modules/core.md#entitydata)<T\\> +▸ mapResult<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[], `qb?`: [QueryBuilder](knex.querybuilder.md)<T\\>, `map?`: [Dictionary](../modules/core.md#dictionary)<any\\>): null \\\| [EntityData](../modules/core.md#entitydata)<T\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| -`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| ... \| -`qb?` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| - \| -`map` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| +`qb?` \| [QueryBuilder](knex.querybuilder.md)<T\\> \| +`map` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: null \\\| [EntityData](../modules/core.md#entitydata)<T\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L89) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L90) ___ @@ -808,92 +835,92 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `rawResults` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| Returns: [EntityData](../modules/core.md#entitydata)<T\\>[] -Defined in: [packages/knex/src/AbstractSqlDriver.ts:442](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L442) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:448](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L448) ___ ### nativeDelete -▸ nativeDelete<T\\>(`entityName`: string, `where`: any, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> +▸ nativeDelete<T\\>(`entityName`: string, `where`: any, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| any \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| Returns: Promise<[QueryResult](../interfaces/core.queryresult.md)\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:336](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L336) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:337](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L337) ___ ### nativeInsert -▸ nativeInsert<T\\>(`entityName`: string, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> +▸ nativeInsert<T\\>(`entityName`: string, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| - \| `convertCustomTypes` \| boolean \| true \| Returns: Promise<[QueryResult](../interfaces/core.queryresult.md)\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L184) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:185](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L185) ___ ### nativeInsertMany -▸ nativeInsertMany<T\\>(`entityName`: string, `data`: [EntityData](../modules/core.md#entitydata)<T\\>[], `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `processCollections?`: boolean, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> +▸ nativeInsertMany<T\\>(`entityName`: string, `data`: [EntityData](../modules/core.md#entitydata)<T\\>[], `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `processCollections?`: boolean, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| - \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| - \| `processCollections` \| boolean \| true \| `convertCustomTypes` \| boolean \| true \| @@ -901,56 +928,56 @@ Name \| Type \| Default value \| Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:206](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L206) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:207](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L207) ___ ### nativeUpdate -▸ nativeUpdate<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> +▸ nativeUpdate<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| - \| `convertCustomTypes` \| boolean \| true \| Returns: Promise<[QueryResult](../interfaces/core.queryresult.md)\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:262](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L262) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:263](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L263) ___ ### nativeUpdateMany -▸ nativeUpdateMany<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>[], `data`: [EntityData](../modules/core.md#entitydata)<T\\>[], `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `processCollections?`: boolean, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> +▸ nativeUpdateMany<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>[], `data`: [EntityData](../modules/core.md#entitydata)<T\\>[], `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `processCollections?`: boolean, `convertCustomTypes?`: boolean): Promise<[QueryResult](../interfaces/core.queryresult.md)\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `entityName` \| string \| - \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\>[] \| - \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| - \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| - \| `processCollections` \| boolean \| true \| `convertCustomTypes` \| boolean \| true \| @@ -958,33 +985,33 @@ Name \| Type \| Default value \| Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:286](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L286) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:287](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L287) ___ ### processManyToMany -▸ `Protected`processManyToMany<T\\>(`meta`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<T\\>, `pks`: [Primary](../modules/core.md#primary)<T\\>[], `collections`: [EntityData](../modules/core.md#entitydata)<T\\>, `clear`: boolean, `ctx?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>): Promise<void\\> +▸ `Protected`processManyToMany<T\\>(`meta`: undefined \\\| [EntityMetadata](core.entitymetadata.md)<T\\>, `pks`: [Primary](../modules/core.md#primary)<T\\>[], `collections`: [EntityData](../modules/core.md#entitydata)<T\\>, `clear`: boolean, `ctx?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| undefined \\\| [EntityMetadata](core.entitymetadata.md)<T\\> \| `pks` \| [Primary](../modules/core.md#primary)<T\\>[] \| `collections` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `clear` \| boolean \| -`ctx?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| +`ctx?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/AbstractSqlDriver.ts:527](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L527) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:533](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L533) ___ @@ -996,7 +1023,7 @@ ___ Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L78) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L78) ___ @@ -1007,20 +1034,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `promise` \| Promise<T\\> \| Returns: Promise<T\\> Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L252) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:262](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L262) ___ @@ -1031,14 +1058,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| Returns: void Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L102) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L112) ___ @@ -1051,13 +1078,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| - \| `includeFormulas` \| boolean \| true \| @@ -1066,51 +1093,51 @@ Name \| Type \| Default value \| Inherited from: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/core/src/drivers/DatabaseDriver.ts:225](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/DatabaseDriver.ts#L225) +Defined in: [packages/core/src/drivers/DatabaseDriver.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/DatabaseDriver.ts#L235) ___ ### syncCollection -▸ syncCollection<T, O\\>(`coll`: [Collection](core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> +▸ syncCollection<T, O\\>(`coll`: [Collection](core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `coll` \| [Collection](core.collection.md)<T, O\\> \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [DatabaseDriver](core.databasedriver.md) -Defined in: [packages/knex/src/AbstractSqlDriver.ts:348](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L348) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:349](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L349) ___ ### updateCollectionDiff -▸ `Protected`updateCollectionDiff<T, O\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<O\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `pks`: [Primary](../modules/core.md#primary)<O\\>[], `deleteDiff`: boolean \\\| [Primary](../modules/core.md#primary)<T\\>[][], `insertDiff`: [Primary](../modules/core.md#primary)<T\\>[][], `ctx?`: any): Promise<void\\> +▸ `Protected`updateCollectionDiff<T, O\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<O\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `pks`: [Primary](../modules/core.md#primary)<O\\>[], `deleteDiff`: boolean \\\| [Primary](../modules/core.md#primary)<T\\>[][], `insertDiff`: [Primary](../modules/core.md#primary)<T\\>[][], `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<O\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `pks` \| [Primary](../modules/core.md#primary)<O\\>[] \| @@ -1118,6 +1145,6 @@ Name \| Type \| `insertDiff` \| [Primary](../modules/core.md#primary)<T\\>[][] \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/AbstractSqlDriver.ts:539](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlDriver.ts#L539) +Defined in: [packages/knex/src/AbstractSqlDriver.ts:545](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlDriver.ts#L545) diff --git a/knex.abstractsqlplatform.md b/knex.abstractsqlplatform.md index 8a3a6a3..c7149e0 100644 --- a/knex.abstractsqlplatform.md +++ b/knex.abstractsqlplatform.md @@ -2,6 +2,7 @@ id: "knex.abstractsqlplatform" title: "Class: AbstractSqlPlatform" sidebar_label: "AbstractSqlPlatform" +custom_edit_url: null hide_title: true --- @@ -33,7 +34,7 @@ Inherited from: [Platform](core.platform.md) Inherited from: [Platform](core.platform.md).[config](core.platform.md#config) -Defined in: [packages/core/src/platforms/Platform.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L11) +Defined in: [packages/core/src/platforms/Platform.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L11) ___ @@ -43,25 +44,25 @@ ___ Inherited from: [Platform](core.platform.md).[exceptionConverter](core.platform.md#exceptionconverter) -Defined in: [packages/core/src/platforms/Platform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L10) +Defined in: [packages/core/src/platforms/Platform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L10) ___ ### schemaHelper -• `Protected` `Optional` `Readonly` schemaHelper: undefined \\\| [SchemaHelper](knex.schemahelper.md) +• `Protected` `Optional` `Readonly` schemaHelper: [SchemaHelper](knex.schemahelper.md) -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L8) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L8) ___ ### timezone -• `Protected` `Optional` timezone: undefined \\\| string +• `Protected` `Optional` timezone: string Inherited from: [Platform](core.platform.md).[timezone](core.platform.md#timezone) -Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L12) +Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L12) ## Methods @@ -73,7 +74,7 @@ Defined in: [packages/core/src/platforms/Platform.ts:12](https://github.com/mikr Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L120) +Defined in: [packages/core/src/platforms/Platform.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L120) ___ @@ -85,7 +86,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L46) +Defined in: [packages/core/src/platforms/Platform.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L46) ___ @@ -97,7 +98,31 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L124) +Defined in: [packages/core/src/platforms/Platform.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L124) + +___ + +### cloneEmbeddable + +▸ cloneEmbeddable<T\\>(`data`: T): T + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| T \| + +Returns: T + +Overrides: [Platform](core.platform.md) + +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L73) ___ @@ -108,14 +133,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `marshall` \| boolean \| false \| Returns: boolean Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:168](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L168) +Defined in: [packages/core/src/platforms/Platform.ts:172](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L172) ___ @@ -128,14 +153,14 @@ Converts scalar primary key representation to native driver wrapper (e.g. string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| IPrimaryKeyValue \| Returns: IPrimaryKeyValue Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L78) +Defined in: [packages/core/src/platforms/Platform.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L78) ___ @@ -146,13 +171,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| string \| `params` \| readonly any[] \| Returns: string -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L36) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L36) ___ @@ -164,7 +189,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:140](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L140) +Defined in: [packages/core/src/platforms/Platform.ts:140](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L140) ___ @@ -176,7 +201,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L136) +Defined in: [packages/core/src/platforms/Platform.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L136) ___ @@ -188,7 +213,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L156) +Defined in: [packages/core/src/platforms/Platform.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L156) ___ @@ -201,14 +226,14 @@ Returns the SQL specific for the platform to get the current timestamp #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L96) +Defined in: [packages/core/src/platforms/Platform.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L96) ___ @@ -219,14 +244,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L100) +Defined in: [packages/core/src/platforms/Platform.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L100) ___ @@ -238,7 +263,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:176](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L176) +Defined in: [packages/core/src/platforms/Platform.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L180) ___ @@ -250,7 +275,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L180) +Defined in: [packages/core/src/platforms/Platform.ts:184](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L184) ___ @@ -262,7 +287,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L160) +Defined in: [packages/core/src/platforms/Platform.ts:160](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L160) ___ @@ -270,11 +295,11 @@ ___ ▸ getNamingStrategy(): function -Returns: function +Returns: () => [NamingStrategy](../interfaces/core.namingstrategy.md) Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L26) +Defined in: [packages/core/src/platforms/Platform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L26) ___ @@ -286,7 +311,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L108) +Defined in: [packages/core/src/platforms/Platform.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L108) ___ @@ -297,14 +322,14 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| Returns: [Constructor](../modules/core.md#constructor)<[EntityRepository](core.entityrepository.md)<T\\>\\> Overrides: [Platform](core.platform.md) -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L14) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L14) ___ @@ -315,14 +340,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [SchemaGenerator](knex.schemagenerator.md) Overrides: [Platform](core.platform.md) -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L22) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L22) ___ @@ -334,25 +359,45 @@ ___ Overrides: [Platform](core.platform.md) -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L18) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L18) + +___ + +### getSearchJsonPropertyKey + +▸ getSearchJsonPropertyKey(`path`: string[], `type`: string): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`path` \| string[] \| +`type` \| string \| + +Returns: string + +Inherited from: [Platform](core.platform.md) + +Defined in: [packages/core/src/platforms/Platform.ts:168](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L168) ___ ### getSearchJsonPropertySQL -▸ getSearchJsonPropertySQL(`path`: string): string +▸ getSearchJsonPropertySQL(`path`: string, `type`: string): string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| +`type` \| string \| Returns: string -Inherited from: [Platform](core.platform.md) +Overrides: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:164](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L164) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L69) ___ @@ -365,14 +410,14 @@ Used when serializing via toObject and toJSON methods, allows to use different P #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: string Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L85) +Defined in: [packages/core/src/platforms/Platform.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L85) ___ @@ -383,32 +428,32 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `length` \| number \| Returns: string Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L104) +Defined in: [packages/core/src/platforms/Platform.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L104) ___ ### isBigIntProperty -▸ isBigIntProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): boolean +▸ isBigIntProperty(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: boolean Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L128) +Defined in: [packages/core/src/platforms/Platform.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L128) ___ @@ -419,14 +464,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: boolean -Inherited from: [Platform](core.platform.md) +Overrides: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:132](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L132) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L77) ___ @@ -437,40 +482,40 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `values` \| string[] \| Returns: string Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:144](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L144) +Defined in: [packages/core/src/platforms/Platform.ts:144](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L144) ___ ### normalizePrimaryKey -▸ normalizePrimaryKey<T\\>(`data`: string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Primary](../modules/core.md#primary)<T\\>): T +▸ normalizePrimaryKey<T\\>(`data`: IPrimaryKeyValue \\\| [Primary](../modules/core.md#primary)<T\\>): T Normalizes primary key wrapper to scalar value (e.g. mongodb's ObjectId to string) #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| string \\\| number \| string \\\\\| number \| +:------ \| :------ \| :------ \| +`T` \| string \\\| number \| string \\\| number \| #### Parameters: Name \| Type \| ------- \| ------ \| -`data` \| string \\\| number \\\| bigint \\\| Date \\\| { `toHexString`: () => string } \\\| [Primary](../modules/core.md#primary)<T\\> \| +:------ \| :------ \| +`data` \| IPrimaryKeyValue \\\| [Primary](../modules/core.md#primary)<T\\> \| Returns: T Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L71) +Defined in: [packages/core/src/platforms/Platform.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L71) ___ @@ -481,14 +526,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| unknown \| Returns: string \\\| number \\\| Date Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:188](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L188) +Defined in: [packages/core/src/platforms/Platform.ts:192](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L192) ___ @@ -499,7 +544,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `id` \| string \| - \| `quote` \| string \| '\\`' \| @@ -507,7 +552,7 @@ Name \| Type \| Default value \| Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:192](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L192) +Defined in: [packages/core/src/platforms/Platform.ts:196](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L196) ___ @@ -518,31 +563,33 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: string -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L26) +Overrides: [Platform](core.platform.md) + +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L26) ___ ### quoteVersionValue -▸ quoteVersionValue(`value`: number \\\| Date, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string \\\| number \\\| Date +▸ quoteVersionValue(`value`: number \\\| Date, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string \\\| number \\\| Date #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| number \\\| Date \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: string \\\| number \\\| Date Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:112](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L112) +Defined in: [packages/core/src/platforms/Platform.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L112) ___ @@ -554,7 +601,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L42) +Defined in: [packages/core/src/platforms/Platform.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L42) ___ @@ -566,7 +613,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L116) +Defined in: [packages/core/src/platforms/Platform.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L116) ___ @@ -577,14 +624,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: void Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:196](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L196) +Defined in: [packages/core/src/platforms/Platform.ts:208](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L208) ___ @@ -596,7 +643,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L18) +Defined in: [packages/core/src/platforms/Platform.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L18) ___ @@ -607,14 +654,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| string \| Returns: string[] Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:148](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L148) +Defined in: [packages/core/src/platforms/Platform.ts:148](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L148) ___ @@ -628,7 +675,7 @@ Whether or not the driver supports retuning list of created PKs back when multi- Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L53) +Defined in: [packages/core/src/platforms/Platform.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L53) ___ @@ -642,7 +689,7 @@ Whether or not the driver supports updating many records at once Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L60) +Defined in: [packages/core/src/platforms/Platform.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L60) ___ @@ -654,7 +701,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L34) +Defined in: [packages/core/src/platforms/Platform.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L34) ___ @@ -666,7 +713,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L64) +Defined in: [packages/core/src/platforms/Platform.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L64) ___ @@ -678,7 +725,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L89) +Defined in: [packages/core/src/platforms/Platform.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L89) ___ @@ -690,7 +737,7 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L22) +Defined in: [packages/core/src/platforms/Platform.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L22) ___ @@ -702,7 +749,7 @@ ___ Overrides: [Platform](core.platform.md) -Defined in: [packages/knex/src/AbstractSqlPlatform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/AbstractSqlPlatform.ts#L10) +Defined in: [packages/knex/src/AbstractSqlPlatform.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/AbstractSqlPlatform.ts#L10) ___ @@ -714,4 +761,4 @@ ___ Inherited from: [Platform](core.platform.md) -Defined in: [packages/core/src/platforms/Platform.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/platforms/Platform.ts#L30) +Defined in: [packages/core/src/platforms/Platform.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/platforms/Platform.ts#L30) diff --git a/knex.arraycriterianode.md b/knex.arraycriterianode.md index 4c82fb7..5515176 100644 --- a/knex.arraycriterianode.md +++ b/knex.arraycriterianode.md @@ -2,6 +2,7 @@ id: "knex.arraycriterianode" title: "Class: ArrayCriteriaNode" sidebar_label: "ArrayCriteriaNode" +custom_edit_url: null hide_title: true --- @@ -24,7 +25,7 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `entityName` \| string \| - \| `parent?` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| - \| @@ -35,7 +36,7 @@ Name \| Type \| Default value \| Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Properties @@ -49,7 +50,7 @@ ___ ### key -• `Optional` `Readonly` key: undefined \\\| string +• `Optional` `Readonly` key: string Inherited from: [CriteriaNode](knex.criterianode.md).[key](knex.criterianode.md#key) @@ -65,7 +66,7 @@ ___ ### parent -• `Optional` `Readonly` parent: undefined \\\| [ICriteriaNode](../interfaces/knex.icriterianode.md) +• `Optional` `Readonly` parent: [ICriteriaNode](../interfaces/knex.icriterianode.md) Inherited from: [CriteriaNode](knex.criterianode.md).[parent](knex.criterianode.md#parent) @@ -77,29 +78,29 @@ ___ Inherited from: [CriteriaNode](knex.criterianode.md).[payload](knex.criterianode.md#payload) -Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L11) +Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L11) ___ ### prop -• `Optional` prop: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +• `Optional` prop: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> Inherited from: [CriteriaNode](knex.criterianode.md).[prop](knex.criterianode.md#prop) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L119) +Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L119) ___ @@ -111,7 +112,7 @@ ___ Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ArrayCriteriaNode.ts#L18) +Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ArrayCriteriaNode.ts#L18) ___ @@ -122,14 +123,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L115) +Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L115) ___ @@ -140,13 +141,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -154,7 +155,7 @@ Name \| Type \| Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ArrayCriteriaNode.ts#L6) +Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ArrayCriteriaNode.ts#L6) ___ @@ -165,20 +166,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L64) +Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L64) ___ @@ -189,14 +190,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L36) +Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L36) ___ @@ -207,14 +208,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L44) +Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L44) ___ @@ -225,13 +226,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -239,7 +240,7 @@ Name \| Type \| Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ArrayCriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/ArrayCriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ArrayCriteriaNode.ts#L12) ___ @@ -250,11 +251,11 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L123) +Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L123) diff --git a/knex.criterianode.md b/knex.criterianode.md index 58a7974..94152fd 100644 --- a/knex.criterianode.md +++ b/knex.criterianode.md @@ -2,6 +2,7 @@ id: "knex.criterianode" title: "Class: CriteriaNode" sidebar_label: "CriteriaNode" +custom_edit_url: null hide_title: true --- @@ -31,7 +32,7 @@ Auto-joins relations and converts payload from { books: { publisher: { name: '.. #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `entityName` \| string \| - \| `parent?` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| - \| @@ -40,7 +41,7 @@ Name \| Type \| Default value \| Returns: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Properties @@ -52,7 +53,7 @@ ___ ### key -• `Optional` `Readonly` key: undefined \\\| string +• `Optional` `Readonly` key: string ___ @@ -64,7 +65,7 @@ ___ ### parent -• `Optional` `Readonly` parent: undefined \\\| [ICriteriaNode](../interfaces/knex.icriterianode.md) +• `Optional` `Readonly` parent: [ICriteriaNode](../interfaces/knex.icriterianode.md) ___ @@ -72,25 +73,25 @@ ___ • payload: any -Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L11) +Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L11) ___ ### prop -• `Optional` prop: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +• `Optional` prop: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string -Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L119) +Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L119) ___ @@ -100,7 +101,7 @@ ___ Returns: string -Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L78) +Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L78) ___ @@ -111,12 +112,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: string -Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L115) +Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L115) ___ @@ -126,7 +127,7 @@ ___ Returns: boolean -Defined in: [packages/knex/src/query/CriteriaNode.ts:103](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L103) +Defined in: [packages/knex/src/query/CriteriaNode.ts:103](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L103) ___ @@ -137,19 +138,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| Returns: any -Defined in: [packages/knex/src/query/CriteriaNode.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L32) +Defined in: [packages/knex/src/query/CriteriaNode.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L32) ___ @@ -160,18 +161,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| Returns: string -Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L64) +Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L64) ___ @@ -182,12 +183,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean -Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L36) +Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L36) ___ @@ -198,12 +199,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean -Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L44) +Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L44) ___ @@ -214,19 +215,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| Returns: boolean -Defined in: [packages/knex/src/query/CriteriaNode.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L40) +Defined in: [packages/knex/src/query/CriteriaNode.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L40) ___ @@ -237,9 +238,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: boolean -Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L123) +Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L123) diff --git a/knex.criterianodefactory.md b/knex.criterianodefactory.md index f65465f..90e4d73 100644 --- a/knex.criterianodefactory.md +++ b/knex.criterianodefactory.md @@ -2,6 +2,7 @@ id: "knex.criterianodefactory" title: "Class: CriteriaNodeFactory" sidebar_label: "CriteriaNodeFactory" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [knex](../modules/knex.md).CriteriaNodeFactory -## Hierarchy - -* CriteriaNodeFactory - ## Constructors ### constructor @@ -30,7 +27,7 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `entityName` \| string \| `payload` \| any[] \| @@ -39,7 +36,7 @@ Name \| Type \| Returns: [ICriteriaNode](../interfaces/knex.icriterianode.md) -Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNodeFactory.ts#L32) +Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNodeFactory.ts#L32) ___ @@ -50,7 +47,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `entityName` \| string \| `payload` \| any \| @@ -59,48 +56,48 @@ Name \| Type \| Returns: [ICriteriaNode](../interfaces/knex.icriterianode.md) -Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNodeFactory.ts#L10) +Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNodeFactory.ts#L10) ___ ### createObjectItemNode -▸ `Static`createObjectItemNode(`metadata`: [MetadataStorage](core.metadatastorage.md), `entityName`: string, `node`: [ICriteriaNode](../interfaces/knex.icriterianode.md), `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `item`: string, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ICriteriaNode](../interfaces/knex.icriterianode.md) +▸ `Static`createObjectItemNode(`metadata`: [MetadataStorage](core.metadatastorage.md), `entityName`: string, `node`: [ICriteriaNode](../interfaces/knex.icriterianode.md), `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `item`: string, `meta?`: [EntityMetadata](core.entitymetadata.md)<any\\>): [ICriteriaNode](../interfaces/knex.icriterianode.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `entityName` \| string \| `node` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| `item` \| string \| -`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`meta?` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: [ICriteriaNode](../interfaces/knex.icriterianode.md) -Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNodeFactory.ts#L55) +Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNodeFactory.ts#L55) ___ ### createObjectNode -▸ `Static`createObjectNode(`metadata`: [MetadataStorage](core.metadatastorage.md), `entityName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `parent?`: [ICriteriaNode](../interfaces/knex.icriterianode.md), `key?`: string): [ICriteriaNode](../interfaces/knex.icriterianode.md) +▸ `Static`createObjectNode(`metadata`: [MetadataStorage](core.metadatastorage.md), `entityName`: string, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `parent?`: [ICriteriaNode](../interfaces/knex.icriterianode.md), `key?`: string): [ICriteriaNode](../interfaces/knex.icriterianode.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `entityName` \| string \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| `parent?` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| `key?` \| string \| Returns: [ICriteriaNode](../interfaces/knex.icriterianode.md) -Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNodeFactory.ts#L39) +Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNodeFactory.ts#L39) ___ @@ -111,7 +108,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| `entityName` \| string \| `payload` \| any \| @@ -120,4 +117,4 @@ Name \| Type \| Returns: [ICriteriaNode](../interfaces/knex.icriterianode.md) -Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNodeFactory.ts#L25) +Defined in: [packages/knex/src/query/CriteriaNodeFactory.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNodeFactory.ts#L25) diff --git a/knex.databaseschema.md b/knex.databaseschema.md index 3c76936..bd91149 100644 --- a/knex.databaseschema.md +++ b/knex.databaseschema.md @@ -2,6 +2,7 @@ id: "knex.databaseschema" title: "Class: DatabaseSchema" sidebar_label: "DatabaseSchema" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [knex](../modules/knex.md).DatabaseSchema -## Hierarchy - -* DatabaseSchema - ## Constructors ### constructor @@ -27,7 +24,7 @@ hide_title: true • `Private` `Readonly` tables: [DatabaseTable](knex.databasetable.md)[] -Defined in: [packages/knex/src/schema/DatabaseSchema.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseSchema.ts#L9) +Defined in: [packages/knex/src/schema/DatabaseSchema.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseSchema.ts#L9) ## Methods @@ -38,13 +35,13 @@ Defined in: [packages/knex/src/schema/DatabaseSchema.ts:9](https://github.com/mi #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `schema` \| undefined \\\| null \\\| string \| Returns: [DatabaseTable](knex.databasetable.md) -Defined in: [packages/knex/src/schema/DatabaseSchema.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseSchema.ts#L11) +Defined in: [packages/knex/src/schema/DatabaseSchema.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseSchema.ts#L11) ___ @@ -55,12 +52,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: undefined \\\| [DatabaseTable](knex.databasetable.md) -Defined in: [packages/knex/src/schema/DatabaseSchema.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseSchema.ts#L22) +Defined in: [packages/knex/src/schema/DatabaseSchema.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseSchema.ts#L22) ___ @@ -70,7 +67,7 @@ ___ Returns: [DatabaseTable](knex.databasetable.md)[] -Defined in: [packages/knex/src/schema/DatabaseSchema.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseSchema.ts#L18) +Defined in: [packages/knex/src/schema/DatabaseSchema.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseSchema.ts#L18) ___ @@ -81,11 +78,11 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `helper` \| [SchemaHelper](knex.schemahelper.md) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: Promise<[DatabaseSchema](knex.databaseschema.md)\\> -Defined in: [packages/knex/src/schema/DatabaseSchema.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseSchema.ts#L26) +Defined in: [packages/knex/src/schema/DatabaseSchema.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseSchema.ts#L26) diff --git a/knex.databasetable.md b/knex.databasetable.md index bca965f..45090a5 100644 --- a/knex.databasetable.md +++ b/knex.databasetable.md @@ -2,6 +2,7 @@ id: "knex.databasetable" title: "Class: DatabaseTable" sidebar_label: "DatabaseTable" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [knex](../modules/knex.md).DatabaseTable -## Hierarchy - -* DatabaseTable - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `schema?` \| string \| Returns: [DatabaseTable](knex.databasetable.md) -Defined in: [packages/knex/src/schema/DatabaseTable.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L9) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L9) ## Properties @@ -36,7 +33,7 @@ Defined in: [packages/knex/src/schema/DatabaseTable.ts:9](https://github.com/mik • `Private` columns: [Dictionary](../modules/core.md#dictionary)<[Column](../interfaces/knex.column.md)\\> -Defined in: [packages/knex/src/schema/DatabaseTable.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L7) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L7) ___ @@ -44,7 +41,7 @@ ___ • `Private` foreignKeys: [Dictionary](../modules/core.md#dictionary)<[ForeignKey](../interfaces/knex.foreignkey.md)\\> -Defined in: [packages/knex/src/schema/DatabaseTable.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L9) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L9) ___ @@ -52,7 +49,7 @@ ___ • `Private` indexes: [Index](../interfaces/knex.index.md)[] -Defined in: [packages/knex/src/schema/DatabaseTable.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L8) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L8) ___ @@ -64,7 +61,7 @@ ___ ### schema -• `Optional` `Readonly` schema: undefined \\\| string +• `Optional` `Readonly` schema: string ## Methods @@ -75,12 +72,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: undefined \\\| [Column](../interfaces/knex.column.md) -Defined in: [packages/knex/src/schema/DatabaseTable.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L18) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L18) ___ @@ -90,24 +87,24 @@ ___ Returns: [Column](../interfaces/knex.column.md)[] -Defined in: [packages/knex/src/schema/DatabaseTable.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L14) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L14) ___ ### getEntityDeclaration -▸ getEntityDeclaration(`namingStrategy`: [NamingStrategy](../interfaces/core.namingstrategy.md), `schemaHelper`: [SchemaHelper](knex.schemahelper.md)): [EntityMetadata](core.entitymetadata.md)<any\\> +▸ getEntityDeclaration(`namingStrategy`: [NamingStrategy](../interfaces/core.namingstrategy.md), `schemaHelper`: [SchemaHelper](knex.schemahelper.md)): [EntityMetadata](core.entitymetadata.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `namingStrategy` \| [NamingStrategy](../interfaces/core.namingstrategy.md) \| `schemaHelper` \| [SchemaHelper](knex.schemahelper.md) \| -Returns: [EntityMetadata](core.entitymetadata.md)<any\\> +Returns: [EntityMetadata](core.entitymetadata.md)<any\\> -Defined in: [packages/knex/src/schema/DatabaseTable.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L58) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L58) ___ @@ -117,27 +114,27 @@ ___ Returns: [Dictionary](../modules/core.md#dictionary)<[Index](../interfaces/knex.index.md)[]\\> -Defined in: [packages/knex/src/schema/DatabaseTable.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L22) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L22) ___ ### getPropertyDeclaration -▸ `Private`getPropertyDeclaration(`column`: [Column](../interfaces/knex.column.md), `namingStrategy`: [NamingStrategy](../interfaces/core.namingstrategy.md), `schemaHelper`: [SchemaHelper](knex.schemahelper.md), `compositeFkIndexes`: [Dictionary](../modules/core.md#dictionary)<{ `keyName`: string }\\>, `schema`: [EntitySchema](core.entityschema.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, undefined\\>): void +▸ `Private`getPropertyDeclaration(`column`: [Column](../interfaces/knex.column.md), `namingStrategy`: [NamingStrategy](../interfaces/core.namingstrategy.md), `schemaHelper`: [SchemaHelper](knex.schemahelper.md), `compositeFkIndexes`: [Dictionary](../modules/core.md#dictionary)<{ `keyName`: string }\\>, `schema`: [EntitySchema](core.entityschema.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, undefined\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| [Column](../interfaces/knex.column.md) \| `namingStrategy` \| [NamingStrategy](../interfaces/core.namingstrategy.md) \| `schemaHelper` \| [SchemaHelper](knex.schemahelper.md) \| `compositeFkIndexes` \| [Dictionary](../modules/core.md#dictionary)<{ `keyName`: string }\\> \| -`schema` \| [EntitySchema](core.entityschema.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, undefined\\> \| +`schema` \| [EntitySchema](core.entityschema.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>, undefined\\> \| Returns: void -Defined in: [packages/knex/src/schema/DatabaseTable.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L91) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L91) ___ @@ -148,7 +145,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `schemaHelper` \| [SchemaHelper](knex.schemahelper.md) \| - \| `column` \| [Column](../interfaces/knex.column.md) \| - \| `propType` \| string \| - \| @@ -156,7 +153,7 @@ Name \| Type \| Default value \| Returns: any -Defined in: [packages/knex/src/schema/DatabaseTable.ts:157](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L157) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:157](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L157) ___ @@ -167,12 +164,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| [Column](../interfaces/knex.column.md) \| Returns: string -Defined in: [packages/knex/src/schema/DatabaseTable.ts:133](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L133) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:133](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L133) ___ @@ -183,7 +180,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `namingStrategy` \| [NamingStrategy](../interfaces/core.namingstrategy.md) \| - \| `schemaHelper` \| [SchemaHelper](knex.schemahelper.md) \| - \| `column` \| [Column](../interfaces/knex.column.md) \| - \| @@ -191,7 +188,7 @@ Name \| Type \| Default value \| Returns: string -Defined in: [packages/knex/src/schema/DatabaseTable.ts:143](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L143) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L143) ___ @@ -202,29 +199,29 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| [Column](../interfaces/knex.column.md) \| Returns: [ReferenceType](../enums/core.referencetype.md) -Defined in: [packages/knex/src/schema/DatabaseTable.ts:121](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L121) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:121](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L121) ___ ### init -▸ init(`cols`: [Column](../interfaces/knex.column.md)[], `indexes`: [Index](../interfaces/knex.index.md)[], `pks`: string[], `fks`: [Dictionary](../modules/core.md#dictionary)<[ForeignKey](../interfaces/knex.foreignkey.md)\\>, `enums`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): void +▸ init(`cols`: [Column](../interfaces/knex.column.md)[], `indexes`: [Index](../interfaces/knex.index.md)[], `pks`: string[], `fks`: [Dictionary](../modules/core.md#dictionary)<[ForeignKey](../interfaces/knex.foreignkey.md)\\>, `enums`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cols` \| [Column](../interfaces/knex.column.md)[] \| `indexes` \| [Index](../interfaces/knex.index.md)[] \| `pks` \| string[] \| `fks` \| [Dictionary](../modules/core.md#dictionary)<[ForeignKey](../interfaces/knex.foreignkey.md)\\> \| -`enums` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| +`enums` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| Returns: void -Defined in: [packages/knex/src/schema/DatabaseTable.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/DatabaseTable.ts#L35) +Defined in: [packages/knex/src/schema/DatabaseTable.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/DatabaseTable.ts#L35) diff --git a/knex.entitymanager.md b/knex.entitymanager.md index 448c993..b75c071 100644 --- a/knex.entitymanager.md +++ b/knex.entitymanager.md @@ -2,6 +2,7 @@ id: "knex.entitymanager" title: "Class: EntityManager<D>" sidebar_label: "EntityManager" +custom_edit_url: null hide_title: true --- @@ -14,7 +15,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `D` \| [AbstractSqlDriver](knex.abstractsqldriver.md) \| [AbstractSqlDriver](knex.abstractsqldriver.md) \| ## Hierarchy @@ -32,24 +33,24 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md), D\\> \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md), D\\> \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| - \| `driver` \| D \| - \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `useContext` \| boolean \| true \| -`eventManager` \| [EventManager](core.eventmanager.md) \| ... \| +`eventManager` \| [EventManager](core.eventmanager.md) \| - \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L33) +Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L33) ## Properties @@ -67,7 +68,7 @@ ___ Inherited from: [EntityManager](core.entitymanager.md).[id](core.entitymanager.md#id) -Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L22) +Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L22) ___ @@ -77,66 +78,66 @@ ___ Inherited from: [EntityManager](core.entitymanager.md).[name](core.entitymanager.md#name) -Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L23) +Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L23) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:940](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L940) +Defined in: [packages/core/src/EntityManager.ts:968](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L968) ___ ### addFilter -▸ addFilter<T1\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void +▸ addFilter<T1\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| -`entityName?` \| string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| +`entityName?` \| [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| `enabled?` \| boolean \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L145) +Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L145) -▸ addFilter<T1, T2\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>] \| `enabled?` \| boolean \| @@ -144,16 +145,16 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L150) +Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L150) -▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| `T3` \| [AnyEntity](../modules/core.md#anyentity)<T3\\> \| @@ -161,9 +162,9 @@ Name \| Type \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>] \| `enabled?` \| boolean \| @@ -171,7 +172,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L155) +Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L155) ___ @@ -182,13 +183,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| @@ -196,34 +197,36 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L193) +Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L193) ___ ### applyFilters -▸ `Protected`applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> + +`internal` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| +`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L205) +Defined in: [packages/core/src/EntityManager.ts:218](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L218) ___ @@ -236,42 +239,42 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| T \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:532](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L532) +Defined in: [packages/core/src/EntityManager.ts:546](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L546) ___ ### begin -▸ begin(`ctx?`: any): Promise<void\\> +▸ begin(`ctx?`: any): Promise<void\\> Starts new transaction bound to this EntityManager. Use `ctx` parameter to provide the parent when nesting transactions. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:381](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L381) +Defined in: [packages/core/src/EntityManager.ts:394](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L394) ___ @@ -284,13 +287,13 @@ Checks whether given property can be populated on the entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `property` \| string \| @@ -298,7 +301,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L698) +Defined in: [packages/core/src/EntityManager.ts:712](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L712) ___ @@ -312,78 +315,79 @@ Clears the EntityManager. All entities that are currently managed by this Entity Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:691](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L691) +Defined in: [packages/core/src/EntityManager.ts:705](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L705) ___ ### commit -▸ commit(): Promise<void\\> +▸ commit(): Promise<void\\> Commits the transaction bound to this EntityManager. Flushes before doing the actual commit query. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:388](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L388) +Defined in: [packages/core/src/EntityManager.ts:401](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L401) ___ ### count -▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:582](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L582) +Defined in: [packages/core/src/EntityManager.ts:596](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L596) ___ ### create -▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: undefined \\\| boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> +▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| { `managed?`: undefined \\\| boolean } \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| object \| +`options.managed?` \| boolean \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:525](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L525) +Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L539) ___ @@ -396,44 +400,44 @@ Creates a QueryBuilder instance #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `alias?` \| string \| `type?` \| read \\\| write \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L15) +Defined in: [packages/knex/src/SqlEntityManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L15) ___ ### execute -▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run): Promise<T\\> +▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run): Promise<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\\\>\\\\>[] \| +:------ \| :------ \| :------ \| +`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\> \| - \| -`params` \| any[] \| ... \| +:------ \| :------ \| :------ \| +`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| - \| +`params` \| any[] \| - \| `method` \| all \\\| get \\\| run \| 'all' \| Returns: Promise<T\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L27) +Defined in: [packages/knex/src/SqlEntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L27) ___ @@ -446,14 +450,14 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -462,7 +466,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L88) +Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L88) ▸ find<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -471,14 +475,14 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -490,7 +494,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L93) +Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L93) ___ @@ -504,14 +508,14 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -520,7 +524,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:248](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L248) +Defined in: [packages/core/src/EntityManager.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L261) ▸ findAndCount<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -530,14 +534,14 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -549,7 +553,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:254](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L254) +Defined in: [packages/core/src/EntityManager.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L267) ___ @@ -562,14 +566,14 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| @@ -578,7 +582,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:273](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L273) +Defined in: [packages/core/src/EntityManager.ts:286](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L286) ▸ findOne<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -587,14 +591,14 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -604,7 +608,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L278) +Defined in: [packages/core/src/EntityManager.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L291) ___ @@ -619,14 +623,14 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| @@ -635,7 +639,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:334](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L334) +Defined in: [packages/core/src/EntityManager.ts:347](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L347) ▸ findOneOrFail<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -646,14 +650,14 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -663,22 +667,22 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:341](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L341) +Defined in: [packages/core/src/EntityManager.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L354) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:684](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L684) +Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L698) ___ @@ -691,7 +695,7 @@ Returns new EntityManager instance with its own identity map #### Parameters: Name \| Type \| Default value \| Description \| ------- \| ------ \| ------ \| ------ \| +:------ \| :------ \| :------ \| :------ \| `clear` \| boolean \| true \| do we want clear identity map? defaults to true \| `useContext` \| boolean \| false \| use request context? should be used only for top level request scope EM, defaults to false \| @@ -699,7 +703,7 @@ Name \| Type \| Default value \| Description \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:755](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L755) +Defined in: [packages/core/src/EntityManager.ts:769](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L769) ___ @@ -713,7 +717,7 @@ Gets the EntityComparator. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L825) +Defined in: [packages/core/src/EntityManager.ts:853](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L853) ___ @@ -726,14 +730,14 @@ Gets the Connection instance, by default returns write connection #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| Returns: ReturnType<D[getConnection]\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L52) +Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L52) ___ @@ -747,7 +751,7 @@ Gets the EntityManager based on current transaction/request context. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L786) +Defined in: [packages/core/src/EntityManager.ts:800](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L800) ___ @@ -762,7 +766,7 @@ Driver is singleton, for one MikroORM instance, only one driver is created. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L45) +Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L45) ___ @@ -776,7 +780,7 @@ Gets the EntityFactory used by the EntityManager. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:779](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L779) +Defined in: [packages/core/src/EntityManager.ts:793](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L793) ___ @@ -788,7 +792,7 @@ ___ Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:797](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L797) +Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L811) ___ @@ -801,38 +805,38 @@ Returns filter parameters for given filter set in this context. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L181) +Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L181) ___ ### getKnex -▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> +▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> Returns configured knex instance. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L23) +Defined in: [packages/knex/src/SqlEntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L23) ___ @@ -846,7 +850,7 @@ Gets the MetadataStorage. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L818) +Defined in: [packages/core/src/EntityManager.ts:846](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L846) ___ @@ -860,7 +864,7 @@ Gets the platform instance. Just like the driver, platform is singleton, one for Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L59) +Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L59) ___ @@ -873,14 +877,14 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| @@ -890,7 +894,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L539) +Defined in: [packages/core/src/EntityManager.ts:553](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L553) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[]): T @@ -899,13 +903,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \| @@ -913,7 +917,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:544](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L544) +Defined in: [packages/core/src/EntityManager.ts:558](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L558) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false, `convertCustomTypes?`: boolean): T @@ -922,13 +926,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| @@ -938,7 +942,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:549](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L549) +Defined in: [packages/core/src/EntityManager.ts:563](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L563) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped?`: boolean, `convertCustomTypes?`: boolean): T \\\| [Reference](core.reference.md)<T\\> @@ -947,13 +951,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped?` \| boolean \| @@ -963,7 +967,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:554](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L554) +Defined in: [packages/core/src/EntityManager.ts:568](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L568) ___ @@ -974,21 +978,21 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](knex.entityrepository.md)<T\\\\> \| +`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](knex.entityrepository.md)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [GetRepository](../modules/core.md#getrepository)<T, U\\> Overrides: [EntityManager](core.entitymanager.md) -Defined in: [packages/knex/src/SqlEntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L31) +Defined in: [packages/knex/src/SqlEntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L31) ___ @@ -1001,14 +1005,14 @@ Gets the transaction context (driver dependent object used to make sure queries #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| unknown \| any \| Returns: undefined \\\| T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L811) +Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L825) ___ @@ -1022,7 +1026,7 @@ Gets the UnitOfWork used by the EntityManager to coordinate operations. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:772](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L772) +Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L786) ___ @@ -1036,7 +1040,7 @@ Gets EntityValidator instance Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L81) +Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L81) ___ @@ -1050,29 +1054,29 @@ Checks whether this EntityManager is currently operating inside a database trans Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:804](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L804) +Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L818) ___ ### lock -▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> +▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> Runs your callback wrapped inside a database transaction. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `lockMode` \| [LockMode](../enums/core.lockmode.md) \| `lockVersion?` \| number \\\| Date \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:405](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L405) +Defined in: [packages/core/src/EntityManager.ts:418](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L418) ___ @@ -1085,13 +1089,13 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -1099,7 +1103,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:468](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L468) +Defined in: [packages/core/src/EntityManager.ts:481](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L481) ___ @@ -1113,13 +1117,13 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `refresh?` \| boolean \| @@ -1127,7 +1131,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:487](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L487) +Defined in: [packages/core/src/EntityManager.ts:501](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L501) ▸ merge<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `refresh?`: boolean, `convertCustomTypes?`: boolean): T @@ -1137,13 +1141,13 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| @@ -1153,35 +1157,35 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:493](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L493) +Defined in: [packages/core/src/EntityManager.ts:507](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L507) ___ ### nativeDelete -▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> +▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:456](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L456) +Defined in: [packages/core/src/EntityManager.ts:469](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L469) ___ @@ -1194,20 +1198,20 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:412](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L412) +Defined in: [packages/core/src/EntityManager.ts:425](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L425) ▸ nativeInsert<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<[Primary](../modules/core.md#primary)<T\\>\\> @@ -1216,13 +1220,13 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -1230,42 +1234,42 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:417](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L417) +Defined in: [packages/core/src/EntityManager.ts:430](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L430) ___ ### nativeUpdate -▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> +▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:442](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L442) +Defined in: [packages/core/src/EntityManager.ts:455](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L455) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](knex.entitymanager.md)<D\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](knex.entitymanager.md)<D\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1273,20 +1277,20 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:603](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L603) +Defined in: [packages/core/src/EntityManager.ts:617](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L617) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -1294,20 +1298,20 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:628](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L628) +Defined in: [packages/core/src/EntityManager.ts:642](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L642) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1317,37 +1321,37 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:638](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L638) +Defined in: [packages/core/src/EntityManager.ts:652](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L652) ___ ### populate -▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1356,26 +1360,26 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:718](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L718) +Defined in: [packages/core/src/EntityManager.ts:732](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L732) -▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1384,26 +1388,26 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:723](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L723) +Defined in: [packages/core/src/EntityManager.ts:737](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L737) -▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1412,34 +1416,34 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:728](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L728) +Defined in: [packages/core/src/EntityManager.ts:742](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L742) ___ ### processWhere -▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L185) +Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L185) ___ @@ -1455,26 +1459,26 @@ To remove entities by condition, use `em.nativeDelete()`. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [Reference](core.reference.md)<T\\> \\\| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:648](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L648) +Defined in: [packages/core/src/EntityManager.ts:662](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L662) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -1482,20 +1486,20 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:666](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L666) +Defined in: [packages/core/src/EntityManager.ts:680](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L680) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -1505,34 +1509,48 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:676](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L676) +Defined in: [packages/core/src/EntityManager.ts:690](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L690) + +___ + +### resetTransactionContext + +▸ resetTransactionContext(): void + +Resets the transaction context. + +Returns: void + +Inherited from: [EntityManager](core.entitymanager.md) + +Defined in: [packages/core/src/EntityManager.ts:839](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L839) ___ ### rollback -▸ rollback(): Promise<void\\> +▸ rollback(): Promise<void\\> Rollbacks the transaction bound to this EntityManager. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:397](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L397) +Defined in: [packages/core/src/EntityManager.ts:410](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L410) ___ ### setFilterParams -▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void +▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void Sets filter parameter values globally inside context defined by this entity manager. If you want to set shared value for all contexts, be sure to use the root entity manager. @@ -1540,37 +1558,58 @@ If you want to set shared value for all contexts, be sure to use the root entity #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: void + +Inherited from: [EntityManager](core.entitymanager.md) + +Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L174) + +___ + +### setTransactionContext + +▸ setTransactionContext(`ctx`: any): void + +Sets the transaction context. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`ctx` \| any \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L174) +Defined in: [packages/core/src/EntityManager.ts:832](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L832) ___ ### storeCache -▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> +▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> `internal` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| -`key` \| { `key`: string } \| +`key` \| object \| +`key.key` \| string \| `data` \| unknown \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L932) +Defined in: [packages/core/src/EntityManager.ts:960](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L960) ___ @@ -1583,49 +1622,49 @@ Runs your callback wrapped inside a database transaction. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| - \| -`ctx` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| +`ctx` \| any \| Returns: Promise<T\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:364](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L364) +Defined in: [packages/core/src/EntityManager.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L377) ___ ### tryCache -▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: R ; `key`: string }\\> `internal` #### Type parameters: Name \| ------- \| +:------ \| `T` \| `R` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| `key` \| unknown \| `refresh?` \| boolean \| `merge?` \| boolean \| -Returns: Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +Returns: Promise<undefined \\\| { `data?`: R ; `key`: string }\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:904](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L904) +Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L932) diff --git a/knex.entityrepository.md b/knex.entityrepository.md index 0ff97f3..9245f59 100644 --- a/knex.entityrepository.md +++ b/knex.entityrepository.md @@ -2,6 +2,7 @@ id: "knex.entityrepository" title: "Class: EntityRepository<T>" sidebar_label: "EntityRepository" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| ## Hierarchy @@ -30,21 +31,21 @@ Name \| #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `_em` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [EntityRepository](knex.entityrepository.md)<T\\> -Inherited from: [EntityRepository](core.entityrepository.md) +Overrides: [EntityRepository](core.entityrepository.md) -Defined in: [packages/knex/src/SqlEntityRepository.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L6) +Defined in: [packages/knex/src/SqlEntityRepository.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L6) ## Properties @@ -66,11 +67,11 @@ Inherited from: [EntityRepository](core.entityrepository.md).[entityName](core.e ### em -• em(): [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> +• `Protected`get em(): [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> Returns: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L27) +Defined in: [packages/knex/src/SqlEntityRepository.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L27) ## Methods @@ -83,7 +84,7 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -91,7 +92,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L259) +Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L259) ___ @@ -104,35 +105,35 @@ Checks whether given property can be populated on the entity. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `property` \| string \| Returns: boolean Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L223) +Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L223) ___ ### count -▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L274) +Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L274) ___ @@ -145,20 +146,20 @@ Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| string[] \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| string[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L252) +Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L252) ___ @@ -171,12 +172,12 @@ Creates a QueryBuilder instance #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias?` \| string \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L16) +Defined in: [packages/knex/src/SqlEntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L16) ___ @@ -189,13 +190,13 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -203,7 +204,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L81) +Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L81) ▸ find<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -212,13 +213,13 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -229,7 +230,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L86) +Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L86) ___ @@ -242,20 +243,20 @@ Finds all entities of given type. You can pass additional options via the `optio #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L118) +Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L118) ▸ findAll<P\\>(`populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -264,13 +265,13 @@ Finds all entities of given type. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `limit?` \| number \| @@ -280,13 +281,13 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L123) +Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L123) ___ ### findAndCount -▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> +▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple where first element is the array of entities and the second is the count. @@ -294,21 +295,21 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L99) +Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L99) ▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -318,13 +319,13 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -335,7 +336,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L105) +Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L105) ___ @@ -348,13 +349,13 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -363,7 +364,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L41) +Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L41) ▸ findOne<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -372,13 +373,13 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -387,7 +388,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L46) +Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L46) ___ @@ -402,13 +403,13 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -417,7 +418,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L60) +Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L60) ▸ findOneOrFail<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -428,13 +429,13 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -443,42 +444,42 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L67) +Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L67) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. This method is a shortcut for `em.flush()`, in other words, it will flush the whole UoW, not just entities registered via this particular repository. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L166) +Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L166) ___ ### getKnex -▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> +▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> Returns configured knex instance. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L23) +Defined in: [packages/knex/src/SqlEntityRepository.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L23) ___ @@ -491,13 +492,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| @@ -505,7 +506,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L201) +Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L201) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>): T @@ -514,20 +515,20 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| Returns: T Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L206) +Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L206) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false): T @@ -536,13 +537,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| @@ -550,7 +551,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L211) +Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L211) ___ @@ -563,14 +564,14 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L194) +Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L194) ___ @@ -584,7 +585,7 @@ via second parameter. By default it will return already loaded entities without #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| T \\\| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| `convertCustomTypes?` \| boolean \| @@ -593,27 +594,28 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L267) +Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L267) ___ ### nativeDelete -▸ nativeDelete(`where`: any): Promise<number\\> +▸ nativeDelete(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| -`where` \| any \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options?` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L187) +Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L187) ___ @@ -626,41 +628,42 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L173) +Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L173) ___ ### nativeUpdate -▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<number\\> +▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options?` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L180) +Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L180) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -668,20 +671,20 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L16) +Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L16) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -689,20 +692,20 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L24) +Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L24) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -712,36 +715,36 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L34) +Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L34) ___ ### populate -▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -750,25 +753,25 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L230) +Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L230) -▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -777,25 +780,25 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L235) +Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L235) -▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -804,13 +807,13 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L240) +Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L240) ___ ### remove -▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -820,20 +823,20 @@ To remove entities by condition, use `em.nativeDelete()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L138) +Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L138) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -841,20 +844,20 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L146) +Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L146) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -864,11 +867,11 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L156) +Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L156) diff --git a/knex.knex-1.client.md b/knex.knex-1.client.md index cfab645..9e219fb 100644 --- a/knex.knex-1.client.md +++ b/knex.knex-1.client.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.client" +id: "knex.knex-1.client" title: "Class: Client" sidebar_label: "Client" +custom_edit_url: null hide_title: true --- @@ -19,17 +20,19 @@ hide_title: true ### constructor -\\+ new Client(`config`: [Config](../interfaces/knex.knex.config.md)<any\\>): [Client](knex.knex.client.md) +\\+ new Client(`config`: [Config](../interfaces/knex.knex-1.config.md)<any\\>): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`config` \| [Config](../interfaces/knex.knex.config.md)<any\\> \| +:------ \| :------ \| +`config` \| [Config](../interfaces/knex.knex-1.config.md)<any\\> \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/knex/types/index.d.ts:2174 +Overrides: void + +Defined in: node_modules/knex/types/index.d.ts:2180 ## Properties @@ -37,15 +40,15 @@ Defined in: node_modules/knex/types/index.d.ts:2174 • canCancelQuery: boolean -Defined in: node_modules/knex/types/index.d.ts:2224 +Defined in: node_modules/knex/types/index.d.ts:2230 ___ ### config -• config: [Config](../interfaces/knex.knex.config.md)<any\\> +• config: [Config](../interfaces/knex.knex-1.config.md)<any\\> -Defined in: node_modules/knex/types/index.d.ts:2176 +Defined in: node_modules/knex/types/index.d.ts:2182 ___ @@ -53,7 +56,7 @@ ___ • connectionConfigExpirationChecker: null \\\| () => boolean -Defined in: node_modules/knex/types/index.d.ts:2187 +Defined in: node_modules/knex/types/index.d.ts:2193 ___ @@ -61,7 +64,7 @@ ___ • connectionConfigProvider: any -Defined in: node_modules/knex/types/index.d.ts:2186 +Defined in: node_modules/knex/types/index.d.ts:2192 ___ @@ -69,7 +72,7 @@ ___ • connectionSettings: object -Defined in: node_modules/knex/types/index.d.ts:2179 +Defined in: node_modules/knex/types/index.d.ts:2185 ___ @@ -77,7 +80,7 @@ ___ • dialect: string -Defined in: node_modules/knex/types/index.d.ts:2177 +Defined in: node_modules/knex/types/index.d.ts:2183 ___ @@ -85,7 +88,7 @@ ___ • driver: any -Defined in: node_modules/knex/types/index.d.ts:2211 +Defined in: node_modules/knex/types/index.d.ts:2217 ___ @@ -93,23 +96,23 @@ ___ • driverName: string -Defined in: node_modules/knex/types/index.d.ts:2178 +Defined in: node_modules/knex/types/index.d.ts:2184 ___ ### logger -• logger: [Logger](../interfaces/knex.knex.logger.md) +• logger: [Logger](../interfaces/knex.knex-1.logger.md) -Defined in: node_modules/knex/types/index.d.ts:2184 +Defined in: node_modules/knex/types/index.d.ts:2190 ___ ### pool -• pool: undefined \\\| Pool<any\\> +• pool: undefined \\\| Pool<any\\> -Defined in: node_modules/knex/types/index.d.ts:2219 +Defined in: node_modules/knex/types/index.d.ts:2225 ___ @@ -117,23 +120,25 @@ ___ • valueForUndefined: any -Defined in: node_modules/knex/types/index.d.ts:2188 +Defined in: node_modules/knex/types/index.d.ts:2194 ___ ### version -• `Optional` version: undefined \\\| string +• `Optional` version: string -Defined in: node_modules/knex/types/index.d.ts:2185 +Defined in: node_modules/knex/types/index.d.ts:2191 ___ ### captureRejectionSymbol -▪ `Readonly` `Static` captureRejectionSymbol: typeof [captureRejectionSymbol](knex.knex.client.md#capturerejectionsymbol) +▪ `Readonly` `Static` captureRejectionSymbol: typeof [captureRejectionSymbol](knex.knex-1.client.md#capturerejectionsymbol) + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:38 +Defined in: node_modules/@types/node/events.d.ts:43 ___ @@ -143,7 +148,9 @@ ___ Sets or gets the default captureRejection value for all emitters. -Defined in: node_modules/@types/node/events.d.ts:44 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:49 ___ @@ -151,13 +158,15 @@ ___ ▪ `Static` defaultMaxListeners: number -Defined in: node_modules/@types/node/events.d.ts:45 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:50 ___ ### errorMonitor -▪ `Readonly` `Static` errorMonitor: typeof [errorMonitor](knex.knex.client.md#errormonitor) +▪ `Readonly` `Static` errorMonitor: typeof [errorMonitor](knex.knex-1.client.md#errormonitor) This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular @@ -167,7 +176,9 @@ Installing a listener using this symbol does not change the behavior once an `'error'` event is emitted, therefore the process will still crash if no regular `'error'` listener is installed. -Defined in: node_modules/@types/node/events.d.ts:37 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:42 ## Methods @@ -177,34 +188,36 @@ Defined in: node_modules/@types/node/events.d.ts:37 Returns: any -Defined in: node_modules/knex/types/index.d.ts:2220 +Defined in: node_modules/knex/types/index.d.ts:2226 ___ ### acquireRawConnection -▸ acquireRawConnection(): Promise<any\\> +▸ acquireRawConnection(): Promise<any\\> -Returns: Promise<any\\> +Returns: Promise<any\\> -Defined in: node_modules/knex/types/index.d.ts:2181 +Defined in: node_modules/knex/types/index.d.ts:2187 ___ ### addListener -▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:57 +Defined in: node_modules/@types/node/events.d.ts:62 ___ @@ -214,7 +227,7 @@ ___ Returns: void -Defined in: node_modules/knex/types/index.d.ts:2225 +Defined in: node_modules/knex/types/index.d.ts:2231 ___ @@ -224,25 +237,25 @@ ___ Returns: void -Defined in: node_modules/knex/types/index.d.ts:2226 +Defined in: node_modules/knex/types/index.d.ts:2232 ___ ### columnBuilder -▸ columnBuilder(`tableBuilder`: any, `type`: any, `args`: any): [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +▸ columnBuilder(`tableBuilder`: any, `type`: any, `args`: any): [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableBuilder` \| any \| `type` \| any \| `args` \| any \| -Returns: [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:2196 +Defined in: node_modules/knex/types/index.d.ts:2202 ___ @@ -253,13 +266,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableBuilder` \| any \| `columnBuilder` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2197 +Defined in: node_modules/knex/types/index.d.ts:2203 ___ @@ -270,14 +283,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| `origImpl` \| any \| `queryContext` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2208 +Defined in: node_modules/knex/types/index.d.ts:2214 ___ @@ -287,7 +300,7 @@ ___ Returns: any -Defined in: node_modules/knex/types/index.d.ts:2223 +Defined in: node_modules/knex/types/index.d.ts:2229 ___ @@ -298,28 +311,28 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2222 +Defined in: node_modules/knex/types/index.d.ts:2228 ___ ### destroyRawConnection -▸ destroyRawConnection(`connection`: any): Promise<void\\> +▸ destroyRawConnection(`connection`: any): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: node_modules/knex/types/index.d.ts:2182 +Defined in: node_modules/knex/types/index.d.ts:2188 ___ @@ -330,13 +343,15 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `...args` \| any[] \| Returns: boolean -Defined in: node_modules/@types/node/events.d.ts:67 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:72 ___ @@ -346,7 +361,9 @@ ___ Returns: (string \\\| symbol)[] -Defined in: node_modules/@types/node/events.d.ts:72 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:77 ___ @@ -357,12 +374,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `builder` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2189 +Defined in: node_modules/knex/types/index.d.ts:2195 ___ @@ -372,7 +389,9 @@ ___ Returns: number -Defined in: node_modules/@types/node/events.d.ts:64 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:69 ___ @@ -383,12 +402,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `poolConfig` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2217 +Defined in: node_modules/knex/types/index.d.ts:2223 ___ @@ -398,7 +417,7 @@ ___ Returns: void -Defined in: node_modules/knex/types/index.d.ts:2210 +Defined in: node_modules/knex/types/index.d.ts:2216 ___ @@ -409,12 +428,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| -`config?` \| {} \| +:------ \| :------ \| +`config?` \| object \| Returns: void -Defined in: node_modules/knex/types/index.d.ts:2218 +Defined in: node_modules/knex/types/index.d.ts:2224 ___ @@ -425,12 +444,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: number -Defined in: node_modules/@types/node/events.d.ts:68 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:73 ___ @@ -441,63 +462,71 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Defined in: node_modules/@types/node/events.d.ts:65 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:70 ___ ### off -▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:61 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:66 ___ ### on -▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:58 +Defined in: node_modules/@types/node/events.d.ts:63 ___ ### once -▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:59 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:64 ___ @@ -508,12 +537,12 @@ ___ Returns: object Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `max` \| number \| `min` \| number \| `propagateCreateError` \| boolean \| -Defined in: node_modules/knex/types/index.d.ts:2212 +Defined in: node_modules/knex/types/index.d.ts:2218 ___ @@ -524,12 +553,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2205 +Defined in: node_modules/knex/types/index.d.ts:2211 ___ @@ -540,13 +569,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `resp` \| any \| `queryContext` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2206 +Defined in: node_modules/knex/types/index.d.ts:2212 ___ @@ -557,46 +586,50 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `bindings` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2204 +Defined in: node_modules/knex/types/index.d.ts:2210 ___ ### prependListener -▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:70 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:75 ___ ### prependOnceListener -▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:71 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:76 ___ @@ -607,23 +640,23 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| `obj` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2202 +Defined in: node_modules/knex/types/index.d.ts:2208 ___ ### queryBuilder -▸ queryBuilder(): [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +▸ queryBuilder(): [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Returns: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Defined in: node_modules/knex/types/index.d.ts:2190 +Defined in: node_modules/knex/types/index.d.ts:2196 ___ @@ -634,12 +667,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `builder` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2191 +Defined in: node_modules/knex/types/index.d.ts:2197 ___ @@ -650,12 +683,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2200 +Defined in: node_modules/knex/types/index.d.ts:2206 ___ @@ -666,28 +699,30 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Defined in: node_modules/@types/node/events.d.ts:66 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:71 ___ ### ref -▸ ref(...`args`: any[]): [Ref](../interfaces/knex.knex.ref.md)<any, any\\> +▸ ref(...`args`: any[]): [Ref](../interfaces/knex.knex-1.ref.md)<any, any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| -Returns: [Ref](../interfaces/knex.knex.ref.md)<any, any\\> +Returns: [Ref](../interfaces/knex.knex-1.ref.md)<any, any\\> -Defined in: node_modules/knex/types/index.d.ts:2201 +Defined in: node_modules/knex/types/index.d.ts:2207 ___ @@ -698,45 +733,49 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2221 +Defined in: node_modules/knex/types/index.d.ts:2227 ___ ### removeAllListeners -▸ removeAllListeners(`event?`: string \\\| symbol): [Client](knex.knex.client.md) +▸ removeAllListeners(`event?`: string \\\| symbol): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event?` \| string \\\| symbol \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:62 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:67 ___ ### removeListener -▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex.client.md) +▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:60 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:65 ___ @@ -747,54 +786,56 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `builder` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2198 +Defined in: node_modules/knex/types/index.d.ts:2204 ___ ### schemaBuilder -▸ schemaBuilder(): [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +▸ schemaBuilder(): [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) -Returns: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:2192 +Defined in: node_modules/knex/types/index.d.ts:2198 ___ ### schemaCompiler -▸ schemaCompiler(`builder`: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md)): any +▸ schemaCompiler(`builder`: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md)): any #### Parameters: Name \| Type \| ------- \| ------ \| -`builder` \| [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) \| +:------ \| :------ \| +`builder` \| [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2193 +Defined in: node_modules/knex/types/index.d.ts:2199 ___ ### setMaxListeners -▸ setMaxListeners(`n`: number): [Client](knex.knex.client.md) +▸ setMaxListeners(`n`: number): [Client](knex.knex-1.client.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `n` \| number \| -Returns: [Client](knex.knex.client.md) +Returns: [Client](knex.knex-1.client.md) -Defined in: node_modules/@types/node/events.d.ts:63 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:68 ___ @@ -805,7 +846,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| `obj` \| any \| `stream` \| any \| @@ -813,25 +854,25 @@ Name \| Type \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2203 +Defined in: node_modules/knex/types/index.d.ts:2209 ___ ### tableBuilder -▸ tableBuilder(`type`: any, `tableName`: any, `fn`: any): [TableBuilder](../interfaces/knex.knex.tablebuilder.md) +▸ tableBuilder(`type`: any, `tableName`: any, `fn`: any): [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type` \| any \| `tableName` \| any \| `fn` \| any \| -Returns: [TableBuilder](../interfaces/knex.knex.tablebuilder.md) +Returns: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:2194 +Defined in: node_modules/knex/types/index.d.ts:2200 ___ @@ -842,46 +883,46 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableBuilder` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2195 +Defined in: node_modules/knex/types/index.d.ts:2201 ___ ### transaction -▸ transaction(`container`: any, `config`: any, `outerTx`: any): [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> +▸ transaction(`container`: any, `config`: any, `outerTx`: any): [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `container` \| any \| `config` \| any \| `outerTx` \| any \| -Returns: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> +Returns: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> -Defined in: node_modules/knex/types/index.d.ts:2199 +Defined in: node_modules/knex/types/index.d.ts:2205 ___ ### validateConnection -▸ validateConnection(`connection`: any): Promise<boolean\\> +▸ validateConnection(`connection`: any): Promise<boolean\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: node_modules/knex/types/index.d.ts:2183 +Defined in: node_modules/knex/types/index.d.ts:2189 ___ @@ -892,13 +933,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| `queryContext` \| any \| Returns: any -Defined in: node_modules/knex/types/index.d.ts:2207 +Defined in: node_modules/knex/types/index.d.ts:2213 ___ @@ -909,12 +950,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| any \| Returns: string -Defined in: node_modules/knex/types/index.d.ts:2209 +Defined in: node_modules/knex/types/index.d.ts:2215 ___ @@ -927,57 +968,65 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `emitter` \| EventEmitter \| `event` \| string \\\| symbol \| Returns: number -Defined in: node_modules/@types/node/events.d.ts:26 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:31 ___ ### on -▸ `Static`on(`emitter`: EventEmitter, `event`: string): AsyncIterableIterator<any\\> +▸ `Static`on(`emitter`: EventEmitter, `event`: string): AsyncIterableIterator<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `emitter` \| EventEmitter \| `event` \| string \| -Returns: AsyncIterableIterator<any\\> +Returns: AsyncIterableIterator<any\\> + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:23 +Defined in: node_modules/@types/node/events.d.ts:28 ___ ### once -▸ `Static`once(`emitter`: NodeEventTarget, `event`: string \\\| symbol): Promise<any[]\\> +▸ `Static`once(`emitter`: NodeEventTarget, `event`: string \\\| symbol): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `emitter` \| NodeEventTarget \| `event` \| string \\\| symbol \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> -Defined in: node_modules/@types/node/events.d.ts:21 +Inherited from: void -▸ `Static`once(`emitter`: DOMEventTarget, `event`: string): Promise<any[]\\> +Defined in: node_modules/@types/node/events.d.ts:26 + +▸ `Static`once(`emitter`: DOMEventTarget, `event`: string): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `emitter` \| DOMEventTarget \| `event` \| string \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:22 +Defined in: node_modules/@types/node/events.d.ts:27 diff --git a/knex.knex-1.knextimeouterror.md b/knex.knex-1.knextimeouterror.md index 3ac951e..6a42ff1 100644 --- a/knex.knex-1.knextimeouterror.md +++ b/knex.knex-1.knextimeouterror.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.knextimeouterror" +id: "knex.knex-1.knextimeouterror" title: "Class: KnexTimeoutError" sidebar_label: "KnexTimeoutError" +custom_edit_url: null hide_title: true --- @@ -19,15 +20,17 @@ hide_title: true ### constructor -\\+ new KnexTimeoutError(`message?`: string): [KnexTimeoutError](knex.knex.knextimeouterror.md) +\\+ new KnexTimeoutError(`message?`: string): [KnexTimeoutError](knex.knex-1.knextimeouterror.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `message?` \| string \| -Returns: [KnexTimeoutError](knex.knex.knextimeouterror.md) +Returns: [KnexTimeoutError](knex.knex-1.knextimeouterror.md) + +Inherited from: void Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:978 @@ -37,6 +40,8 @@ Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:978 • message: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:974 ___ @@ -45,17 +50,34 @@ ___ • name: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973 ___ ### prepareStackTrace -• `Optional` prepareStackTrace: undefined \\\| (`err`: Error, `stackTraces`: CallSite[]) => any +• `Optional` prepareStackTrace: (`err`: Error, `stackTraces`: CallSite[]) => any Optional override for formatting stack traces -`see` https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces +`see` https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Type declaration: + +▸ (`err`: Error, `stackTraces`: CallSite[]): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`err` \| Error \| +`stackTraces` \| CallSite[] \| + +Returns: any + +Defined in: node_modules/@types/node/globals.d.ts:11 Defined in: node_modules/@types/node/globals.d.ts:11 @@ -63,7 +85,9 @@ ___ ### stack -• `Optional` stack: undefined \\\| string +• `Optional` stack: string + +Inherited from: void Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975 @@ -86,7 +110,7 @@ Create .stack property on a target object #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `targetObject` \| object \| `constructorOpt?` \| Function \| diff --git a/knex.knex-1.querybuilder.md b/knex.knex-1.querybuilder.md index e041966..3252031 100644 --- a/knex.knex-1.querybuilder.md +++ b/knex.knex-1.querybuilder.md @@ -0,0 +1,2307 @@ +--- +id: "knex.knex-1.querybuilder" +title: "Class: QueryBuilder<TRecord, TResult>" +sidebar_label: "QueryBuilder" +custom_edit_url: null +hide_title: true +--- + +# Class: QueryBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).QueryBuilder + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| any \| + +## Hierarchy + +* [QueryInterface](../interfaces/knex.knex-1.queryinterface.md)<TRecord, TResult\\> + +* [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md)<ResolveResult<TResult\\>\\> + + ↳ QueryBuilder + +## Constructors + +### constructor + +\\+ new QueryBuilder<TRecord, TResult\\>(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| any \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +## Properties + +### [Symbol.toStringTag] + +• `Readonly` [Symbol.toStringTag]: string + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md).[[Symbol.toStringTag]](../interfaces/knex.knex-1.chainableinterface.md#[symbol.tostringtag]) + +Defined in: node_modules/knex/types/index.d.ts:1645 + +___ + +### and + +• and: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1597 + +___ + +### andHaving + +• andHaving: [Having](../interfaces/knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andHaving](../interfaces/knex.knex-1.queryinterface.md#andhaving) + +Defined in: node_modules/knex/types/index.d.ts:544 + +___ + +### andWhere + +• andWhere: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andWhere](../interfaces/knex.knex-1.queryinterface.md#andwhere) + +Defined in: node_modules/knex/types/index.d.ts:498 + +___ + +### andWhereBetween + +• andWhereBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andWhereBetween](../interfaces/knex.knex-1.queryinterface.md#andwherebetween) + +Defined in: node_modules/knex/types/index.d.ts:522 + +___ + +### andWhereNot + +• andWhereNot: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andWhereNot](../interfaces/knex.knex-1.queryinterface.md#andwherenot) + +Defined in: node_modules/knex/types/index.d.ts:501 + +___ + +### andWhereNotBetween + +• andWhereNotBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andWhereNotBetween](../interfaces/knex.knex-1.queryinterface.md#andwherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:525 + +___ + +### andWhereRaw + +• andWhereRaw: [WhereRaw](../interfaces/knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[andWhereRaw](../interfaces/knex.knex-1.queryinterface.md#andwhereraw) + +Defined in: node_modules/knex/types/index.d.ts:505 + +___ + +### as + +• as: [As](../interfaces/knex.knex-1.as.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[as](../interfaces/knex.knex-1.queryinterface.md#as) + +Defined in: node_modules/knex/types/index.d.ts:467 + +___ + +### avg + +• avg: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[avg](../interfaces/knex.knex-1.queryinterface.md#avg) + +Defined in: node_modules/knex/types/index.d.ts:587 + +___ + +### avgDistinct + +• avgDistinct: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[avgDistinct](../interfaces/knex.knex-1.queryinterface.md#avgdistinct) + +Defined in: node_modules/knex/types/index.d.ts:588 + +___ + +### client + +• client: [Client](knex.knex-1.client.md) + +Defined in: node_modules/knex/types/index.d.ts:1594 + +___ + +### column + +• column: [Select](../interfaces/knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[column](../interfaces/knex.knex-1.queryinterface.md#column) + +Defined in: node_modules/knex/types/index.d.ts:469 + +___ + +### columns + +• columns: [Select](../interfaces/knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[columns](../interfaces/knex.knex-1.queryinterface.md#columns) + +Defined in: node_modules/knex/types/index.d.ts:468 + +___ + +### count + +• count: [AsymmetricAggregation](../interfaces/knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[count](../interfaces/knex.knex-1.queryinterface.md#count) + +Defined in: node_modules/knex/types/index.d.ts:581 + +___ + +### countDistinct + +• countDistinct: [AsymmetricAggregation](../interfaces/knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[countDistinct](../interfaces/knex.knex-1.queryinterface.md#countdistinct) + +Defined in: node_modules/knex/types/index.d.ts:582 + +___ + +### crossJoin + +• crossJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[crossJoin](../interfaces/knex.knex-1.queryinterface.md#crossjoin) + +Defined in: node_modules/knex/types/index.d.ts:487 + +___ + +### distinct + +• distinct: [Distinct](../interfaces/knex.knex-1.distinct.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[distinct](../interfaces/knex.knex-1.queryinterface.md#distinct) + +Defined in: node_modules/knex/types/index.d.ts:474 + +___ + +### distinctOn + +• distinctOn: [DistinctOn](../interfaces/knex.knex-1.distincton.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[distinctOn](../interfaces/knex.knex-1.queryinterface.md#distincton) + +Defined in: node_modules/knex/types/index.d.ts:475 + +___ + +### first + +• first: [Select](../interfaces/knex.knex-1.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[first](../interfaces/knex.knex-1.queryinterface.md#first) + +Defined in: node_modules/knex/types/index.d.ts:609 + +___ + +### from + +• from: [Table](../interfaces/knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[from](../interfaces/knex.knex-1.queryinterface.md#from) + +Defined in: node_modules/knex/types/index.d.ts:471 + +___ + +### fullOuterJoin + +• fullOuterJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[fullOuterJoin](../interfaces/knex.knex-1.queryinterface.md#fullouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:486 + +___ + +### groupBy + +• groupBy: [GroupBy](../interfaces/knex.knex-1.groupby.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[groupBy](../interfaces/knex.knex-1.queryinterface.md#groupby) + +Defined in: node_modules/knex/types/index.d.ts:528 + +___ + +### groupByRaw + +• groupByRaw: [RawQueryBuilder](../interfaces/knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[groupByRaw](../interfaces/knex.knex-1.queryinterface.md#groupbyraw) + +Defined in: node_modules/knex/types/index.d.ts:529 + +___ + +### having + +• having: [Having](../interfaces/knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[having](../interfaces/knex.knex-1.queryinterface.md#having) + +Defined in: node_modules/knex/types/index.d.ts:543 + +___ + +### havingBetween + +• havingBetween: [HavingRange](../interfaces/knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[havingBetween](../interfaces/knex.knex-1.queryinterface.md#havingbetween) + +Defined in: node_modules/knex/types/index.d.ts:552 + +___ + +### havingIn + +• havingIn: [HavingRange](../interfaces/knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[havingIn](../interfaces/knex.knex-1.queryinterface.md#havingin) + +Defined in: node_modules/knex/types/index.d.ts:548 + +___ + +### havingNotBetween + +• havingNotBetween: [HavingRange](../interfaces/knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[havingNotBetween](../interfaces/knex.knex-1.queryinterface.md#havingnotbetween) + +Defined in: node_modules/knex/types/index.d.ts:550 + +___ + +### havingRaw + +• havingRaw: [RawQueryBuilder](../interfaces/knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[havingRaw](../interfaces/knex.knex-1.queryinterface.md#havingraw) + +Defined in: node_modules/knex/types/index.d.ts:545 + +___ + +### havingWrapped + +• havingWrapped: [WhereWrapped](../interfaces/knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[havingWrapped](../interfaces/knex.knex-1.queryinterface.md#havingwrapped) + +Defined in: node_modules/knex/types/index.d.ts:507 + +___ + +### hintComment + +• hintComment: [HintComment](../interfaces/knex.knex-1.hintcomment.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[hintComment](../interfaces/knex.knex-1.queryinterface.md#hintcomment) + +Defined in: node_modules/knex/types/index.d.ts:470 + +___ + +### innerJoin + +• innerJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[innerJoin](../interfaces/knex.knex-1.queryinterface.md#innerjoin) + +Defined in: node_modules/knex/types/index.d.ts:480 + +___ + +### intersect + +• intersect: [Intersect](../interfaces/knex.knex-1.intersect.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[intersect](../interfaces/knex.knex-1.queryinterface.md#intersect) + +Defined in: node_modules/knex/types/index.d.ts:536 + +___ + +### into + +• into: [Table](../interfaces/knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[into](../interfaces/knex.knex-1.queryinterface.md#into) + +Defined in: node_modules/knex/types/index.d.ts:472 + +___ + +### join + +• join: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[join](../interfaces/knex.knex-1.queryinterface.md#join) + +Defined in: node_modules/knex/types/index.d.ts:478 + +___ + +### joinRaw + +• joinRaw: [JoinRaw](../interfaces/knex.knex-1.joinraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[joinRaw](../interfaces/knex.knex-1.queryinterface.md#joinraw) + +Defined in: node_modules/knex/types/index.d.ts:479 + +___ + +### leftJoin + +• leftJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[leftJoin](../interfaces/knex.knex-1.queryinterface.md#leftjoin) + +Defined in: node_modules/knex/types/index.d.ts:481 + +___ + +### leftOuterJoin + +• leftOuterJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[leftOuterJoin](../interfaces/knex.knex-1.queryinterface.md#leftouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:482 + +___ + +### max + +• max: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[max](../interfaces/knex.knex-1.queryinterface.md#max) + +Defined in: node_modules/knex/types/index.d.ts:584 + +___ + +### min + +• min: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[min](../interfaces/knex.knex-1.queryinterface.md#min) + +Defined in: node_modules/knex/types/index.d.ts:583 + +___ + +### not + +• not: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1596 + +___ + +### or + +• or: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1595 + +___ + +### orHaving + +• orHaving: [Having](../interfaces/knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orHaving](../interfaces/knex.knex-1.queryinterface.md#orhaving) + +Defined in: node_modules/knex/types/index.d.ts:546 + +___ + +### orHavingBetween + +• orHavingBetween: [HavingRange](../interfaces/knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orHavingBetween](../interfaces/knex.knex-1.queryinterface.md#orhavingbetween) + +Defined in: node_modules/knex/types/index.d.ts:551 + +___ + +### orHavingNotBetween + +• orHavingNotBetween: [HavingRange](../interfaces/knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orHavingNotBetween](../interfaces/knex.knex-1.queryinterface.md#orhavingnotbetween) + +Defined in: node_modules/knex/types/index.d.ts:549 + +___ + +### orHavingRaw + +• orHavingRaw: [RawQueryBuilder](../interfaces/knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orHavingRaw](../interfaces/knex.knex-1.queryinterface.md#orhavingraw) + +Defined in: node_modules/knex/types/index.d.ts:547 + +___ + +### orWhere + +• orWhere: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhere](../interfaces/knex.knex-1.queryinterface.md#orwhere) + +Defined in: node_modules/knex/types/index.d.ts:499 + +___ + +### orWhereBetween + +• orWhereBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereBetween](../interfaces/knex.knex-1.queryinterface.md#orwherebetween) + +Defined in: node_modules/knex/types/index.d.ts:521 + +___ + +### orWhereExists + +• orWhereExists: [WhereExists](../interfaces/knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereExists](../interfaces/knex.knex-1.queryinterface.md#orwhereexists) + +Defined in: node_modules/knex/types/index.d.ts:509 + +___ + +### orWhereIn + +• orWhereIn: [WhereIn](../interfaces/knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereIn](../interfaces/knex.knex-1.queryinterface.md#orwherein) + +Defined in: node_modules/knex/types/index.d.ts:513 + +___ + +### orWhereNot + +• orWhereNot: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNot](../interfaces/knex.knex-1.queryinterface.md#orwherenot) + +Defined in: node_modules/knex/types/index.d.ts:502 + +___ + +### orWhereNotBetween + +• orWhereNotBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNotBetween](../interfaces/knex.knex-1.queryinterface.md#orwherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:524 + +___ + +### orWhereNotExists + +• orWhereNotExists: [WhereExists](../interfaces/knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNotExists](../interfaces/knex.knex-1.queryinterface.md#orwherenotexists) + +Defined in: node_modules/knex/types/index.d.ts:511 + +___ + +### orWhereNotIn + +• orWhereNotIn: [WhereIn](../interfaces/knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNotIn](../interfaces/knex.knex-1.queryinterface.md#orwherenotin) + +Defined in: node_modules/knex/types/index.d.ts:515 + +___ + +### orWhereNotNull + +• orWhereNotNull: [WhereNull](../interfaces/knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNotNull](../interfaces/knex.knex-1.queryinterface.md#orwherenotnull) + +Defined in: node_modules/knex/types/index.d.ts:519 + +___ + +### orWhereNull + +• orWhereNull: [WhereNull](../interfaces/knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereNull](../interfaces/knex.knex-1.queryinterface.md#orwherenull) + +Defined in: node_modules/knex/types/index.d.ts:517 + +___ + +### orWhereRaw + +• orWhereRaw: [WhereRaw](../interfaces/knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orWhereRaw](../interfaces/knex.knex-1.queryinterface.md#orwhereraw) + +Defined in: node_modules/knex/types/index.d.ts:504 + +___ + +### orderBy + +• orderBy: [OrderBy](../interfaces/knex.knex-1.orderby.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orderBy](../interfaces/knex.knex-1.queryinterface.md#orderby) + +Defined in: node_modules/knex/types/index.d.ts:532 + +___ + +### orderByRaw + +• orderByRaw: [RawQueryBuilder](../interfaces/knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[orderByRaw](../interfaces/knex.knex-1.queryinterface.md#orderbyraw) + +Defined in: node_modules/knex/types/index.d.ts:533 + +___ + +### outerJoin + +• outerJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[outerJoin](../interfaces/knex.knex-1.queryinterface.md#outerjoin) + +Defined in: node_modules/knex/types/index.d.ts:485 + +___ + +### rightJoin + +• rightJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[rightJoin](../interfaces/knex.knex-1.queryinterface.md#rightjoin) + +Defined in: node_modules/knex/types/index.d.ts:483 + +___ + +### rightOuterJoin + +• rightOuterJoin: [Join](../interfaces/knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[rightOuterJoin](../interfaces/knex.knex-1.queryinterface.md#rightouterjoin) + +Defined in: node_modules/knex/types/index.d.ts:484 + +___ + +### select + +• select: [Select](../interfaces/knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[select](../interfaces/knex.knex-1.queryinterface.md#select) + +Defined in: node_modules/knex/types/index.d.ts:466 + +___ + +### sum + +• sum: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[sum](../interfaces/knex.knex-1.queryinterface.md#sum) + +Defined in: node_modules/knex/types/index.d.ts:585 + +___ + +### sumDistinct + +• sumDistinct: [TypePreservingAggregation](../interfaces/knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[sumDistinct](../interfaces/knex.knex-1.queryinterface.md#sumdistinct) + +Defined in: node_modules/knex/types/index.d.ts:586 + +___ + +### table + +• table: [Table](../interfaces/knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[table](../interfaces/knex.knex-1.queryinterface.md#table) + +Defined in: node_modules/knex/types/index.d.ts:473 + +___ + +### union + +• union: [Union](../interfaces/knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[union](../interfaces/knex.knex-1.queryinterface.md#union) + +Defined in: node_modules/knex/types/index.d.ts:539 + +___ + +### unionAll + +• unionAll: [Union](../interfaces/knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[unionAll](../interfaces/knex.knex-1.queryinterface.md#unionall) + +Defined in: node_modules/knex/types/index.d.ts:540 + +___ + +### where + +• where: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[where](../interfaces/knex.knex-1.queryinterface.md#where) + +Defined in: node_modules/knex/types/index.d.ts:497 + +___ + +### whereBetween + +• whereBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereBetween](../interfaces/knex.knex-1.queryinterface.md#wherebetween) + +Defined in: node_modules/knex/types/index.d.ts:520 + +___ + +### whereExists + +• whereExists: [WhereExists](../interfaces/knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereExists](../interfaces/knex.knex-1.queryinterface.md#whereexists) + +Defined in: node_modules/knex/types/index.d.ts:508 + +___ + +### whereIn + +• whereIn: [WhereIn](../interfaces/knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereIn](../interfaces/knex.knex-1.queryinterface.md#wherein) + +Defined in: node_modules/knex/types/index.d.ts:512 + +___ + +### whereNot + +• whereNot: [Where](../interfaces/knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNot](../interfaces/knex.knex-1.queryinterface.md#wherenot) + +Defined in: node_modules/knex/types/index.d.ts:500 + +___ + +### whereNotBetween + +• whereNotBetween: [WhereBetween](../interfaces/knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNotBetween](../interfaces/knex.knex-1.queryinterface.md#wherenotbetween) + +Defined in: node_modules/knex/types/index.d.ts:523 + +___ + +### whereNotExists + +• whereNotExists: [WhereExists](../interfaces/knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNotExists](../interfaces/knex.knex-1.queryinterface.md#wherenotexists) + +Defined in: node_modules/knex/types/index.d.ts:510 + +___ + +### whereNotIn + +• whereNotIn: [WhereIn](../interfaces/knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNotIn](../interfaces/knex.knex-1.queryinterface.md#wherenotin) + +Defined in: node_modules/knex/types/index.d.ts:514 + +___ + +### whereNotNull + +• whereNotNull: [WhereNull](../interfaces/knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNotNull](../interfaces/knex.knex-1.queryinterface.md#wherenotnull) + +Defined in: node_modules/knex/types/index.d.ts:518 + +___ + +### whereNull + +• whereNull: [WhereNull](../interfaces/knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereNull](../interfaces/knex.knex-1.queryinterface.md#wherenull) + +Defined in: node_modules/knex/types/index.d.ts:516 + +___ + +### whereRaw + +• whereRaw: [WhereRaw](../interfaces/knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereRaw](../interfaces/knex.knex-1.queryinterface.md#whereraw) + +Defined in: node_modules/knex/types/index.d.ts:503 + +___ + +### whereWrapped + +• whereWrapped: [WhereWrapped](../interfaces/knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[whereWrapped](../interfaces/knex.knex-1.queryinterface.md#wherewrapped) + +Defined in: node_modules/knex/types/index.d.ts:506 + +___ + +### with + +• with: [With](../interfaces/knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[with](../interfaces/knex.knex-1.queryinterface.md#with) + +Defined in: node_modules/knex/types/index.d.ts:490 + +___ + +### withRaw + +• withRaw: [WithRaw](../interfaces/knex.knex-1.withraw.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[withRaw](../interfaces/knex.knex-1.queryinterface.md#withraw) + +Defined in: node_modules/knex/types/index.d.ts:492 + +___ + +### withRecursive + +• withRecursive: [With](../interfaces/knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[withRecursive](../interfaces/knex.knex-1.queryinterface.md#withrecursive) + +Defined in: node_modules/knex/types/index.d.ts:491 + +___ + +### withSchema + +• withSchema: [WithSchema](../interfaces/knex.knex-1.withschema.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[withSchema](../interfaces/knex.knex-1.queryinterface.md#withschema) + +Defined in: node_modules/knex/types/index.d.ts:493 + +___ + +### withWrapped + +• withWrapped: [WithWrapped](../interfaces/knex.knex-1.withwrapped.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md).[withWrapped](../interfaces/knex.knex-1.queryinterface.md#withwrapped) + +Defined in: node_modules/knex/types/index.d.ts:494 + +## Methods + +### asCallback + +▸ asCallback(`callback`: Function): Promise<Resolve<TResult\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| Function \| + +Returns: Promise<Resolve<TResult\\>\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1663 + +___ + +### catch + +▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> + +Attaches a callback for only the rejection of the Promise. + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult` \| never \| + +#### Parameters: + +Name \| Type \| Description \| +:------ \| :------ \| :------ \| +`onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| + +Returns: Promise<Resolve<TResult\\> \\\| TResult\\> + +A Promise for the completion of the callback. + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 + +___ + +### clear + +▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:574 + +___ + +### clearCounters + +▸ clearCounters(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:573 + +___ + +### clearGroup + +▸ clearGroup(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:570 + +___ + +### clearHaving + +▸ clearHaving(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:572 + +___ + +### clearOrder + +▸ clearOrder(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:571 + +___ + +### clearSelect + +▸ clearSelect(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:555 + +___ + +### clearWhere + +▸ clearWhere(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:569 + +___ + +### clone + +▸ clone(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1618 + +___ + +### columnInfo + +▸ columnInfo(`column?`: keyof TRecord): Promise<[ColumnInfo](../interfaces/knex.knex-1.columninfo.md)\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column?` \| keyof TRecord \| + +Returns: Promise<[ColumnInfo](../interfaces/knex.knex-1.columninfo.md)\\> + +Defined in: node_modules/knex/types/index.d.ts:1600 + +___ + +### connection + +▸ connection(`connection`: any): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`connection` \| any \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1650 + +___ + +### debug + +▸ debug(`enabled`: boolean): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`enabled` \| boolean \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1651 + +___ + +### decrement + +▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:599 + +▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:603 + +___ + +### del + +▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:833 + +▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:837 + +▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:848 + +▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:859 + +▸ del<TResult2\\>(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:863 + +___ + +### delete + +▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:865 + +▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:869 + +▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:880 + +▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:891 + +▸ delete<TResult2\\>(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:895 + +___ + +### finally + +▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> + +Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The +resolved value cannot be modified from the callback. + +#### Parameters: + +Name \| Type \| Description \| +:------ \| :------ \| :------ \| +`onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| + +Returns: Promise<Resolve<TResult\\>\\> + +A Promise for the completion of the callback. + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 + +___ + +### forShare + +▸ forShare(...`tableNames`: string[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...tableNames` \| string[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1605 + +▸ forShare(`tableNames`: readonly string[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableNames` \| readonly string[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1606 + +___ + +### forUpdate + +▸ forUpdate(...`tableNames`: string[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...tableNames` \| string[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1602 + +▸ forUpdate(`tableNames`: readonly string[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableNames` \| readonly string[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1603 + +___ + +### increment + +▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:590 + +▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:594 + +___ + +### insert + +▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| * \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:616 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:623 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:637 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:651 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:665 + +▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:679 + +___ + +### limit + +▸ limit(`limit`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`limit` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:578 + +___ + +### modify + +▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord2` \| object \| any \| +`TResult2` \| object \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| +`...args` \| any[] \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:685 + +___ + +### noWait + +▸ noWait(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1609 + +___ + +### offset + +▸ offset(`offset`: number): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`offset` \| number \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:577 + +___ + +### on + +▸ on(`event`: string, `callback`: Function): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \| +`callback` \| Function \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1613 + +___ + +### onConflict + +▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](../interfaces/knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| + +Returns: [OnConflictQueryBuilder](../interfaces/knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:813 + +▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](../interfaces/knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| + +Returns: [OnConflictQueryBuilder](../interfaces/knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:823 + +___ + +### options + +▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| Readonly<{ [key: string]: any; }\\> \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1649 + +___ + +### pipe + +▸ pipe<T\\>(`writable`: T, `options?`: Readonly<{ [key: string]: any; }\\>): PassThrough + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| WritableStream<T\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`writable` \| T \| +`options?` \| Readonly<{ [key: string]: any; }\\> \| + +Returns: PassThrough + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1659 + +___ + +### pluck + +▸ pluck<K\\>(`column`: K): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| K \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:611 + +▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TResult2` \| object \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:614 + +___ + +### queryContext + +▸ queryContext(`context`: any): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1615 + +▸ queryContext(): any + +Returns: any + +Defined in: node_modules/knex/types/index.d.ts:1616 + +___ + +### returning + +▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:786 + +▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:787 + +▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:798 + +▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:808 + +___ + +### skipLocked + +▸ skipLocked(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1608 + +___ + +### stream + +▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`handler` \| (`readable`: PassThrough) => any \| + +Returns: Promise<any\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1653 + +▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| Readonly<{ [key: string]: any; }\\> \| +`handler` \| (`readable`: PassThrough) => any \| + +Returns: Promise<any\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1654 + +▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options?` \| Readonly<{ [key: string]: any; }\\> \| + +Returns: PassThrough + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1658 + +___ + +### then + +▸ then<TResult1, TResult2\\>(`onfulfilled?`: null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\>, `onrejected?`: null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\>): Promise<TResult1 \\\| TResult2\\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult1` \| Resolve<TResult\\> \| +`TResult2` \| never \| + +#### Parameters: + +Name \| Type \| Description \| +:------ \| :------ \| :------ \| +`onfulfilled?` \| null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| +`onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| + +Returns: Promise<TResult1 \\\| TResult2\\> + +A Promise for the completion of which ever callback is executed. + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 + +___ + +### timeout + +▸ timeout(`ms`: number, `options?`: { `cancel?`: boolean }): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`ms` \| number \| +`options?` \| object \| +`options.cancel?` \| boolean \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1619 + +___ + +### toQuery + +▸ toQuery(): string + +Returns: string + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1648 + +___ + +### toSQL + +▸ toSQL(): [Sql](../interfaces/knex.knex-1.sql.md) + +Returns: [Sql](../interfaces/knex.knex-1.sql.md) + +Defined in: node_modules/knex/types/index.d.ts:1611 + +___ + +### transacting + +▸ transacting(`trx`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`trx` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: [ChainableInterface](../interfaces/knex.knex-1.chainableinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:1652 + +___ + +### truncate + +▸ truncate(): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, void\\> + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, void\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:897 + +___ + +### update + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| K2 \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:689 + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| readonly K2[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:703 + +▸ update<K\\>(`columnName`: K, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\> \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:717 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:721 + +▸ update(`data`: [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: **, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:727 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:732 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:744 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| string \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \\\| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:756 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:768 + +▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:780 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: [QueryInterface](../interfaces/knex.knex-1.queryinterface.md) + +Defined in: node_modules/knex/types/index.d.ts:784 + +___ + +### extend + +▸ `Static`extend(`methodName`: string, `fn`: <TRecord, TResult\\>(...`args`: any[]) => [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`methodName` \| string \| +`fn` \| <TRecord, TResult\\>(...`args`: any[]) => [QueryBuilder](knex.knex-1.querybuilder.md)<TRecord, TResult\\> \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:2236 diff --git a/knex.knex-1.seeder.md b/knex.knex-1.seeder.md index 7fad24f..1d3f0ee 100644 --- a/knex.knex-1.seeder.md +++ b/knex.knex-1.seeder.md @@ -0,0 +1,76 @@ +--- +id: "knex.knex-1.seeder" +title: "Class: Seeder" +sidebar_label: "Seeder" +custom_edit_url: null +hide_title: true +--- + +# Class: Seeder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Seeder + +## Constructors + +### constructor + +\\+ new Seeder(`knex`: Knex<any, unknown[]\\>): [Seeder](knex.knex-1.seeder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`knex` \| Knex<any, unknown[]\\> \| + +Returns: [Seeder](knex.knex-1.seeder.md) + +Defined in: node_modules/knex/types/index.d.ts:2158 + +## Methods + +### make + +▸ make(`name`: string, `config?`: [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\>): Promise<string\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string \| +`config?` \| [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\> \| + +Returns: Promise<string\\> + +Defined in: node_modules/knex/types/index.d.ts:2162 + +___ + +### run + +▸ run(`config?`: [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\>): Promise<[string[]]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\> \| + +Returns: Promise<[string[]]\\> + +Defined in: node_modules/knex/types/index.d.ts:2161 + +___ + +### setConfig + +▸ setConfig(`config`: [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\>): [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config` \| [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\> \| + +Returns: [SeederConfig](../interfaces/knex.knex-1.seederconfig.md)<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2160 diff --git a/knex.objectcriterianode.md b/knex.objectcriterianode.md index efc97d8..affe75b 100644 --- a/knex.objectcriterianode.md +++ b/knex.objectcriterianode.md @@ -2,6 +2,7 @@ id: "knex.objectcriterianode" title: "Class: ObjectCriteriaNode" sidebar_label: "ObjectCriteriaNode" +custom_edit_url: null hide_title: true --- @@ -24,7 +25,7 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `entityName` \| string \| - \| `parent?` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| - \| @@ -35,7 +36,7 @@ Name \| Type \| Default value \| Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Properties @@ -49,7 +50,7 @@ ___ ### key -• `Optional` `Readonly` key: undefined \\\| string +• `Optional` `Readonly` key: string Inherited from: [CriteriaNode](knex.criterianode.md).[key](knex.criterianode.md#key) @@ -65,7 +66,7 @@ ___ ### parent -• `Optional` `Readonly` parent: undefined \\\| [ICriteriaNode](../interfaces/knex.icriterianode.md) +• `Optional` `Readonly` parent: [ICriteriaNode](../interfaces/knex.icriterianode.md) Inherited from: [CriteriaNode](knex.criterianode.md).[parent](knex.criterianode.md#parent) @@ -77,29 +78,29 @@ ___ Inherited from: [CriteriaNode](knex.criterianode.md).[payload](knex.criterianode.md#payload) -Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L11) +Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L11) ___ ### prop -• `Optional` prop: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +• `Optional` prop: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> Inherited from: [CriteriaNode](knex.criterianode.md).[prop](knex.criterianode.md#prop) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L119) +Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L119) ___ @@ -110,19 +111,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias` \| string \| Returns: string -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L94) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L94) ___ @@ -134,7 +135,7 @@ ___ Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L78) +Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L78) ___ @@ -145,40 +146,40 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L115) +Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L115) ___ ### inlineChildPayload -▸ `Private`inlineChildPayload<T\\>(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `field`: string, `alias?`: string, `childAlias?`: string): void +▸ `Private`inlineChildPayload<T\\>(`o`: [Dictionary](../modules/core.md#dictionary)<any\\>, `payload`: [Dictionary](../modules/core.md#dictionary)<any\\>, `field`: string, `alias?`: string, `childAlias?`: string): void #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| -`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +:------ \| :------ \| +`o` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`payload` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| `field` \| string \| `alias?` \| string \| `childAlias?` \| string \| Returns: void -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L68) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L68) ___ @@ -189,12 +190,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: boolean -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:112](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L112) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L112) ___ @@ -205,13 +206,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -219,7 +220,7 @@ Name \| Type \| Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L8) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L8) ___ @@ -230,20 +231,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L64) +Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L64) ___ @@ -254,12 +255,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `nestedAlias` \| undefined \\\| string \| Returns: boolean -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:82](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L82) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L82) ___ @@ -270,14 +271,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L60) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L60) ___ @@ -288,14 +289,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L44) +Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L44) ___ @@ -306,13 +307,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -320,7 +321,7 @@ Name \| Type \| Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ObjectCriteriaNode.ts#L42) +Defined in: [packages/knex/src/query/ObjectCriteriaNode.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ObjectCriteriaNode.ts#L42) ___ @@ -331,11 +332,11 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L123) +Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L123) diff --git a/knex.querybuilder.md b/knex.querybuilder.md index 0bd0751..6148dea 100644 --- a/knex.querybuilder.md +++ b/knex.querybuilder.md @@ -2,6 +2,7 @@ id: "knex.querybuilder" title: "Class: QueryBuilder<T>" sidebar_label: "QueryBuilder" +custom_edit_url: null hide_title: true --- @@ -14,80 +15,76 @@ SQL query builder ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity) \| -## Hierarchy - -* QueryBuilder - ## Constructors ### constructor -\\+ new QueryBuilder<T\\>(`entityName`: string, `metadata`: [MetadataStorage](core.metadatastorage.md), `driver`: [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>, `context?`: [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\>, `alias?`: string, `connectionType?`: read \\\| write, `em?`: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\>): [QueryBuilder](knex.querybuilder.md)<T\\> +\\+ new QueryBuilder<T\\>(`entityName`: string, `metadata`: [MetadataStorage](core.metadatastorage.md), `driver`: [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>, `context?`: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\>, `alias?`: string, `connectionType?`: read \\\| write, `em?`: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\>): [QueryBuilder](knex.querybuilder.md)<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| string \| - \| -`metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| -`driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| - \| -`context?` \| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> \| - \| -`alias` \| string \| ... \| -`connectionType?` \| read \\\| write \| - \| -`em?` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| - \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`metadata` \| [MetadataStorage](core.metadatastorage.md) \| +`driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| +`context?` \| [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> \| +`alias` \| string \| +`connectionType?` \| read \\\| write \| +`em?` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L59) +Defined in: [packages/knex/src/query/QueryBuilder.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L59) ## Properties ### \\_aliasMap -• `Private` \\_aliasMap: [Dictionary](../modules/core.md#dictionary)<string\\> +• `Private` \\_aliasMap: [Dictionary](../modules/core.md#dictionary)<string\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L43) +Defined in: [packages/knex/src/query/QueryBuilder.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L43) ___ ### \\_cache -• `Private` `Optional` \\_cache: undefined \\\| number \\\| boolean \\\| [string, number] +• `Private` `Optional` \\_cache: number \\\| boolean \\\| [string, number] -Defined in: [packages/knex/src/query/QueryBuilder.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L54) +Defined in: [packages/knex/src/query/QueryBuilder.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L54) ___ ### \\_cond -• `Private` \\_cond: [Dictionary](../modules/core.md#dictionary)<any\\> +• `Private` \\_cond: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L45) +Defined in: [packages/knex/src/query/QueryBuilder.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L45) ___ ### \\_data -• `Private` \\_data: [Dictionary](../modules/core.md#dictionary)<any\\> +• `Private` \\_data: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L46) +Defined in: [packages/knex/src/query/QueryBuilder.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L46) ___ ### \\_fields -• `Optional` \\_fields: undefined \\\| [Field](../modules/knex.md#field)<T\\>[] +• `Optional` \\_fields: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L35) +Defined in: [packages/knex/src/query/QueryBuilder.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L35) ___ @@ -95,23 +92,23 @@ ___ • `Private` \\_groupBy: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L48) +Defined in: [packages/knex/src/query/QueryBuilder.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L48) ___ ### \\_having -• `Private` \\_having: [Dictionary](../modules/core.md#dictionary)<any\\> +• `Private` \\_having: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L49) +Defined in: [packages/knex/src/query/QueryBuilder.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L49) ___ ### \\_joinedProps -• `Private` \\_joinedProps: Map<string, [PopulateOptions](../modules/core.md#populateoptions)<any\\>\\> +• `Private` \\_joinedProps: Map<string, [PopulateOptions](../modules/core.md#populateoptions)<any\\>\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L53) +Defined in: [packages/knex/src/query/QueryBuilder.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L53) ___ @@ -119,31 +116,31 @@ ___ • `Private` \\_joins: [Dictionary](../modules/core.md#dictionary)<[JoinOptions](../interfaces/knex.joinoptions.md)\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L42) +Defined in: [packages/knex/src/query/QueryBuilder.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L42) ___ ### \\_limit -• `Private` `Optional` \\_limit: undefined \\\| number +• `Private` `Optional` \\_limit: number -Defined in: [packages/knex/src/query/QueryBuilder.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L51) +Defined in: [packages/knex/src/query/QueryBuilder.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L51) ___ ### \\_offset -• `Private` `Optional` \\_offset: undefined \\\| number +• `Private` `Optional` \\_offset: number -Defined in: [packages/knex/src/query/QueryBuilder.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L52) +Defined in: [packages/knex/src/query/QueryBuilder.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L52) ___ ### \\_onConflict -• `Private` `Optional` \\_onConflict: undefined \\\| { `fields`: string[] ; `ignore?`: undefined \\\| boolean ; `merge?`: undefined \\\| [EntityData](../modules/core.md#entitydata)<T\\> ; `where?`: undefined \\\| { `__@PrimaryKeyType@41543?`: any } \\\| { `__@PrimaryKeyType@41543?`: any } & [Dictionary](../modules/core.md#dictionary)<any\\> \\\| NonNullable<Query<T\\>\\> \\\| NonNullable<Query<T\\>\\> & [Dictionary](../modules/core.md#dictionary)<any\\> }[] +• `Private` `Optional` \\_onConflict: { `fields`: string[] ; `ignore?`: boolean ; `merge?`: [EntityData](../modules/core.md#entitydata)<T\\> ; `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> }[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L50) +Defined in: [packages/knex/src/query/QueryBuilder.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L50) ___ @@ -151,7 +148,7 @@ ___ • `Private` \\_orderBy: [QueryOrderMap](../interfaces/core.queryordermap.md) -Defined in: [packages/knex/src/query/QueryBuilder.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L47) +Defined in: [packages/knex/src/query/QueryBuilder.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L47) ___ @@ -159,23 +156,23 @@ ___ • \\_populate: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L36) +Defined in: [packages/knex/src/query/QueryBuilder.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L36) ___ ### \\_populateMap -• \\_populateMap: [Dictionary](../modules/core.md#dictionary)<string\\> +• \\_populateMap: [Dictionary](../modules/core.md#dictionary)<string\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L37) +Defined in: [packages/knex/src/query/QueryBuilder.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L37) ___ ### \\_schema -• `Private` `Optional` \\_schema: undefined \\\| string +• `Private` `Optional` \\_schema: string -Defined in: [packages/knex/src/query/QueryBuilder.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L44) +Defined in: [packages/knex/src/query/QueryBuilder.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L44) ___ @@ -189,7 +186,7 @@ ___ • `Private` aliasCounter: number= 1 -Defined in: [packages/knex/src/query/QueryBuilder.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L39) +Defined in: [packages/knex/src/query/QueryBuilder.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L39) ___ @@ -197,7 +194,7 @@ ___ • `Private` finalized: boolean= false -Defined in: [packages/knex/src/query/QueryBuilder.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L41) +Defined in: [packages/knex/src/query/QueryBuilder.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L41) ___ @@ -205,7 +202,7 @@ ___ • `Private` flags: Set<[QueryFlag](../enums/core.queryflag.md)\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L40) +Defined in: [packages/knex/src/query/QueryBuilder.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L40) ___ @@ -213,23 +210,23 @@ ___ • `Private` `Readonly` helper: [QueryBuilderHelper](knex.querybuilderhelper.md) -Defined in: [packages/knex/src/query/QueryBuilder.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L59) +Defined in: [packages/knex/src/query/QueryBuilder.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L59) ___ ### knex -• `Private` `Readonly` knex: Knex<any, unknown[]\\> +• `Private` `Readonly` knex: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L58) +Defined in: [packages/knex/src/query/QueryBuilder.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L58) ___ ### lockMode -• `Private` `Optional` lockMode: undefined \\\| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write) +• `Private` `Optional` lockMode: [LockMode](../enums/core.lockmode.md) -Defined in: [packages/knex/src/query/QueryBuilder.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L55) +Defined in: [packages/knex/src/query/QueryBuilder.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L55) ___ @@ -237,15 +234,15 @@ ___ • `Private` `Readonly` platform: [AbstractSqlPlatform](knex.abstractsqlplatform.md) -Defined in: [packages/knex/src/query/QueryBuilder.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L57) +Defined in: [packages/knex/src/query/QueryBuilder.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L57) ___ ### subQueries -• `Private` subQueries: [Dictionary](../modules/core.md#dictionary)<string\\> +• `Private` subQueries: [Dictionary](../modules/core.md#dictionary)<string\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L56) +Defined in: [packages/knex/src/query/QueryBuilder.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L56) ___ @@ -253,58 +250,58 @@ ___ • type: [QueryType](../enums/knex.querytype.md) -Defined in: [packages/knex/src/query/QueryBuilder.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L34) +Defined in: [packages/knex/src/query/QueryBuilder.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L34) ## Methods ### addSelect -▸ addSelect(`fields`: string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[]): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ addSelect(`fields`: [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[]): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`fields` \| string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[] \| +:------ \| :------ \| +`fields` \| [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L81) +Defined in: [packages/knex/src/query/QueryBuilder.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L81) ___ ### andWhere -▸ andWhere(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ andWhere(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:197](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L197) +Defined in: [packages/knex/src/query/QueryBuilder.ts:197](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L197) ▸ andWhere(`cond`: string, `params?`: any[]): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:198](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L198) +Defined in: [packages/knex/src/query/QueryBuilder.ts:198](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L198) ___ ### as -▸ as(`alias`: string): [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +▸ as(`alias`: string): [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> Returns knex instance with sub-query aliased with given alias. You can provide `EntityName.propName` as alias, then the field name will be used based on the metadata @@ -312,12 +309,12 @@ You can provide `EntityName.propName` as alias, then the field name will be used #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias` \| string \| -Returns: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:459](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L459) +Defined in: [packages/knex/src/query/QueryBuilder.ts:459](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L459) ___ @@ -328,12 +325,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: void -Defined in: [packages/knex/src/query/QueryBuilder.ts:713](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L713) +Defined in: [packages/knex/src/query/QueryBuilder.ts:721](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L721) ___ @@ -344,12 +341,12 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `config` \| number \\\| boolean \\\| [string, number] \| true \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:309](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L309) +Defined in: [packages/knex/src/query/QueryBuilder.ts:309](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L309) ___ @@ -359,7 +356,7 @@ ___ Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:472](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L472) +Defined in: [packages/knex/src/query/QueryBuilder.ts:472](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L472) ___ @@ -370,13 +367,13 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `field?` \| string \\\| string[] \| - \| `distinct` \| boolean \| false \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L105) +Defined in: [packages/knex/src/query/QueryBuilder.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L105) ___ @@ -386,13 +383,13 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cond` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`cond` \| any \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:97](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L97) +Defined in: [packages/knex/src/query/QueryBuilder.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L97) ___ @@ -406,19 +403,19 @@ Use `method` to specify what kind of result you want to get (array/single/meta). #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `U` \| any \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `method` \| all \\\| get \\\| run \| 'all' \| `mapResults` \| boolean \| true \| Returns: Promise<U\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:391](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L391) +Defined in: [packages/knex/src/query/QueryBuilder.ts:391](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L391) ___ @@ -428,7 +425,7 @@ ___ Returns: void -Defined in: [packages/knex/src/query/QueryBuilder.ts:626](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L626) +Defined in: [packages/knex/src/query/QueryBuilder.ts:634](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L634) ___ @@ -439,12 +436,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path?` \| string \| Returns: undefined \\\| string -Defined in: [packages/knex/src/query/QueryBuilder.ts:367](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L367) +Defined in: [packages/knex/src/query/QueryBuilder.ts:367](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L367) ___ @@ -455,19 +452,19 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `U` \| [AnyEntity](../modules/core.md#anyentity)<U\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<U\\> \| `alias` \| string \| Returns: [Field](../modules/knex.md#field)<U\\>[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L146) +Defined in: [packages/knex/src/query/QueryBuilder.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L146) ___ @@ -479,27 +476,27 @@ Returns raw interpolated query string with all the parameters inlined. Returns: string -Defined in: [packages/knex/src/query/QueryBuilder.ts:362](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L362) +Defined in: [packages/knex/src/query/QueryBuilder.ts:362](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L362) ___ ### getKnex -▸ getKnex(): [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +▸ getKnex(): [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Returns: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:484](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L484) +Defined in: [packages/knex/src/query/QueryBuilder.ts:484](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L484) ___ ### getKnexQuery -▸ getKnexQuery(): [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +▸ getKnexQuery(): [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Returns: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:314](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L314) +Defined in: [packages/knex/src/query/QueryBuilder.ts:314](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L314) ___ @@ -510,12 +507,12 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `prefix` \| string \| 'e' \| Returns: string -Defined in: [packages/knex/src/query/QueryBuilder.ts:382](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L382) +Defined in: [packages/knex/src/query/QueryBuilder.ts:382](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L382) ___ @@ -527,7 +524,7 @@ Returns the list of all parameters for this query. Returns: readonly [Value](../modules/knex.knex-1.md#value)[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:355](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L355) +Defined in: [packages/knex/src/query/QueryBuilder.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L355) ___ @@ -539,17 +536,17 @@ Returns the query with parameters as wildcards. Returns: string -Defined in: [packages/knex/src/query/QueryBuilder.ts:348](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L348) +Defined in: [packages/knex/src/query/QueryBuilder.ts:348](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L348) ___ ### getQueryBase -▸ `Private`getQueryBase(): [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +▸ `Private`getQueryBase(): [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Returns: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> +Returns: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:585](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L585) +Defined in: [packages/knex/src/query/QueryBuilder.ts:593](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L593) ___ @@ -561,7 +558,7 @@ Alias for `qb.getResultList()` Returns: Promise<T[]\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:430](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L430) +Defined in: [packages/knex/src/query/QueryBuilder.ts:430](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L430) ___ @@ -573,7 +570,7 @@ Executes the query, returning array of results Returns: Promise<T[]\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:437](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L437) +Defined in: [packages/knex/src/query/QueryBuilder.ts:437](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L437) ___ @@ -585,7 +582,7 @@ Executes the query, returning the first result or null Returns: Promise<null \\\| T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:450](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L450) +Defined in: [packages/knex/src/query/QueryBuilder.ts:450](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L450) ___ @@ -596,12 +593,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fields` \| string \\\| keyof T \\\| (string \\\| keyof T)[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:215](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L215) +Defined in: [packages/knex/src/query/QueryBuilder.ts:215](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L215) ___ @@ -611,14 +608,14 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cond` \| any \| ... \| -`params?` \| any[] \| - \| +Name \| Type \| +:------ \| :------ \| +`cond` \| any \| +`params?` \| any[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:220](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L220) +Defined in: [packages/knex/src/query/QueryBuilder.ts:220](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L220) ___ @@ -628,7 +625,7 @@ ___ Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:235](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L235) +Defined in: [packages/knex/src/query/QueryBuilder.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L235) ___ @@ -639,14 +636,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type` \| [QueryType](../enums/knex.querytype.md) \| `data?` \| any \| `cond?` \| any \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:566](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L566) +Defined in: [packages/knex/src/query/QueryBuilder.ts:574](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L574) ___ @@ -657,12 +654,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L89) +Defined in: [packages/knex/src/query/QueryBuilder.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L89) ___ @@ -673,16 +670,16 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `field` \| string \| - \| `alias` \| string \| - \| -`cond` \| any \| ... \| +`cond` \| any \| - \| `type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| 'innerJoin' \| `path?` \| string \| - \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L115) +Defined in: [packages/knex/src/query/QueryBuilder.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L115) ___ @@ -693,36 +690,36 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `field` \| string \| - \| `alias` \| string \| - \| -`cond` \| any \| ... \| +`cond` \| any \| - \| `type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| 'innerJoin' \| `path?` \| string \| - \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L124) +Defined in: [packages/knex/src/query/QueryBuilder.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L124) ___ ### joinReference -▸ `Private`joinReference(`field`: string, `alias`: string, `cond`: [Dictionary](../modules/core.md#dictionary)<any\\>, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `path?`: string): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +▸ `Private`joinReference(`field`: string, `alias`: string, `cond`: [Dictionary](../modules/core.md#dictionary)<any\\>, `type`: leftJoin \\\| innerJoin \\\| pivotJoin, `path?`: string): [EntityProperty](../interfaces/core.entityproperty.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| `alias` \| string \| -`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`cond` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| `type` \| leftJoin \\\| innerJoin \\\| pivotJoin \| `path?` \| string \| -Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +Returns: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:495](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L495) +Defined in: [packages/knex/src/query/QueryBuilder.ts:495](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L495) ___ @@ -732,15 +729,15 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`field` \| string \| - \| -`alias` \| string \| - \| -`cond` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`alias` \| string \| +`cond` \| any \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L120) +Defined in: [packages/knex/src/query/QueryBuilder.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L120) ___ @@ -750,15 +747,15 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`field` \| string \| - \| -`alias` \| string \| - \| -`cond` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`field` \| string \| +`alias` \| string \| +`cond` \| any \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:142](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L142) +Defined in: [packages/knex/src/query/QueryBuilder.ts:142](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L142) ___ @@ -769,13 +766,13 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `limit?` \| number \| - \| `offset` \| number \| 0 \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:268](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L268) +Defined in: [packages/knex/src/query/QueryBuilder.ts:268](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L268) ___ @@ -786,12 +783,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data?` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:240](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L240) +Defined in: [packages/knex/src/query/QueryBuilder.ts:240](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L240) ___ @@ -802,12 +799,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `offset?` \| number \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L278) +Defined in: [packages/knex/src/query/QueryBuilder.ts:278](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L278) ___ @@ -818,41 +815,41 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fields` \| string \\\| string[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:229](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L229) +Defined in: [packages/knex/src/query/QueryBuilder.ts:229](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L229) ___ ### orWhere -▸ orWhere(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ orWhere(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:203](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L203) +Defined in: [packages/knex/src/query/QueryBuilder.ts:203](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L203) ▸ orWhere(`cond`: string, `params?`: any[]): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:204](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L204) +Defined in: [packages/knex/src/query/QueryBuilder.ts:204](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L204) ___ @@ -863,12 +860,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `orderBy` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:209](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L209) +Defined in: [packages/knex/src/query/QueryBuilder.ts:209](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L209) ___ @@ -881,12 +878,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:248](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L248) +Defined in: [packages/knex/src/query/QueryBuilder.ts:248](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L248) ___ @@ -897,71 +894,71 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`U` \| string \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\> \| string \\\\\| [Raw](../interfaces/knex.knex.raw.md)<any\\\\> \| +`U` \| string \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| string \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `fields` \| [Field](../modules/knex.md#field)<T\\>[] \| - \| `type` \| groupBy \\\| where \\\| sub-query \| 'where' \| Returns: U[] -Defined in: [packages/knex/src/query/QueryBuilder.ts:536](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L536) +Defined in: [packages/knex/src/query/QueryBuilder.ts:536](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L536) ___ ### raw -▸ raw(`sql`: string): [Raw](../interfaces/knex.knex.raw.md)<any\\> +▸ raw(`sql`: string): [Raw](../interfaces/knex.knex-1.raw.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| string \| -Returns: [Raw](../interfaces/knex.knex.raw.md)<any\\> +Returns: [Raw](../interfaces/knex.knex-1.raw.md)<any\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:261](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L261) +Defined in: [packages/knex/src/query/QueryBuilder.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L261) ___ ### ref -▸ ref(`field`: string): [Ref](../interfaces/knex.knex.ref.md)<string, {}\\> +▸ ref(`field`: string): [Ref](../interfaces/knex.knex-1.ref.md)<string, {}\\> `internal` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| -Returns: [Ref](../interfaces/knex.knex.ref.md)<string, {}\\> +Returns: [Ref](../interfaces/knex.knex-1.ref.md)<string, {}\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:257](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L257) +Defined in: [packages/knex/src/query/QueryBuilder.ts:257](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L257) ___ ### select -▸ select(`fields`: string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[], `distinct?`: boolean): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ select(`fields`: [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[], `distinct?`: boolean): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`fields` \| string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[] \| - \| +:------ \| :------ \| :------ \| +`fields` \| [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[] \| - \| `distinct` \| boolean \| false \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L71) +Defined in: [packages/knex/src/query/QueryBuilder.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L71) ___ @@ -972,28 +969,28 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `flag` \| [QueryFlag](../enums/core.queryflag.md) \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:299](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L299) +Defined in: [packages/knex/src/query/QueryBuilder.ts:299](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L299) ___ ### setLockMode -▸ setLockMode(`mode?`: [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write)): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ setLockMode(`mode?`: [LockMode](../enums/core.lockmode.md)): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`mode?` \| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write) \| +:------ \| :------ \| +`mode?` \| [LockMode](../enums/core.lockmode.md) \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:289](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L289) +Defined in: [packages/knex/src/query/QueryBuilder.ts:289](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L289) ___ @@ -1003,7 +1000,7 @@ ___ Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L101) +Defined in: [packages/knex/src/query/QueryBuilder.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L101) ___ @@ -1014,12 +1011,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `flag` \| [QueryFlag](../enums/core.queryflag.md) \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:304](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L304) +Defined in: [packages/knex/src/query/QueryBuilder.ts:304](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L304) ___ @@ -1030,43 +1027,43 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L93) +Defined in: [packages/knex/src/query/QueryBuilder.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L93) ___ ### where -▸ where(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>, `operator?`: $and \\\| $or): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ where(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>, `operator?`: $and \\\| $or): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| `operator?` \| $and \\\| $or \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L160) +Defined in: [packages/knex/src/query/QueryBuilder.ts:160](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L160) ▸ where(`cond`: string, `params?`: any[], `operator?`: $and \\\| $or): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| `operator?` \| $and \\\| $or \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:161](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L161) +Defined in: [packages/knex/src/query/QueryBuilder.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L161) ___ @@ -1077,58 +1074,58 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schema?` \| string \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:283](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L283) +Defined in: [packages/knex/src/query/QueryBuilder.ts:283](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L283) ___ ### withSubQuery -▸ withSubQuery(`subQuery`: [QueryBuilder](knex.knex.querybuilder.md)<any, any\\>, `alias`: string): [QueryBuilder](knex.querybuilder.md)<T\\> +▸ withSubQuery(`subQuery`: [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\>, `alias`: string): [QueryBuilder](knex.querybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`subQuery` \| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \| +:------ \| :------ \| +`subQuery` \| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \| `alias` \| string \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/query/QueryBuilder.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L155) +Defined in: [packages/knex/src/query/QueryBuilder.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L155) ___ ### wrapModifySubQuery -▸ `Private`wrapModifySubQuery(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`wrapModifySubQuery(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/knex/src/query/QueryBuilder.ts:699](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L699) +Defined in: [packages/knex/src/query/QueryBuilder.ts:707](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L707) ___ ### wrapPaginateSubQuery -▸ `Private`wrapPaginateSubQuery(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`wrapPaginateSubQuery(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/knex/src/query/QueryBuilder.ts:679](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/QueryBuilder.ts#L679) +Defined in: [packages/knex/src/query/QueryBuilder.ts:687](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/QueryBuilder.ts#L687) diff --git a/knex.scalarcriterianode.md b/knex.scalarcriterianode.md index b05e892..a8eba05 100644 --- a/knex.scalarcriterianode.md +++ b/knex.scalarcriterianode.md @@ -2,6 +2,7 @@ id: "knex.scalarcriterianode" title: "Class: ScalarCriteriaNode" sidebar_label: "ScalarCriteriaNode" +custom_edit_url: null hide_title: true --- @@ -24,7 +25,7 @@ hide_title: true #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `entityName` \| string \| - \| `parent?` \| [ICriteriaNode](../interfaces/knex.icriterianode.md) \| - \| @@ -35,7 +36,7 @@ Name \| Type \| Default value \| Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Properties @@ -49,7 +50,7 @@ ___ ### key -• `Optional` `Readonly` key: undefined \\\| string +• `Optional` `Readonly` key: string Inherited from: [CriteriaNode](knex.criterianode.md).[key](knex.criterianode.md#key) @@ -65,7 +66,7 @@ ___ ### parent -• `Optional` `Readonly` parent: undefined \\\| [ICriteriaNode](../interfaces/knex.icriterianode.md) +• `Optional` `Readonly` parent: [ICriteriaNode](../interfaces/knex.icriterianode.md) Inherited from: [CriteriaNode](knex.criterianode.md).[parent](knex.criterianode.md#parent) @@ -77,29 +78,29 @@ ___ Inherited from: [CriteriaNode](knex.criterianode.md).[payload](knex.criterianode.md#payload) -Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L11) +Defined in: [packages/knex/src/query/CriteriaNode.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L11) ___ ### prop -• `Optional` prop: undefined \\\| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> +• `Optional` prop: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> Inherited from: [CriteriaNode](knex.criterianode.md).[prop](knex.criterianode.md#prop) -Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L12) +Defined in: [packages/knex/src/query/CriteriaNode.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L12) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L119) +Defined in: [packages/knex/src/query/CriteriaNode.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L119) ___ @@ -111,7 +112,7 @@ ___ Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L78) +Defined in: [packages/knex/src/query/CriteriaNode.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L78) ___ @@ -122,14 +123,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L115) +Defined in: [packages/knex/src/query/CriteriaNode.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L115) ___ @@ -140,13 +141,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -154,7 +155,7 @@ Name \| Type \| Overrides: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/ScalarCriteriaNode.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ScalarCriteriaNode.ts#L7) +Defined in: [packages/knex/src/query/ScalarCriteriaNode.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ScalarCriteriaNode.ts#L7) ___ @@ -165,20 +166,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| Returns: string Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L64) +Defined in: [packages/knex/src/query/CriteriaNode.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L64) ___ @@ -189,14 +190,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L36) +Defined in: [packages/knex/src/query/CriteriaNode.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L36) ___ @@ -206,7 +207,7 @@ ___ Returns: boolean -Defined in: [packages/knex/src/query/ScalarCriteriaNode.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/ScalarCriteriaNode.ts#L25) +Defined in: [packages/knex/src/query/ScalarCriteriaNode.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/ScalarCriteriaNode.ts#L25) ___ @@ -217,14 +218,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L44) +Defined in: [packages/knex/src/query/CriteriaNode.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L44) ___ @@ -235,13 +236,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](../interfaces/knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| @@ -249,7 +250,7 @@ Name \| Type \| Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L40) +Defined in: [packages/knex/src/query/CriteriaNode.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L40) ___ @@ -260,11 +261,11 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| Returns: boolean Inherited from: [CriteriaNode](knex.criterianode.md) -Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/CriteriaNode.ts#L123) +Defined in: [packages/knex/src/query/CriteriaNode.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/CriteriaNode.ts#L123) diff --git a/knex.schemagenerator.md b/knex.schemagenerator.md index 40a3c0b..d0c31d9 100644 --- a/knex.schemagenerator.md +++ b/knex.schemagenerator.md @@ -2,6 +2,7 @@ id: "knex.schemagenerator" title: "Class: SchemaGenerator" sidebar_label: "SchemaGenerator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [knex](../modules/knex.md).SchemaGenerator -## Hierarchy - -* SchemaGenerator - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| Returns: [SchemaGenerator](knex.schemagenerator.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L16) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L16) ## Properties @@ -35,7 +32,7 @@ Defined in: [packages/knex/src/schema/SchemaGenerator.ts:16](https://github.com/ • `Private` `Readonly` config: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L10) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L10) ___ @@ -43,7 +40,7 @@ ___ • `Private` `Readonly` connection: [AbstractSqlConnection](knex.abstractsqlconnection.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L15) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L15) ___ @@ -51,7 +48,7 @@ ___ • `Private` `Readonly` driver: [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L11) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L11) ___ @@ -59,15 +56,15 @@ ___ • `Private` `Readonly` helper: [SchemaHelper](knex.schemahelper.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L14) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L14) ___ ### knex -• `Private` `Readonly` knex: Knex<any, unknown[]\\> +• `Private` `Readonly` knex: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L16) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L16) ___ @@ -75,7 +72,7 @@ ___ • `Private` `Readonly` metadata: [MetadataStorage](core.metadatastorage.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L12) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L12) ___ @@ -83,432 +80,435 @@ ___ • `Private` `Readonly` platform: [AbstractSqlPlatform](knex.abstractsqlplatform.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L13) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L13) ## Methods ### computeColumnDifference -▸ `Private`computeColumnDifference(`table`: [DatabaseTable](knex.databasetable.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `create`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `update`: { `column`: [Column](../interfaces/knex.column.md) ; `diff`: [IsSame](../interfaces/knex.issame.md) ; `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[], `joinColumn?`: string, `idx?`: number): void +▸ `Private`computeColumnDifference(`table`: [DatabaseTable](knex.databasetable.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `create`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `update`: { `column`: [Column](../interfaces/knex.column.md) ; `diff`: [IsSame](../interfaces/knex.issame.md) ; `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[], `joinColumn?`: string, `idx?`: number): void #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `table` \| [DatabaseTable](knex.databasetable.md) \| - \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| -`create` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| - \| -`update` \| { `column`: [Column](../interfaces/knex.column.md) ; `diff`: [IsSame](../interfaces/knex.issame.md) ; `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] \| - \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| +`create` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| - \| +`update` \| { `column`: [Column](../interfaces/knex.column.md) ; `diff`: [IsSame](../interfaces/knex.issame.md) ; `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] \| - \| `joinColumn?` \| string \| - \| `idx` \| number \| 0 \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:314](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L314) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:314](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L314) ___ ### computeTableDifference -▸ `Private`computeTableDifference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `safe`: boolean): [TableDifference](../interfaces/knex.tabledifference.md) +▸ `Private`computeTableDifference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `safe`: boolean): [TableDifference](../interfaces/knex.tabledifference.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `table` \| [DatabaseTable](knex.databasetable.md) \| `safe` \| boolean \| Returns: [TableDifference](../interfaces/knex.tabledifference.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:292](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L292) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:292](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L292) ___ ### configureColumn -▸ `Private`configureColumn<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `col`: [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md), `columnName`: string, `pkProp?`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +▸ `Private`configureColumn<T\\>(`meta`: [EntityMetadata](core.entitymetadata.md)<T\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `col`: [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md), `columnName`: string, `pkProp?`: [EntityProperty](../interfaces/core.entityproperty.md)<T\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| - \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| - \| -`col` \| [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) \| - \| -`columnName` \| string \| - \| -`pkProp` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| ... \| -`alter?` \| [IsSame](../interfaces/knex.issame.md) \| - \| +Name \| Type \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| +`col` \| [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) \| +`columnName` \| string \| +`pkProp` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| +`alter?` \| [IsSame](../interfaces/knex.issame.md) \| -Returns: [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:435](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L435) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:435](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L435) ___ ### createDatabase -▸ createDatabase(`name`: string): Promise<void\\> +▸ createDatabase(`name`: string): Promise<void\\> creates new database and connects to it #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L134) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:134](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L134) ___ ### createForeignKey -▸ `Private`createForeignKey(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `createdColumns`: string[], `diff?`: [IsSame](../interfaces/knex.issame.md)): void +▸ `Private`createForeignKey(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `createdColumns`: string[], `diff?`: [IsSame](../interfaces/knex.issame.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `createdColumns` \| string[] \| `diff?` \| [IsSame](../interfaces/knex.issame.md) \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:474](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L474) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:474](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L474) ___ ### createForeignKeyReference -▸ `Private`createForeignKeyReference(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ `Private`createForeignKeyReference(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:493](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L493) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:493](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L493) ___ ### createForeignKeys -▸ `Private`createForeignKeys(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `props?`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `createdColumns?`: string[]): void +▸ `Private`createForeignKeys(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `props?`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `createdColumns?`: string[]): void #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| - \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| - \| -`props?` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| - \| -`createdColumns` \| string[] \| ... \| +Name \| Type \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`props?` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| +`createdColumns` \| string[] \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:467](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L467) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:467](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L467) ___ ### createIndex -▸ `Private`createIndex(`table`: [CreateTableBuilder](../interfaces/knex.knex.createtablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `index`: { `name?`: undefined \\\| string \\\| boolean ; `properties`: string \\\| string[] ; `type?`: undefined \\\| string }, `unique`: boolean): void +▸ `Private`createIndex(`table`: [CreateTableBuilder](../interfaces/knex.knex-1.createtablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `index`: { `name?`: string \\\| boolean ; `properties`: string \\\| string[] ; `type?`: string }, `unique`: boolean): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [CreateTableBuilder](../interfaces/knex.knex.createtablebuilder.md) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`index` \| { `name?`: undefined \\\| string \\\| boolean ; `properties`: string \\\| string[] ; `type?`: undefined \\\| string } \| +:------ \| :------ \| +`table` \| [CreateTableBuilder](../interfaces/knex.knex-1.createtablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`index` \| object \| +`index.name?` \| string \\\| boolean \| +`index.properties` \| string \\\| string[] \| +`index.type?` \| string \| `unique` \| boolean \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:250](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L250) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:250](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L250) ___ ### createSchema -▸ createSchema(`wrap?`: boolean): Promise<void\\> +▸ createSchema(`wrap?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L29) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L29) ___ ### createSimpleTableColumn -▸ `Private`createSimpleTableColumn(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +▸ `Private`createSimpleTableColumn(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `alter?` \| [IsSame](../interfaces/knex.issame.md) \| -Returns: [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:383](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L383) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:383](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L383) ___ ### createTable -▸ `Private`createTable(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `createdColumns`: string[]): [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +▸ `Private`createTable(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `createdColumns`: string[]): [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `createdColumns` \| string[] \| -Returns: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:228](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L228) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:228](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L228) ___ ### createTableColumn -▸ `Private`createTableColumn(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md)[] +▸ `Private`createTableColumn(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `alter?`: [IsSame](../interfaces/knex.issame.md)): [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md)[] #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `alter?` \| [IsSame](../interfaces/knex.issame.md) \| -Returns: [ColumnBuilder](../interfaces/knex.knex.columnbuilder.md)[] +Returns: [ColumnBuilder](../interfaces/knex.knex-1.columnbuilder.md)[] -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:370](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L370) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:370](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L370) ___ ### dropDatabase -▸ dropDatabase(`name`: string): Promise<void\\> +▸ dropDatabase(`name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:140](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L140) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:140](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L140) ___ ### dropSchema -▸ dropSchema(`wrap?`: boolean, `dropMigrationsTable?`: boolean, `dropDb?`: boolean): Promise<void\\> +▸ dropSchema(`wrap?`: boolean, `dropMigrationsTable?`: boolean, `dropDb?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| `dropMigrationsTable` \| boolean \| false \| `dropDb` \| boolean \| false \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L69) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L69) ___ ### dropTable -▸ `Private`dropTable(`name`: string, `schema?`: string): [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +▸ `Private`dropTable(`name`: string, `schema?`: string): [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `schema?` \| string \| -Returns: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:336](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L336) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:336](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L336) ___ ### dropTableColumn -▸ `Private`dropTableColumn(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `column`: [Column](../interfaces/knex.column.md)): void +▸ `Private`dropTableColumn(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `column`: [Column](../interfaces/knex.column.md)): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| `column` \| [Column](../interfaces/knex.column.md) \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:419](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L419) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:419](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L419) ___ ### dump -▸ `Private`dump(`builder`: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md), `append?`: string): string +▸ `Private`dump(`builder`: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md), `append?`: string): string #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`builder` \| [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md) \| - \| +:------ \| :------ \| :------ \| +`builder` \| [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md) \| - \| `append` \| string \| '\\n\\n' \| Returns: string -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:615](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L615) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:615](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L615) ___ ### ensureDatabase -▸ ensureDatabase(): Promise<void\\> +▸ ensureDatabase(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L35) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L35) ___ ### execute -▸ execute(`sql`: string): Promise<void\\> +▸ execute(`sql`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L146) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L146) ___ ### findIndexDifference -▸ `Private`findIndexDifference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `remove`: [Column](../interfaces/knex.column.md)[]): object +▸ `Private`findIndexDifference(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `remove`: [Column](../interfaces/knex.column.md)[]): object #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `table` \| [DatabaseTable](knex.databasetable.md) \| `remove` \| [Column](../interfaces/knex.column.md)[] \| Returns: object Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `addIndex` \| [IndexDef](../interfaces/knex.indexdef.md)[] \| `dropIndex` \| [IndexDef](../interfaces/knex.indexdef.md)[] \| -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:538](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L538) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:538](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L538) ___ ### findRenamedColumns -▸ `Private`findRenamedColumns(`create`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `remove`: [Column](../interfaces/knex.column.md)[]): { `from`: [Column](../interfaces/knex.column.md) ; `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] +▸ `Private`findRenamedColumns(`create`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[], `remove`: [Column](../interfaces/knex.column.md)[]): { `from`: [Column](../interfaces/knex.column.md) ; `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] #### Parameters: Name \| Type \| ------- \| ------ \| -`create` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| +:------ \| :------ \| +`create` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\>[] \| `remove` \| [Column](../interfaces/knex.column.md)[] \| -Returns: { `from`: [Column](../interfaces/knex.column.md) ; `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] +Returns: { `from`: [Column](../interfaces/knex.column.md) ; `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\> }[] -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:508](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L508) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:508](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L508) ___ ### generate -▸ generate(): Promise<string\\> +▸ generate(): Promise<string\\> -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L20) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L20) ___ ### getCreateSchemaSQL -▸ getCreateSchemaSQL(`wrap?`: boolean): Promise<string\\> +▸ getCreateSchemaSQL(`wrap?`: boolean): Promise<string\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L46) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L46) ___ ### getDropSchemaSQL -▸ getDropSchemaSQL(`wrap?`: boolean, `dropMigrationsTable?`: boolean): Promise<string\\> +▸ getDropSchemaSQL(`wrap?`: boolean, `dropMigrationsTable?`: boolean): Promise<string\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| `dropMigrationsTable` \| boolean \| false \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L79) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L79) ___ @@ -519,13 +519,13 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `meta` \| [EntityMetadata](core.entitymetadata.md)<T\\> \| `prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<T\\> \| `type` \| index \\\| unique \| @@ -533,179 +533,179 @@ Name \| Type \| Returns: string -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:457](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L457) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:457](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L457) ___ ### getOrderedMetadata -▸ `Private`getOrderedMetadata(): [EntityMetadata](core.entitymetadata.md)<any\\>[] +▸ `Private`getOrderedMetadata(): [EntityMetadata](core.entitymetadata.md)<any\\>[] -Returns: [EntityMetadata](core.entitymetadata.md)<any\\>[] +Returns: [EntityMetadata](core.entitymetadata.md)<any\\>[] -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:595](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L595) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:595](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L595) ___ ### getUpdateSchemaSQL -▸ getUpdateSchemaSQL(`wrap?`: boolean, `safe?`: boolean, `dropTables?`: boolean): Promise<string\\> +▸ getUpdateSchemaSQL(`wrap?`: boolean, `safe?`: boolean, `dropTables?`: boolean): Promise<string\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| `safe` \| boolean \| false \| `dropTables` \| boolean \| true \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L99) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L99) ___ ### getUpdateTableFKsSQL -▸ `Private`getUpdateTableFKsSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md), `createdColumns`: string[]): string +▸ `Private`getUpdateTableFKsSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md), `createdColumns`: string[]): string #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `schema` \| [DatabaseSchema](knex.databaseschema.md) \| `createdColumns` \| string[] \| Returns: string -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:164](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L164) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:164](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L164) ___ ### getUpdateTableIndexesSQL -▸ `Private`getUpdateTableIndexesSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md)): string +▸ `Private`getUpdateTableIndexesSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md)): string #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `schema` \| [DatabaseSchema](knex.databaseschema.md) \| Returns: string -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L180) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L180) ___ ### getUpdateTableSQL -▸ `Private`getUpdateTableSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md), `safe`: boolean, `createdColumns`: string[]): string +▸ `Private`getUpdateTableSQL(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `schema`: [DatabaseSchema](knex.databaseschema.md), `safe`: boolean, `createdColumns`: string[]): string #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `schema` \| [DatabaseSchema](knex.databaseschema.md) \| `safe` \| boolean \| `createdColumns` \| string[] \| Returns: string -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:154](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L154) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:154](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L154) ___ ### shouldHaveColumn -▸ `Private`shouldHaveColumn(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `update?`: boolean): boolean +▸ `Private`shouldHaveColumn(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `update?`: boolean): boolean #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| - \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| +:------ \| :------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| - \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| `update` \| boolean \| false \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:347](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L347) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:347](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L347) ___ ### updateSchema -▸ updateSchema(`wrap?`: boolean, `safe?`: boolean, `dropTables?`: boolean): Promise<void\\> +▸ updateSchema(`wrap?`: boolean, `safe?`: boolean, `dropTables?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `wrap` \| boolean \| true \| `safe` \| boolean \| false \| `dropTables` \| boolean \| true \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L94) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L94) ___ ### updateTable -▸ `Private`updateTable(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `safe`: boolean, `createdColumns`: string[]): [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md)[] +▸ `Private`updateTable(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `table`: [DatabaseTable](knex.databasetable.md), `safe`: boolean, `createdColumns`: string[]): [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md)[] #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `table` \| [DatabaseTable](knex.databasetable.md) \| `safe` \| boolean \| `createdColumns` \| string[] \| -Returns: [SchemaBuilder](../interfaces/knex.knex.schemabuilder.md)[] +Returns: [SchemaBuilder](../interfaces/knex.knex-1.schemabuilder.md)[] -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:261](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L261) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L261) ___ ### updateTableColumn -▸ `Private`updateTableColumn(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md), `diff`: [IsSame](../interfaces/knex.issame.md), `createdColumns`: string[]): void +▸ `Private`updateTableColumn(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md), `diff`: [IsSame](../interfaces/knex.issame.md), `createdColumns`: string[]): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `column` \| [Column](../interfaces/knex.column.md) \| `diff` \| [IsSame](../interfaces/knex.issame.md) \| `createdColumns` \| string[] \| Returns: void -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:401](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L401) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:401](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L401) ___ ### wrapSchema -▸ `Private`wrapSchema(`sql`: string, `wrap?`: boolean): Promise<string\\> +▸ `Private`wrapSchema(`sql`: string, `wrap?`: boolean): Promise<string\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `sql` \| string \| - \| `wrap` \| boolean \| true \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Defined in: [packages/knex/src/schema/SchemaGenerator.ts:216](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaGenerator.ts#L216) +Defined in: [packages/knex/src/schema/SchemaGenerator.ts:216](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaGenerator.ts#L216) diff --git a/knex.schemahelper.md b/knex.schemahelper.md index 45e9444..70cd516 100644 --- a/knex.schemahelper.md +++ b/knex.schemahelper.md @@ -2,6 +2,7 @@ id: "knex.schemahelper" title: "Class: SchemaHelper" sidebar_label: "SchemaHelper" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [knex](../modules/knex.md).SchemaHelper -## Hierarchy - -* SchemaHelper - ## Constructors ### constructor @@ -25,54 +22,54 @@ hide_title: true ### databaseExists -▸ databaseExists(`connection`: [Connection](core.connection.md), `name`: string): Promise<boolean\\> +▸ databaseExists(`connection`: [Connection](core.connection.md), `name`: string): Promise<boolean\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [Connection](core.connection.md) \| `name` \| string \| -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:182](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L182) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:182](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L182) ___ ### finalizeTable -▸ finalizeTable(`table`: [TableBuilder](../interfaces/knex.knex.tablebuilder.md), `charset`: string, `collate?`: string): void +▸ finalizeTable(`table`: [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md), `charset`: string, `collate?`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`table` \| [TableBuilder](../interfaces/knex.knex.tablebuilder.md) \| +:------ \| :------ \| +`table` \| [TableBuilder](../interfaces/knex.knex-1.tablebuilder.md) \| `charset` \| string \| `collate?` \| string \| Returns: void -Defined in: [packages/knex/src/schema/SchemaHelper.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L16) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L16) ___ ### getColumns -▸ getColumns(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<any[]\\> +▸ getColumns(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `tableName` \| string \| `schemaName?` \| string \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L93) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L93) ___ @@ -83,12 +80,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:158](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L158) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:158](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L158) ___ @@ -99,12 +96,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:166](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L166) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L166) ___ @@ -115,12 +112,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `dbName` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:170](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L170) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L170) ___ @@ -130,7 +127,7 @@ ___ Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:178](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L178) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L178) ___ @@ -141,48 +138,48 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:162](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L162) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L162) ___ ### getEnumDefinitions -▸ getEnumDefinitions(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> +▸ getEnumDefinitions(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `tableName` \| string \| `schemaName?` \| string \| -Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> +Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L81) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L81) ___ ### getForeignKeys -▸ getForeignKeys(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> +▸ getForeignKeys(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `tableName`: string, `schemaName?`: string): Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `tableName` \| string \| `schemaName?` \| string \| -Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> +Returns: Promise<[Dictionary](../modules/core.md#dictionary)<any\\>\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:76](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L76) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:76](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L76) ___ @@ -193,13 +190,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| `schemaName?` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L101) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L101) ___ @@ -212,14 +209,14 @@ Returns the default name of index for the given columns #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| `columns` \| string[] \| `type` \| index \\\| unique \\\| foreign \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L108) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L108) ___ @@ -230,14 +227,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `tableName` \| string \| `schemaName?` \| string \| Returns: Promise<[Index](../interfaces/knex.index.md)[]\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:97](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L97) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L97) ___ @@ -247,7 +244,7 @@ ___ Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L85) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L85) ___ @@ -257,46 +254,46 @@ ___ Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:174](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L174) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L174) ___ ### getPrimaryKeys -▸ getPrimaryKeys(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `indexes`: [Index](../interfaces/knex.index.md)[], `tableName`: string, `schemaName?`: string): Promise<string[]\\> +▸ getPrimaryKeys(`connection`: [AbstractSqlConnection](knex.abstractsqlconnection.md), `indexes`: [Index](../interfaces/knex.index.md)[], `tableName`: string, `schemaName?`: string): Promise<string[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| [AbstractSqlConnection](knex.abstractsqlconnection.md) \| `indexes` \| [Index](../interfaces/knex.index.md)[] \| `tableName` \| string \| `schemaName?` \| string \| -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:72](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L72) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:72](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L72) ___ ### getRenameColumnSQL -▸ getRenameColumnSQL(`tableName`: string, `from`: [Column](../interfaces/knex.column.md), `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `idx?`: number, `quote?`: string): string +▸ getRenameColumnSQL(`tableName`: string, `from`: [Column](../interfaces/knex.column.md), `to`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `idx?`: number, `quote?`: string): string #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `tableName` \| string \| - \| `from` \| [Column](../interfaces/knex.column.md) \| - \| -`to` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| +`to` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| `idx` \| number \| 0 \| `quote` \| string \| '"' \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L89) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L89) ___ @@ -307,12 +304,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `charset` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L8) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L8) ___ @@ -322,114 +319,114 @@ ___ Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L12) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L12) ___ ### getTypeDefinition -▸ getTypeDefinition(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean): string +▸ getTypeDefinition(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `lengths?`: [Dictionary](../modules/core.md#dictionary)<number\\>, `allowZero?`: boolean): string #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| -`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| ... \| -`lengths` \| [Dictionary](../modules/core.md#dictionary)<number\\> \| ... \| +:------ \| :------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| +`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| - \| +`lengths` \| [Dictionary](../modules/core.md#dictionary)<number\\> \| - \| `allowZero` \| boolean \| false \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L20) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L20) ___ ### getTypeFromDefinition -▸ getTypeFromDefinition(`type`: string, `defaultType`: string, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): string +▸ getTypeFromDefinition(`type`: string, `defaultType`: string, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): string #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type` \| string \| `defaultType` \| string \| -`types?` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| +`types?` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L62) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L62) ___ ### hasSameDefaultValue -▸ `Private`hasSameDefaultValue(`info`: [Column](../interfaces/knex.column.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `defaultValues`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): boolean +▸ `Private`hasSameDefaultValue(`info`: [Column](../interfaces/knex.column.md), `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `defaultValues`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): boolean #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `info` \| [Column](../interfaces/knex.column.md) \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:214](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L214) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:214](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L214) ___ ### hasSameEnumDefinition -▸ `Private`hasSameEnumDefinition(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md)): boolean +▸ `Private`hasSameEnumDefinition(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md)): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `column` \| [Column](../interfaces/knex.column.md) \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:251](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L251) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:251](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L251) ___ ### hasSameIndex -▸ `Private`hasSameIndex(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md)): boolean +▸ `Private`hasSameIndex(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md)): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `column` \| [Column](../interfaces/knex.column.md) \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:241](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L241) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:241](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L241) ___ ### hasSameType -▸ `Private`hasSameType(`columnType`: string, `infoType`: string, `types`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): boolean +▸ `Private`hasSameType(`columnType`: string, `infoType`: string, `types`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): boolean #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnType` \| string \| `infoType` \| string \| -`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| +`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:195](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L195) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:195](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L195) ___ @@ -439,7 +436,7 @@ ___ Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L51) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L51) ___ @@ -452,86 +449,86 @@ Implicit indexes will be ignored when diffing #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L58) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L58) ___ ### isSame -▸ isSame(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md), `idx?`: number, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `defaultValues?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): [IsSame](../interfaces/knex.issame.md) +▸ isSame(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `column`: [Column](../interfaces/knex.column.md), `idx?`: number, `types?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>, `defaultValues?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): [IsSame](../interfaces/knex.issame.md) #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| +:------ \| :------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| - \| `column` \| [Column](../interfaces/knex.column.md) \| - \| `idx` \| number \| 0 \| -`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| ... \| -`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| ... \| +`types` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| - \| +`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| - \| Returns: [IsSame](../interfaces/knex.issame.md) -Defined in: [packages/knex/src/schema/SchemaHelper.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L36) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L36) ___ ### mapForeignKeys -▸ mapForeignKeys(`fks`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ mapForeignKeys(`fks`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fks` \| any[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/knex/src/schema/SchemaHelper.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L116) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L116) ___ ### normalizeDefaultValue -▸ normalizeDefaultValue(`defaultValue`: string, `length`: number, `defaultValues?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): string \\\| number +▸ normalizeDefaultValue(`defaultValue`: string, `length`: number, `defaultValues?`: [Dictionary](../modules/core.md#dictionary)<string[]\\>): string \\\| number #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`defaultValue` \| string \| - \| -`length` \| number \| - \| -`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`defaultValue` \| string \| +`length` \| number \| +`defaultValues` \| [Dictionary](../modules/core.md#dictionary)<string[]\\> \| Returns: string \\\| number -Defined in: [packages/knex/src/schema/SchemaHelper.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L147) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:147](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L147) ___ ### processTypeWildCard -▸ `Private`processTypeWildCard(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `lengths`: [Dictionary](../modules/core.md#dictionary)<number\\>, `propType`: string, `allowZero`: boolean, `type`: string): string +▸ `Private`processTypeWildCard(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `lengths`: [Dictionary](../modules/core.md#dictionary)<number\\>, `propType`: string, `allowZero`: boolean, `type`: string): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -`lengths` \| [Dictionary](../modules/core.md#dictionary)<number\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +`lengths` \| [Dictionary](../modules/core.md#dictionary)<number\\> \| `propType` \| string \| `allowZero` \| boolean \| `type` \| string \| Returns: string -Defined in: [packages/knex/src/schema/SchemaHelper.ts:131](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L131) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L131) ___ @@ -541,7 +538,7 @@ ___ Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:143](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L143) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L143) ___ @@ -551,4 +548,4 @@ ___ Returns: boolean -Defined in: [packages/knex/src/schema/SchemaHelper.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/schema/SchemaHelper.ts#L47) +Defined in: [packages/knex/src/schema/SchemaHelper.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/schema/SchemaHelper.ts#L47) diff --git a/knex.sqlentitymanager.md b/knex.sqlentitymanager.md index e6feb5c..50b20a2 100644 --- a/knex.sqlentitymanager.md +++ b/knex.sqlentitymanager.md @@ -2,6 +2,7 @@ id: "knex.sqlentitymanager" title: "Class: SqlEntityManager<D>" sidebar_label: "SqlEntityManager" +custom_edit_url: null hide_title: true --- @@ -14,7 +15,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `D` \| [AbstractSqlDriver](knex.abstractsqldriver.md) \| [AbstractSqlDriver](knex.abstractsqldriver.md) \| ## Hierarchy @@ -32,24 +33,24 @@ Name \| Type \| Default \| #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md), D\\> \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md), D\\> \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| - \| `driver` \| D \| - \| `metadata` \| [MetadataStorage](core.metadatastorage.md) \| - \| `useContext` \| boolean \| true \| -`eventManager` \| [EventManager](core.eventmanager.md) \| ... \| +`eventManager` \| [EventManager](core.eventmanager.md) \| - \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L33) +Defined in: [packages/core/src/EntityManager.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L33) ## Properties @@ -67,7 +68,7 @@ ___ Inherited from: [EntityManager](core.entitymanager.md).[id](core.entitymanager.md#id) -Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L22) +Defined in: [packages/core/src/EntityManager.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L22) ___ @@ -77,66 +78,66 @@ ___ Inherited from: [EntityManager](core.entitymanager.md).[name](core.entitymanager.md#name) -Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L23) +Defined in: [packages/core/src/EntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L23) ## Methods -### \\_\\_@custom@36825 +### [custom] -▸ __@custom@36825(): string +▸ [custom](): string Returns: string Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:940](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L940) +Defined in: [packages/core/src/EntityManager.ts:968](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L968) ___ ### addFilter -▸ addFilter<T1\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void +▸ addFilter<T1\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\>, `entityName?`: [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| -`entityName?` \| string \\\| EntityClass<T1\\> \\\| [EntitySchema](core.entityschema.md)<T1, any\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1\\> \| +`entityName?` \| [EntityName](../modules/core.md#entityname)<T1\\> \\\| [[EntityName](../modules/core.md#entityname)<T1\\>] \| `enabled?` \| boolean \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L145) +Defined in: [packages/core/src/EntityManager.ts:145](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L145) -▸ addFilter<T1, T2\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>] \| `enabled?` \| boolean \| @@ -144,16 +145,16 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L150) +Defined in: [packages/core/src/EntityManager.ts:150](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L150) -▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void +▸ addFilter<T1, T2, T3\\>(`name`: string, `cond`: [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\>, `entityName?`: [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>], `enabled?`: boolean): void Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T1` \| [AnyEntity](../modules/core.md#anyentity)<T1\\> \| `T2` \| [AnyEntity](../modules/core.md#anyentity)<T2\\> \| `T3` \| [AnyEntity](../modules/core.md#anyentity)<T3\\> \| @@ -161,9 +162,9 @@ Name \| Type \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`cond` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T1\\>\\> \\\| NonNullable<Query<T2\\>\\> \\\| NonNullable<Query<T3\\>\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \\\| (`args`: [Dictionary](../modules/core.md#dictionary)<any\\>) => [FilterQuery](../modules/core.md#filterquery)<T1 \\\| T2 \\\| T3\\> \| `entityName?` \| [[EntityName](../modules/core.md#entityname)<T1\\>, [EntityName](../modules/core.md#entityname)<T2\\>, [EntityName](../modules/core.md#entityname)<T3\\>] \| `enabled?` \| boolean \| @@ -171,7 +172,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L155) +Defined in: [packages/core/src/EntityManager.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L155) ___ @@ -182,13 +183,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| @@ -196,34 +197,36 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L193) +Defined in: [packages/core/src/EntityManager.ts:193](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L193) ___ ### applyFilters -▸ `Protected`applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ applyFilters<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> + +`internal` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| +`options` \| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:205](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L205) +Defined in: [packages/core/src/EntityManager.ts:218](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L218) ___ @@ -236,42 +239,42 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| T \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| T \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:532](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L532) +Defined in: [packages/core/src/EntityManager.ts:546](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L546) ___ ### begin -▸ begin(`ctx?`: any): Promise<void\\> +▸ begin(`ctx?`: any): Promise<void\\> Starts new transaction bound to this EntityManager. Use `ctx` parameter to provide the parent when nesting transactions. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:381](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L381) +Defined in: [packages/core/src/EntityManager.ts:394](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L394) ___ @@ -284,13 +287,13 @@ Checks whether given property can be populated on the entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `property` \| string \| @@ -298,7 +301,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L698) +Defined in: [packages/core/src/EntityManager.ts:712](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L712) ___ @@ -312,78 +315,79 @@ Clears the EntityManager. All entities that are currently managed by this Entity Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:691](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L691) +Defined in: [packages/core/src/EntityManager.ts:705](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L705) ___ ### commit -▸ commit(): Promise<void\\> +▸ commit(): Promise<void\\> Commits the transaction bound to this EntityManager. Flushes before doing the actual commit query. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:388](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L388) +Defined in: [packages/core/src/EntityManager.ts:401](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L401) ___ ### count -▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:582](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L582) +Defined in: [packages/core/src/EntityManager.ts:596](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L596) ___ ### create -▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: undefined \\\| boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> +▸ create<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: { `managed?`: boolean }): [Loaded](../modules/core.md#loaded)<T, P\\> Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| { `managed?`: undefined \\\| boolean } \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| object \| +`options.managed?` \| boolean \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:525](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L525) +Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L539) ___ @@ -396,44 +400,44 @@ Creates a QueryBuilder instance #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `alias?` \| string \| `type?` \| read \\\| write \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L15) +Defined in: [packages/knex/src/SqlEntityManager.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L15) ___ ### execute -▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run): Promise<T\\> +▸ execute<T\\>(`queryOrKnex`: string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\>, `params?`: any[], `method?`: all \\\| get \\\| run): Promise<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\\\>\\\\>[] \| +:------ \| :------ \| :------ \| +`T` \| [QueryResult](../interfaces/core.queryresult.md) \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| [EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[] \| #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex.raw.md)<any\\> \| - \| -`params` \| any[] \| ... \| +:------ \| :------ \| :------ \| +`queryOrKnex` \| string \\\| [QueryBuilder](knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](../interfaces/knex.knex-1.raw.md)<any\\> \| - \| +`params` \| any[] \| - \| `method` \| all \\\| get \\\| run \| 'all' \| Returns: Promise<T\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L27) +Defined in: [packages/knex/src/SqlEntityManager.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L27) ___ @@ -446,14 +450,14 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -462,7 +466,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L88) +Defined in: [packages/core/src/EntityManager.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L88) ▸ find<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -471,14 +475,14 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -490,7 +494,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L93) +Defined in: [packages/core/src/EntityManager.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L93) ___ @@ -504,14 +508,14 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -520,7 +524,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:248](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L248) +Defined in: [packages/core/src/EntityManager.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L261) ▸ findAndCount<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -530,14 +534,14 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -549,7 +553,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:254](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L254) +Defined in: [packages/core/src/EntityManager.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L267) ___ @@ -562,14 +566,14 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| @@ -578,7 +582,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:273](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L273) +Defined in: [packages/core/src/EntityManager.ts:286](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L286) ▸ findOne<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -587,14 +591,14 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -604,7 +608,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:278](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L278) +Defined in: [packages/core/src/EntityManager.ts:291](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L291) ___ @@ -619,14 +623,14 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| @@ -635,7 +639,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:334](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L334) +Defined in: [packages/core/src/EntityManager.ts:347](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L347) ▸ findOneOrFail<T, P\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -646,14 +650,14 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| @@ -663,22 +667,22 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:341](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L341) +Defined in: [packages/core/src/EntityManager.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L354) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:684](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L684) +Defined in: [packages/core/src/EntityManager.ts:698](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L698) ___ @@ -691,7 +695,7 @@ Returns new EntityManager instance with its own identity map #### Parameters: Name \| Type \| Default value \| Description \| ------- \| ------ \| ------ \| ------ \| +:------ \| :------ \| :------ \| :------ \| `clear` \| boolean \| true \| do we want clear identity map? defaults to true \| `useContext` \| boolean \| false \| use request context? should be used only for top level request scope EM, defaults to false \| @@ -699,7 +703,7 @@ Name \| Type \| Default value \| Description \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:755](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L755) +Defined in: [packages/core/src/EntityManager.ts:769](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L769) ___ @@ -713,7 +717,7 @@ Gets the EntityComparator. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L825) +Defined in: [packages/core/src/EntityManager.ts:853](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L853) ___ @@ -726,14 +730,14 @@ Gets the Connection instance, by default returns write connection #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| Returns: ReturnType<D[getConnection]\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L52) +Defined in: [packages/core/src/EntityManager.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L52) ___ @@ -747,7 +751,7 @@ Gets the EntityManager based on current transaction/request context. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L786) +Defined in: [packages/core/src/EntityManager.ts:800](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L800) ___ @@ -762,7 +766,7 @@ Driver is singleton, for one MikroORM instance, only one driver is created. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L45) +Defined in: [packages/core/src/EntityManager.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L45) ___ @@ -776,7 +780,7 @@ Gets the EntityFactory used by the EntityManager. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:779](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L779) +Defined in: [packages/core/src/EntityManager.ts:793](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L793) ___ @@ -788,7 +792,7 @@ ___ Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:797](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L797) +Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L811) ___ @@ -801,38 +805,38 @@ Returns filter parameters for given filter set in this context. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\\\> \| +:------ \| :------ \| :------ \| +`T` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| [Dictionary](../modules/core.md#dictionary)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| Returns: T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L181) +Defined in: [packages/core/src/EntityManager.ts:181](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L181) ___ ### getKnex -▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> +▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> Returns configured knex instance. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/SqlEntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L23) +Defined in: [packages/knex/src/SqlEntityManager.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L23) ___ @@ -846,7 +850,7 @@ Gets the MetadataStorage. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L818) +Defined in: [packages/core/src/EntityManager.ts:846](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L846) ___ @@ -860,7 +864,7 @@ Gets the platform instance. Just like the driver, platform is singleton, one for Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L59) +Defined in: [packages/core/src/EntityManager.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L59) ___ @@ -873,14 +877,14 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| @@ -890,7 +894,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:539](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L539) +Defined in: [packages/core/src/EntityManager.ts:553](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L553) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[]): T @@ -899,13 +903,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \\\| [Primary](../modules/core.md#primary)<T\\>[] \| @@ -913,7 +917,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:544](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L544) +Defined in: [packages/core/src/EntityManager.ts:558](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L558) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false, `convertCustomTypes?`: boolean): T @@ -922,13 +926,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| @@ -938,7 +942,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:549](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L549) +Defined in: [packages/core/src/EntityManager.ts:563](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L563) ▸ getReference<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped?`: boolean, `convertCustomTypes?`: boolean): T \\\| [Reference](core.reference.md)<T\\> @@ -947,13 +951,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped?` \| boolean \| @@ -963,7 +967,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:554](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L554) +Defined in: [packages/core/src/EntityManager.ts:568](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L568) ___ @@ -974,21 +978,21 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| -`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](knex.entityrepository.md)<T\\\\> \| +`U` \| [EntityRepository](core.entityrepository.md)<T, U\\> \| [EntityRepository](knex.entityrepository.md)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [GetRepository](../modules/core.md#getrepository)<T, U\\> Overrides: [EntityManager](core.entitymanager.md) -Defined in: [packages/knex/src/SqlEntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityManager.ts#L31) +Defined in: [packages/knex/src/SqlEntityManager.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityManager.ts#L31) ___ @@ -1001,14 +1005,14 @@ Gets the transaction context (driver dependent object used to make sure queries #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| unknown \| any \| Returns: undefined \\\| T Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:811](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L811) +Defined in: [packages/core/src/EntityManager.ts:825](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L825) ___ @@ -1022,7 +1026,7 @@ Gets the UnitOfWork used by the EntityManager to coordinate operations. Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:772](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L772) +Defined in: [packages/core/src/EntityManager.ts:786](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L786) ___ @@ -1036,7 +1040,7 @@ Gets EntityValidator instance Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L81) +Defined in: [packages/core/src/EntityManager.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L81) ___ @@ -1050,29 +1054,29 @@ Checks whether this EntityManager is currently operating inside a database trans Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:804](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L804) +Defined in: [packages/core/src/EntityManager.ts:818](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L818) ___ ### lock -▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> +▸ lock(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>, `lockMode`: [LockMode](../enums/core.lockmode.md), `lockVersion?`: number \\\| Date): Promise<void\\> Runs your callback wrapped inside a database transaction. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| `lockMode` \| [LockMode](../enums/core.lockmode.md) \| `lockVersion?` \| number \\\| Date \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:405](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L405) +Defined in: [packages/core/src/EntityManager.ts:418](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L418) ___ @@ -1085,13 +1089,13 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -1099,7 +1103,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:468](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L468) +Defined in: [packages/core/src/EntityManager.ts:481](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L481) ___ @@ -1113,13 +1117,13 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `refresh?` \| boolean \| @@ -1127,7 +1131,7 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:487](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L487) +Defined in: [packages/core/src/EntityManager.ts:501](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L501) ▸ merge<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `refresh?`: boolean, `convertCustomTypes?`: boolean): T @@ -1137,13 +1141,13 @@ via second parameter. By default it will return already loaded entities without #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| @@ -1153,35 +1157,35 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:493](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L493) +Defined in: [packages/core/src/EntityManager.ts:507](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L507) ___ ### nativeDelete -▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> +▸ nativeDelete<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:456](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L456) +Defined in: [packages/core/src/EntityManager.ts:469](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L469) ___ @@ -1194,20 +1198,20 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:412](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L412) +Defined in: [packages/core/src/EntityManager.ts:425](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L425) ▸ nativeInsert<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<[Primary](../modules/core.md#primary)<T\\>\\> @@ -1216,13 +1220,13 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -1230,42 +1234,42 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:417](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L417) +Defined in: [packages/core/src/EntityManager.ts:430](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L430) ___ ### nativeUpdate -▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> +▸ nativeUpdate<T\\>(`entityName`: [EntityName](../modules/core.md#entityname)<T\\>, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| - \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| - \| -`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| - \| -`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:442](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L442) +Defined in: [packages/core/src/EntityManager.ts:455](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L455) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](knex.entitymanager.md)<D\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): [EntityManager](knex.entitymanager.md)<D\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1273,20 +1277,20 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:603](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L603) +Defined in: [packages/core/src/EntityManager.ts:617](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L617) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -1294,20 +1298,20 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \\\| ([AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>)[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:628](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L628) +Defined in: [packages/core/src/EntityManager.ts:642](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L642) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -1317,37 +1321,37 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:638](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L638) +Defined in: [packages/core/src/EntityManager.ts:652](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L652) ___ ### populate -▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<T, P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1356,26 +1360,26 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:718](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L718) +Defined in: [packages/core/src/EntityManager.ts:732](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L732) -▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1384,26 +1388,26 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:723](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L723) +Defined in: [packages/core/src/EntityManager.ts:737](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L737) -▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<T, P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -1412,34 +1416,34 @@ Name \| Type \| Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:728](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L728) +Defined in: [packages/core/src/EntityManager.ts:742](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L742) ___ ### processWhere -▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> +▸ `Protected`processWhere<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `type`: read \\\| update \\\| delete): Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `type` \| read \\\| update \\\| delete \| Returns: Promise<[FilterQuery](../modules/core.md#filterquery)<T\\>\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L185) +Defined in: [packages/core/src/EntityManager.ts:185](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L185) ___ @@ -1455,26 +1459,26 @@ To remove entities by condition, use `em.nativeDelete()`. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [Reference](core.reference.md)<T\\> \\\| (T \\\| [Reference](core.reference.md)<T\\>)[] \| Returns: [EntityManager](knex.entitymanager.md)<D\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:648](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L648) +Defined in: [packages/core/src/EntityManager.ts:662](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L662) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -1482,20 +1486,20 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [Reference](core.reference.md)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:666](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L666) +Defined in: [packages/core/src/EntityManager.ts:680](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L680) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -1505,34 +1509,48 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:676](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L676) +Defined in: [packages/core/src/EntityManager.ts:690](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L690) + +___ + +### resetTransactionContext + +▸ resetTransactionContext(): void + +Resets the transaction context. + +Returns: void + +Inherited from: [EntityManager](core.entitymanager.md) + +Defined in: [packages/core/src/EntityManager.ts:839](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L839) ___ ### rollback -▸ rollback(): Promise<void\\> +▸ rollback(): Promise<void\\> Rollbacks the transaction bound to this EntityManager. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:397](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L397) +Defined in: [packages/core/src/EntityManager.ts:410](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L410) ___ ### setFilterParams -▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void +▸ setFilterParams(`name`: string, `args`: [Dictionary](../modules/core.md#dictionary)<any\\>): void Sets filter parameter values globally inside context defined by this entity manager. If you want to set shared value for all contexts, be sure to use the root entity manager. @@ -1540,37 +1558,58 @@ If you want to set shared value for all contexts, be sure to use the root entity #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| +`args` \| [Dictionary](../modules/core.md#dictionary)<any\\> \| + +Returns: void + +Inherited from: [EntityManager](core.entitymanager.md) + +Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L174) + +___ + +### setTransactionContext + +▸ setTransactionContext(`ctx`: any): void + +Sets the transaction context. + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`ctx` \| any \| Returns: void Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:174](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L174) +Defined in: [packages/core/src/EntityManager.ts:832](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L832) ___ ### storeCache -▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> +▸ storeCache(`config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: { `key`: string }, `data`: unknown): Promise<void\\> `internal` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| -`key` \| { `key`: string } \| +`key` \| object \| +`key.key` \| string \| `data` \| unknown \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L932) +Defined in: [packages/core/src/EntityManager.ts:960](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L960) ___ @@ -1583,49 +1622,49 @@ Runs your callback wrapped inside a database transaction. #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| - \| -`ctx` \| any \| ... \| +Name \| Type \| +:------ \| :------ \| +`cb` \| (`em`: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)]) => Promise<T\\> \| +`ctx` \| any \| Returns: Promise<T\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:364](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L364) +Defined in: [packages/core/src/EntityManager.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L377) ___ ### tryCache -▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +▸ tryCache<T, R\\>(`entityName`: string, `config`: undefined \\\| number \\\| boolean \\\| [string, number], `key`: unknown, `refresh?`: boolean, `merge?`: boolean): Promise<undefined \\\| { `data?`: R ; `key`: string }\\> `internal` #### Type parameters: Name \| ------- \| +:------ \| `T` \| `R` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `config` \| undefined \\\| number \\\| boolean \\\| [string, number] \| `key` \| unknown \| `refresh?` \| boolean \| `merge?` \| boolean \| -Returns: Promise<undefined \\\| { `data?`: undefined \\\| R ; `key`: string }\\> +Returns: Promise<undefined \\\| { `data?`: R ; `key`: string }\\> Inherited from: [EntityManager](core.entitymanager.md) -Defined in: [packages/core/src/EntityManager.ts:904](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/EntityManager.ts#L904) +Defined in: [packages/core/src/EntityManager.ts:932](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/EntityManager.ts#L932) diff --git a/knex.sqlentityrepository.md b/knex.sqlentityrepository.md index c506309..80042fb 100644 --- a/knex.sqlentityrepository.md +++ b/knex.sqlentityrepository.md @@ -2,6 +2,7 @@ id: "knex.sqlentityrepository" title: "Class: SqlEntityRepository<T>" sidebar_label: "SqlEntityRepository" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| ## Hierarchy @@ -30,21 +31,21 @@ Name \| #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `_em` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| `entityName` \| [EntityName](../modules/core.md#entityname)<T\\> \| Returns: [EntityRepository](knex.entityrepository.md)<T\\> -Inherited from: [EntityRepository](core.entityrepository.md) +Overrides: [EntityRepository](core.entityrepository.md) -Defined in: [packages/knex/src/SqlEntityRepository.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L6) +Defined in: [packages/knex/src/SqlEntityRepository.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L6) ## Properties @@ -66,11 +67,11 @@ Inherited from: [EntityRepository](core.entityrepository.md).[entityName](core.e ### em -• em(): [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> +• `Protected`get em(): [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> Returns: [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L27) +Defined in: [packages/knex/src/SqlEntityRepository.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L27) ## Methods @@ -83,7 +84,7 @@ Shortcut for `wrap(entity).assign(data, { em })` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -91,7 +92,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L259) +Defined in: [packages/core/src/entity/EntityRepository.ts:259](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L259) ___ @@ -104,35 +105,35 @@ Checks whether given property can be populated on the entity. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `property` \| string \| Returns: boolean Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L223) +Defined in: [packages/core/src/entity/EntityRepository.ts:223](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L223) ___ ### count -▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> +▸ count(`where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](../interfaces/core.countoptions.md)<T\\>): Promise<number\\> Returns total number of entities matching your `where` query. #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| ... \| -`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options` \| [CountOptions](../interfaces/core.countoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L274) +Defined in: [packages/core/src/entity/EntityRepository.ts:274](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L274) ___ @@ -145,20 +146,20 @@ Creates new instance of given entity and populates it with given data #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| string[] \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| string[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: [Loaded](../modules/core.md#loaded)<T, P\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L252) +Defined in: [packages/core/src/entity/EntityRepository.ts:252](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L252) ___ @@ -171,12 +172,12 @@ Creates a QueryBuilder instance #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias?` \| string \| Returns: [QueryBuilder](knex.querybuilder.md)<T\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L16) +Defined in: [packages/knex/src/SqlEntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L16) ___ @@ -189,13 +190,13 @@ Finds all entities matching your `where` query. You can pass additional options #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| @@ -203,7 +204,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L81) +Defined in: [packages/core/src/entity/EntityRepository.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L81) ▸ find<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -212,13 +213,13 @@ Finds all entities matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -229,7 +230,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L86) +Defined in: [packages/core/src/entity/EntityRepository.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L86) ___ @@ -242,20 +243,20 @@ Finds all entities of given type. You can pass additional options via the `optio #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, P\\> \| Returns: Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L118) +Defined in: [packages/core/src/entity/EntityRepository.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L118) ▸ findAll<P\\>(`populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> @@ -264,13 +265,13 @@ Finds all entities of given type. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `limit?` \| number \| @@ -280,13 +281,13 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L123) +Defined in: [packages/core/src/entity/EntityRepository.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L123) ___ ### findAndCount -▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> +▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple where first element is the array of entities and the second is the count. @@ -294,21 +295,21 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](../interfaces/core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L99) +Defined in: [packages/core/src/entity/EntityRepository.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L99) ▸ findAndCount<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: P, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `limit?`: number, `offset?`: number): Promise<[[Loaded](../modules/core.md#loaded)<T, P\\>[], number]\\> @@ -318,13 +319,13 @@ where first element is the array of entities and the second is the count. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -335,7 +336,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L105) +Defined in: [packages/core/src/entity/EntityRepository.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L105) ___ @@ -348,13 +349,13 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -363,7 +364,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L41) +Defined in: [packages/core/src/entity/EntityRepository.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L41) ▸ findOne<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<null \\\| [Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -372,13 +373,13 @@ Finds first entity matching your `where` query. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOptions](../interfaces/core.findoneoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -387,7 +388,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L46) +Defined in: [packages/core/src/entity/EntityRepository.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L46) ___ @@ -402,13 +403,13 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| P \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -417,7 +418,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L60) +Defined in: [packages/core/src/entity/EntityRepository.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L60) ▸ findOneOrFail<P\\>(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `populate?`: [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md)): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> @@ -428,13 +429,13 @@ or via `Configuration.findOneOrFailHandler` globally. #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| any \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| any \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `populate?` \| [FindOneOrFailOptions](../interfaces/core.findoneorfailoptions.md)<T, P\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| @@ -443,42 +444,42 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L67) +Defined in: [packages/core/src/entity/EntityRepository.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L67) ___ ### flush -▸ flush(): Promise<void\\> +▸ flush(): Promise<void\\> Flushes all changes to objects that have been queued up to now to the database. This effectively synchronizes the in-memory state of managed objects with the database. This method is a shortcut for `em.flush()`, in other words, it will flush the whole UoW, not just entities registered via this particular repository. -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L166) +Defined in: [packages/core/src/entity/EntityRepository.ts:166](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L166) ___ ### getKnex -▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> +▸ getKnex(`type?`: read \\\| write): Knex<any, unknown[]\\> Returns configured knex instance. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/knex/src/SqlEntityRepository.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/SqlEntityRepository.ts#L23) +Defined in: [packages/knex/src/SqlEntityRepository.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/SqlEntityRepository.ts#L23) ___ @@ -491,13 +492,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| true \| @@ -505,7 +506,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L201) +Defined in: [packages/core/src/entity/EntityRepository.ts:201](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L201) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>): T @@ -514,20 +515,20 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| Returns: T Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L206) +Defined in: [packages/core/src/entity/EntityRepository.ts:206](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L206) ▸ getReference<PK\\>(`id`: [Primary](../modules/core.md#primary)<T\\>, `wrapped`: false): T @@ -536,13 +537,13 @@ Gets a reference to the entity identified by the given type and identifier witho #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `PK` \| string \\\| number \\\| symbol \| keyof T \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `id` \| [Primary](../modules/core.md#primary)<T\\> \| `wrapped` \| false \| @@ -550,7 +551,7 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L211) +Defined in: [packages/core/src/entity/EntityRepository.ts:211](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L211) ___ @@ -563,14 +564,14 @@ Maps raw database result to an entity and merges it to this EntityManager. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: T Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L194) +Defined in: [packages/core/src/entity/EntityRepository.ts:194](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L194) ___ @@ -584,7 +585,7 @@ via second parameter. By default it will return already loaded entities without #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| T \\\| [EntityData](../modules/core.md#entitydata)<T\\> \| `refresh?` \| boolean \| `convertCustomTypes?` \| boolean \| @@ -593,27 +594,28 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L267) +Defined in: [packages/core/src/entity/EntityRepository.ts:267](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L267) ___ ### nativeDelete -▸ nativeDelete(`where`: any): Promise<number\\> +▸ nativeDelete(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\>): Promise<number\\> Fires native delete query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| -`where` \| any \| +:------ \| :------ \| +`where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| +`options?` \| [DeleteOptions](../interfaces/core.deleteoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L187) +Defined in: [packages/core/src/entity/EntityRepository.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L187) ___ @@ -626,41 +628,42 @@ Fires native insert query. Calling this has no side effects on the context (iden #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| Returns: Promise<[Primary](../modules/core.md#primary)<T\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L173) +Defined in: [packages/core/src/entity/EntityRepository.ts:173](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L173) ___ ### nativeUpdate -▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>): Promise<number\\> +▸ nativeUpdate(`where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `data`: [EntityData](../modules/core.md#entitydata)<T\\>, `options?`: [UpdateOptions](../interfaces/core.updateoptions.md)<T\\>): Promise<number\\> Fires native update query. Calling this has no side effects on the context (identity map). #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| +`options?` \| [UpdateOptions](../interfaces/core.updateoptions.md)<T\\> \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L180) +Defined in: [packages/core/src/entity/EntityRepository.ts:180](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L180) ___ ### persist -▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ persist(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -668,20 +671,20 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L16) +Defined in: [packages/core/src/entity/EntityRepository.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L16) ___ ### persistAndFlush -▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> +▸ persistAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): Promise<void\\> Persists your entity immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.persist(e).flush()`. @@ -689,20 +692,20 @@ Equivalent to `em.persist(e).flush()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L24) +Defined in: [packages/core/src/entity/EntityRepository.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L24) ___ ### persistLater -▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void +▸ persistLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[]): void Tells the EntityManager to make an instance managed and persistent. The entity will be entered into the database at or before transaction commit or as a result of the flush operation. @@ -712,36 +715,36 @@ The entity will be entered into the database at or before transaction commit or #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \\\| [AnyEntity](../modules/core.md#anyentity)<any\\>[] \| Returns: void Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L34) +Defined in: [packages/core/src/entity/EntityRepository.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L34) ___ ### populate -▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> +▸ populate<P\\>(`entities`: T, `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -750,25 +753,25 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L230) +Defined in: [packages/core/src/entity/EntityRepository.ts:230](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L230) -▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -777,25 +780,25 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L235) +Defined in: [packages/core/src/entity/EntityRepository.ts:235](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L235) -▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> +▸ populate<P\\>(`entities`: T \\\| T[], `populate`: P, `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](../interfaces/core.queryordermap.md), `refresh?`: boolean, `validate?`: boolean): Promise<[Loaded](../modules/core.md#loaded)<T, P\\> \\\| [Loaded](../modules/core.md#loaded)<T, P\\>[]\\> Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `P` \| string \\\| number \\\| boolean \\\| symbol \\\| readonly string[] \\\| readonly keyof T[] \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entities` \| T \\\| T[] \| `populate` \| P \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](../interfaces/core.queryordermap.md) \| `refresh?` \| boolean \| `validate?` \| boolean \| @@ -804,13 +807,13 @@ Name \| Type \| Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L240) +Defined in: [packages/core/src/entity/EntityRepository.ts:240](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L240) ___ ### remove -▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> +▸ remove(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -820,20 +823,20 @@ To remove entities by condition, use `em.nativeDelete()`. #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: [EntityManager](core.entitymanager.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L138) +Defined in: [packages/core/src/entity/EntityRepository.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L138) ___ ### removeAndFlush -▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> +▸ removeAndFlush(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): Promise<void\\> Removes an entity instance immediately, flushing all not yet persisted changes to the database too. Equivalent to `em.remove(e).flush()` @@ -841,20 +844,20 @@ Equivalent to `em.remove(e).flush()` #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L146) +Defined in: [packages/core/src/entity/EntityRepository.ts:146](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L146) ___ ### removeLater -▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void +▸ removeLater(`entity`: [AnyEntity](../modules/core.md#anyentity)<any\\>): void Marks entity for removal. A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. @@ -864,11 +867,11 @@ A removed entity will be removed from the database at or before transaction comm #### Parameters: Name \| Type \| ------- \| ------ \| -`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| +:------ \| :------ \| +`entity` \| [AnyEntity](../modules/core.md#anyentity)<any\\> \| Returns: void Inherited from: [EntityRepository](core.entityrepository.md) -Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityRepository.ts#L156) +Defined in: [packages/core/src/entity/EntityRepository.ts:156](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityRepository.ts#L156) diff --git a/migrations.migration.md b/migrations.migration.md index dc3152f..4b744f3 100644 --- a/migrations.migration.md +++ b/migrations.migration.md @@ -2,6 +2,7 @@ id: "migrations.migration" title: "Class: Migration" sidebar_label: "Migration" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [migrations](../modules/migrations.md).Migration -## Hierarchy - -* Migration - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [Migration](migrations.migration.md) -Defined in: [packages/migrations/src/Migration.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L9) +Defined in: [packages/migrations/src/Migration.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L9) ## Properties @@ -40,9 +37,9 @@ ___ ### ctx -• `Protected` `Optional` ctx: undefined \\\| [Transaction](../interfaces/knex.knex.transaction.md)<any, any\\> +• `Protected` `Optional` ctx: [Transaction](../interfaces/knex.knex-1.transaction.md)<any, any\\> -Defined in: [packages/migrations/src/Migration.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L9) +Defined in: [packages/migrations/src/Migration.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L9) ___ @@ -56,7 +53,7 @@ ___ • `Private` `Readonly` queries: [Query](../modules/migrations.md#query)[] -Defined in: [packages/migrations/src/Migration.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L8) +Defined in: [packages/migrations/src/Migration.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L8) ## Methods @@ -67,48 +64,48 @@ Defined in: [packages/migrations/src/Migration.ts:8](https://github.com/mikro-or #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| [Query](../modules/migrations.md#query) \| Returns: void -Defined in: [packages/migrations/src/Migration.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L24) +Defined in: [packages/migrations/src/Migration.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L24) ___ ### down -▸ down(): Promise<void\\> +▸ down(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/Migration.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L16) +Defined in: [packages/migrations/src/Migration.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L16) ___ ### execute -▸ execute(`sql`: [Query](../modules/migrations.md#query)): Promise<[EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]\\> +▸ execute(`sql`: [Query](../modules/migrations.md#query)): Promise<[EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| [Query](../modules/migrations.md#query) \| -Returns: Promise<[EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]\\> +Returns: Promise<[EntityData](../modules/core.md#entitydata)<[AnyEntity](../modules/core.md#anyentity)<any\\>\\>[]\\> -Defined in: [packages/migrations/src/Migration.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L37) +Defined in: [packages/migrations/src/Migration.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L37) ___ ### getKnex -▸ getKnex(): Knex<any, unknown[]\\> +▸ getKnex(): Knex<any, unknown[]\\> -Returns: Knex<any, unknown[]\\> +Returns: Knex<any, unknown[]\\> -Defined in: [packages/migrations/src/Migration.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L41) +Defined in: [packages/migrations/src/Migration.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L41) ___ @@ -118,7 +115,7 @@ ___ Returns: [Query](../modules/migrations.md#query)[] -Defined in: [packages/migrations/src/Migration.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L45) +Defined in: [packages/migrations/src/Migration.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L45) ___ @@ -128,7 +125,7 @@ ___ Returns: boolean -Defined in: [packages/migrations/src/Migration.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L20) +Defined in: [packages/migrations/src/Migration.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L20) ___ @@ -138,7 +135,7 @@ ___ Returns: void -Defined in: [packages/migrations/src/Migration.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L28) +Defined in: [packages/migrations/src/Migration.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L28) ___ @@ -149,19 +146,19 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ctx` \| any \| Returns: void -Defined in: [packages/migrations/src/Migration.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L33) +Defined in: [packages/migrations/src/Migration.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L33) ___ ### up -▸ `Abstract`up(): Promise<void\\> +▸ `Abstract`up(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/Migration.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migration.ts#L14) +Defined in: [packages/migrations/src/Migration.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migration.ts#L14) diff --git a/migrations.migrationgenerator.md b/migrations.migrationgenerator.md index 475be82..ab03920 100644 --- a/migrations.migrationgenerator.md +++ b/migrations.migrationgenerator.md @@ -2,6 +2,7 @@ id: "migrations.migrationgenerator" title: "Class: MigrationGenerator" sidebar_label: "MigrationGenerator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [migrations](../modules/migrations.md).MigrationGenerator -## Hierarchy - -* MigrationGenerator - ## Constructors ### constructor @@ -22,14 +19,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| `namingStrategy` \| [NamingStrategy](../interfaces/core.namingstrategy.md) \| `options` \| [MigrationsOptions](../modules/core.md#migrationsoptions) \| Returns: [MigrationGenerator](migrations.migrationgenerator.md) -Defined in: [packages/migrations/src/MigrationGenerator.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationGenerator.ts#L5) +Defined in: [packages/migrations/src/MigrationGenerator.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationGenerator.ts#L5) ## Properties @@ -58,13 +55,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| string \| `padLeft` \| number \| Returns: string -Defined in: [packages/migrations/src/MigrationGenerator.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationGenerator.ts#L30) +Defined in: [packages/migrations/src/MigrationGenerator.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationGenerator.ts#L30) ___ @@ -75,13 +72,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `diff` \| string[] \| `path?` \| string \| Returns: Promise<[string, string]\\> -Defined in: [packages/migrations/src/MigrationGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationGenerator.ts#L11) +Defined in: [packages/migrations/src/MigrationGenerator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationGenerator.ts#L11) ___ @@ -92,13 +89,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `diff` \| string[] \| Returns: string -Defined in: [packages/migrations/src/MigrationGenerator.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationGenerator.ts#L39) +Defined in: [packages/migrations/src/MigrationGenerator.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationGenerator.ts#L39) ___ @@ -109,10 +106,10 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `className` \| string \| `diff` \| string[] \| Returns: string -Defined in: [packages/migrations/src/MigrationGenerator.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationGenerator.ts#L53) +Defined in: [packages/migrations/src/MigrationGenerator.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationGenerator.ts#L53) diff --git a/migrations.migrationrunner.md b/migrations.migrationrunner.md index 98db661..be7d473 100644 --- a/migrations.migrationrunner.md +++ b/migrations.migrationrunner.md @@ -2,6 +2,7 @@ id: "migrations.migrationrunner" title: "Class: MigrationRunner" sidebar_label: "MigrationRunner" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [migrations](../modules/migrations.md).MigrationRunner -## Hierarchy - -* MigrationRunner - ## Constructors ### constructor @@ -22,14 +19,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| `options` \| [MigrationsOptions](../modules/core.md#migrationsoptions) \| `config` \| [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> \| Returns: [MigrationRunner](migrations.migrationrunner.md) -Defined in: [packages/migrations/src/MigrationRunner.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L9) +Defined in: [packages/migrations/src/MigrationRunner.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L9) ## Properties @@ -43,7 +40,7 @@ ___ • `Private` `Readonly` connection: [AbstractSqlConnection](knex.abstractsqlconnection.md) -Defined in: [packages/migrations/src/MigrationRunner.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L7) +Defined in: [packages/migrations/src/MigrationRunner.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L7) ___ @@ -57,7 +54,7 @@ ___ • `Private` `Readonly` helper: [SchemaHelper](knex.schemahelper.md) -Defined in: [packages/migrations/src/MigrationRunner.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L8) +Defined in: [packages/migrations/src/MigrationRunner.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L8) ___ @@ -65,7 +62,7 @@ ___ • `Private` `Optional` masterTransaction: any -Defined in: [packages/migrations/src/MigrationRunner.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L9) +Defined in: [packages/migrations/src/MigrationRunner.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L9) ___ @@ -82,30 +79,30 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `migration` \| [Migration](migrations.migration.md) \| `method` \| up \\\| down \| Returns: Promise<[Query](../modules/migrations.md#query)[]\\> -Defined in: [packages/migrations/src/MigrationRunner.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L38) +Defined in: [packages/migrations/src/MigrationRunner.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L38) ___ ### run -▸ run(`migration`: [Migration](migrations.migration.md), `method`: up \\\| down): Promise<void\\> +▸ run(`migration`: [Migration](migrations.migration.md), `method`: up \\\| down): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `migration` \| [Migration](migrations.migration.md) \| `method` \| up \\\| down \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/MigrationRunner.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L15) +Defined in: [packages/migrations/src/MigrationRunner.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L15) ___ @@ -116,12 +113,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `trx` \| any \| Returns: void -Defined in: [packages/migrations/src/MigrationRunner.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L30) +Defined in: [packages/migrations/src/MigrationRunner.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L30) ___ @@ -131,4 +128,4 @@ ___ Returns: void -Defined in: [packages/migrations/src/MigrationRunner.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationRunner.ts#L34) +Defined in: [packages/migrations/src/MigrationRunner.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationRunner.ts#L34) diff --git a/migrations.migrationstorage.md b/migrations.migrationstorage.md index 4d76cea..d6a8b17 100644 --- a/migrations.migrationstorage.md +++ b/migrations.migrationstorage.md @@ -2,6 +2,7 @@ id: "migrations.migrationstorage" title: "Class: MigrationStorage" sidebar_label: "MigrationStorage" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [migrations](../modules/migrations.md).MigrationStorage -## Hierarchy - -* MigrationStorage - ## Constructors ### constructor @@ -22,13 +19,13 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `driver` \| [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> \| `options` \| [MigrationsOptions](../modules/core.md#migrationsoptions) \| Returns: [MigrationStorage](migrations.migrationstorage.md) -Defined in: [packages/migrations/src/MigrationStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L10) +Defined in: [packages/migrations/src/MigrationStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L10) ## Properties @@ -36,7 +33,7 @@ Defined in: [packages/migrations/src/MigrationStorage.ts:10](https://github.com/ • `Private` `Readonly` connection: [AbstractSqlConnection](knex.abstractsqlconnection.md) -Defined in: [packages/migrations/src/MigrationStorage.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L7) +Defined in: [packages/migrations/src/MigrationStorage.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L7) ___ @@ -50,15 +47,15 @@ ___ • `Private` `Readonly` helper: [SchemaHelper](knex.schemahelper.md) -Defined in: [packages/migrations/src/MigrationStorage.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L9) +Defined in: [packages/migrations/src/MigrationStorage.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L9) ___ ### knex -• `Private` `Readonly` knex: Knex<any, unknown[]\\> +• `Private` `Readonly` knex: Knex<any, unknown[]\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L8) +Defined in: [packages/migrations/src/MigrationStorage.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L8) ___ @@ -66,7 +63,7 @@ ___ • `Private` `Optional` masterTransaction: any -Defined in: [packages/migrations/src/MigrationStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L10) +Defined in: [packages/migrations/src/MigrationStorage.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L10) ___ @@ -78,21 +75,21 @@ ___ ### ensureTable -▸ ensureTable(): Promise<void\\> +▸ ensureTable(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L38) +Defined in: [packages/migrations/src/MigrationStorage.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L38) ___ ### executed -▸ executed(): Promise<string[]\\> +▸ executed(): Promise<string[]\\> -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L15) +Defined in: [packages/migrations/src/MigrationStorage.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L15) ___ @@ -102,23 +99,23 @@ ___ Returns: Promise<[MigrationRow](../modules/migrations.md#migrationrow)[]\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L28) +Defined in: [packages/migrations/src/MigrationStorage.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L28) ___ ### logMigration -▸ logMigration(`name`: string): Promise<void\\> +▸ logMigration(`name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L20) +Defined in: [packages/migrations/src/MigrationStorage.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L20) ___ @@ -129,28 +126,28 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `trx` \| any \| Returns: void -Defined in: [packages/migrations/src/MigrationStorage.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L52) +Defined in: [packages/migrations/src/MigrationStorage.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L52) ___ ### unlogMigration -▸ unlogMigration(`name`: string): Promise<void\\> +▸ unlogMigration(`name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/MigrationStorage.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L24) +Defined in: [packages/migrations/src/MigrationStorage.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L24) ___ @@ -160,4 +157,4 @@ ___ Returns: void -Defined in: [packages/migrations/src/MigrationStorage.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/MigrationStorage.ts#L56) +Defined in: [packages/migrations/src/MigrationStorage.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/MigrationStorage.ts#L56) diff --git a/migrations.migrator.md b/migrations.migrator.md index 9b150e8..f442173 100644 --- a/migrations.migrator.md +++ b/migrations.migrator.md @@ -2,6 +2,7 @@ id: "migrations.migrator" title: "Class: Migrator" sidebar_label: "Migrator" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [migrations](../modules/migrations.md).Migrator -## Hierarchy - -* Migrator - ## Constructors ### constructor @@ -22,12 +19,12 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `em` \| [EntityManager](knex.entitymanager.md)<[AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\>\\> \| Returns: [Migrator](migrations.migrator.md) -Defined in: [packages/migrations/src/Migrator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L20) +Defined in: [packages/migrations/src/Migrator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L20) ## Properties @@ -35,7 +32,7 @@ Defined in: [packages/migrations/src/Migrator.ts:20](https://github.com/mikro-or • `Private` `Readonly` config: [Configuration](core.configuration.md)<[IDatabaseDriver](../interfaces/core.idatabasedriver.md)<[Connection](core.connection.md)\\>\\> -Defined in: [packages/migrations/src/Migrator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L16) +Defined in: [packages/migrations/src/Migrator.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L16) ___ @@ -43,7 +40,7 @@ ___ • `Private` `Readonly` driver: [AbstractSqlDriver](knex.abstractsqldriver.md)<[AbstractSqlConnection](knex.abstractsqlconnection.md)\\> -Defined in: [packages/migrations/src/Migrator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L14) +Defined in: [packages/migrations/src/Migrator.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L14) ___ @@ -51,7 +48,7 @@ ___ • `Private` `Readonly` generator: [MigrationGenerator](migrations.migrationgenerator.md) -Defined in: [packages/migrations/src/Migrator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L19) +Defined in: [packages/migrations/src/Migrator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L19) ___ @@ -59,7 +56,7 @@ ___ • `Private` `Readonly` options: [MigrationsOptions](../modules/core.md#migrationsoptions) -Defined in: [packages/migrations/src/Migrator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L17) +Defined in: [packages/migrations/src/Migrator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L17) ___ @@ -67,7 +64,7 @@ ___ • `Private` `Readonly` runner: [MigrationRunner](migrations.migrationrunner.md) -Defined in: [packages/migrations/src/Migrator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L18) +Defined in: [packages/migrations/src/Migrator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L18) ___ @@ -75,7 +72,7 @@ ___ • `Private` `Readonly` schemaGenerator: [SchemaGenerator](knex.schemagenerator.md) -Defined in: [packages/migrations/src/Migrator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L15) +Defined in: [packages/migrations/src/Migrator.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L15) ___ @@ -83,7 +80,7 @@ ___ • `Private` `Readonly` storage: [MigrationStorage](migrations.migrationstorage.md) -Defined in: [packages/migrations/src/Migrator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L20) +Defined in: [packages/migrations/src/Migrator.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L20) ___ @@ -91,7 +88,7 @@ ___ • `Private` `Readonly` umzug: Umzug -Defined in: [packages/migrations/src/Migrator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L13) +Defined in: [packages/migrations/src/Migrator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L13) ## Methods @@ -102,12 +99,12 @@ Defined in: [packages/migrations/src/Migrator.ts:13](https://github.com/mikro-or #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path?` \| string \| Returns: Promise<[MigrationResult](../modules/migrations.md#migrationresult)\\> -Defined in: [packages/migrations/src/Migrator.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L62) +Defined in: [packages/migrations/src/Migrator.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L62) ___ @@ -118,14 +115,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `path?` \| string \| - \| `blank` \| boolean \| false \| `initial` \| boolean \| false \| Returns: Promise<[MigrationResult](../modules/migrations.md#migrationresult)\\> -Defined in: [packages/migrations/src/Migrator.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L41) +Defined in: [packages/migrations/src/Migrator.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L41) ___ @@ -136,22 +133,22 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| string \\\| string[] \\\| [MigrateOptions](../modules/migrations.md#migrateoptions) \| Returns: Promise<[UmzugMigration](../modules/migrations.md#umzugmigration)[]\\> -Defined in: [packages/migrations/src/Migrator.ts:139](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L139) +Defined in: [packages/migrations/src/Migrator.ts:139](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L139) ___ ### ensureMigrationsDirExists -▸ `Private`ensureMigrationsDirExists(): Promise<void\\> +▸ `Private`ensureMigrationsDirExists(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/migrations/src/Migrator.ts:239](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L239) +Defined in: [packages/migrations/src/Migrator.ts:239](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L239) ___ @@ -161,7 +158,7 @@ ___ Returns: Promise<[MigrationRow](../modules/migrations.md#migrationrow)[]\\> -Defined in: [packages/migrations/src/Migrator.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L123) +Defined in: [packages/migrations/src/Migrator.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L123) ___ @@ -171,24 +168,24 @@ ___ Returns: Promise<[UmzugMigration](../modules/migrations.md#umzugmigration)[]\\> -Defined in: [packages/migrations/src/Migrator.ts:129](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L129) +Defined in: [packages/migrations/src/Migrator.ts:129](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L129) ___ ### getSchemaDiff -▸ `Private`getSchemaDiff(`blank`: boolean, `initial`: boolean): Promise<string[]\\> +▸ `Private`getSchemaDiff(`blank`: boolean, `initial`: boolean): Promise<string[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `blank` \| boolean \| `initial` \| boolean \| -Returns: Promise<string[]\\> +Returns: Promise<string[]\\> -Defined in: [packages/migrations/src/Migrator.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L165) +Defined in: [packages/migrations/src/Migrator.ts:165](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L165) ___ @@ -198,7 +195,7 @@ ___ Returns: [MigrationStorage](migrations.migrationstorage.md) -Defined in: [packages/migrations/src/Migrator.ts:143](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L143) +Defined in: [packages/migrations/src/Migrator.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L143) ___ @@ -209,19 +206,19 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `MigrationClass` \| [Constructor](../modules/core.md#constructor)<[Migration](migrations.migration.md)\\> \| `name?` \| string \| Returns: object Name \| Type \| ------- \| ------ \| -`down` \| () => Promise<void\\> \| +:------ \| :------ \| +`down` \| () => Promise<void\\> \| `name` \| undefined \\\| string \| -`up` \| () => Promise<void\\> \| +`up` \| () => Promise<void\\> \| -Defined in: [packages/migrations/src/Migrator.ts:155](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L155) +Defined in: [packages/migrations/src/Migrator.ts:155](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L155) ___ @@ -232,18 +229,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| -`T` \| string \\\| string[] \\\| { `from?`: undefined \\\| string ; `migrations?`: undefined \\\| string[] ; `to?`: undefined \\\| string ; `transaction?`: any } \| +:------ \| :------ \| +`T` \| string \\\| string[] \\\| { `from?`: string ; `migrations?`: string[] ; `to?`: string ; `transaction?`: any } \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| T \| Returns: T -Defined in: [packages/migrations/src/Migrator.ts:189](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L189) +Defined in: [packages/migrations/src/Migrator.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L189) ___ @@ -254,18 +251,18 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `file` \| string \| Returns: object Name \| Type \| ------- \| ------ \| -`down` \| () => Promise<void\\> \| +:------ \| :------ \| +`down` \| () => Promise<void\\> \| `name` \| undefined \\\| string \| -`up` \| () => Promise<void\\> \| +`up` \| () => Promise<void\\> \| -Defined in: [packages/migrations/src/Migrator.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L147) +Defined in: [packages/migrations/src/Migrator.ts:147](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L147) ___ @@ -276,14 +273,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `trx` \| any \| `method` \| up \\\| down \| `options` \| undefined \\\| string \\\| string[] \\\| [MigrateOptions](../modules/migrations.md#migrateoptions) \| Returns: Promise<Migration[]\\> -Defined in: [packages/migrations/src/Migrator.ts:229](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L229) +Defined in: [packages/migrations/src/Migrator.ts:229](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L229) ___ @@ -294,13 +291,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `method` \| up \\\| down \| `options?` \| string \\\| string[] \\\| [MigrateOptions](../modules/migrations.md#migrateoptions) \| Returns: Promise<Migration[]\\> -Defined in: [packages/migrations/src/Migrator.ts:214](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L214) +Defined in: [packages/migrations/src/Migrator.ts:214](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L214) ___ @@ -311,18 +308,18 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| string \\\| string[] \\\| [MigrateOptions](../modules/migrations.md#migrateoptions) \| Returns: Promise<[UmzugMigration](../modules/migrations.md#umzugmigration)[]\\> -Defined in: [packages/migrations/src/Migrator.ts:135](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L135) +Defined in: [packages/migrations/src/Migrator.ts:135](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L135) ___ ### validateInitialMigration -▸ `Private`validateInitialMigration(): Promise<boolean\\> +▸ `Private`validateInitialMigration(): Promise<boolean\\> Initial migration can be created only if: 1. no previous migrations were generated or executed @@ -331,6 +328,6 @@ Initial migration can be created only if: If existing schema contains all of the tables already, we return true, based on that we mark the migration as already executed. If only some of the tables are present, exception is thrown. -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: [packages/migrations/src/Migrator.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/migrations/src/Migrator.ts#L87) +Defined in: [packages/migrations/src/Migrator.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/migrations/src/Migrator.ts#L87) diff --git a/reflection.tsmorphmetadataprovider.md b/reflection.tsmorphmetadataprovider.md index b353616..cb6fafb 100644 --- a/reflection.tsmorphmetadataprovider.md +++ b/reflection.tsmorphmetadataprovider.md @@ -2,6 +2,7 @@ id: "reflection.tsmorphmetadataprovider" title: "Class: TsMorphMetadataProvider" sidebar_label: "TsMorphMetadataProvider" +custom_edit_url: null hide_title: true --- @@ -24,14 +25,14 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `config` \| [IConfiguration](../interfaces/core.iconfiguration.md) \| Returns: [TsMorphMetadataProvider](reflection.tsmorphmetadataprovider.md) Inherited from: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L9) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L9) ## Properties @@ -47,7 +48,7 @@ ___ • `Private` `Readonly` project: Project -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L6) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L6) ___ @@ -55,175 +56,177 @@ ___ • `Private` sources: SourceFile[] -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L12) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L12) ## Methods ### extractType -▸ `Private`extractType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string +▸ `Private`extractType(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): string #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| Returns: string -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L49) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L62) ___ ### getExistingSourceFile -▸ getExistingSourceFile(`path`: string, `ext?`: string, `validate?`: boolean): Promise<SourceFile\\> +▸ getExistingSourceFile(`path`: string, `ext?`: string, `validate?`: boolean): Promise<SourceFile\\> #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `path` \| string \| - \| `ext?` \| string \| - \| `validate` \| boolean \| true \| -Returns: Promise<SourceFile\\> +Returns: Promise<SourceFile\\> -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L26) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L26) ___ ### getSourceFile -▸ `Private`getSourceFile(`tsPath`: string, `validate`: boolean): Promise<undefined \\\| SourceFile\\> +▸ `Private`getSourceFile(`tsPath`: string, `validate`: boolean): Promise<undefined \\\| SourceFile\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tsPath` \| string \| `validate` \| boolean \| -Returns: Promise<undefined \\\| SourceFile\\> +Returns: Promise<undefined \\\| SourceFile\\> -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L100) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:137](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L137) ___ ### initProperties -▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): Promise<void\\> +▸ `Protected`initProperties(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L36) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L49) ___ ### initPropertyType -▸ `Private`initPropertyType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): Promise<void\\> +▸ `Private`initPropertyType(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L61) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:74](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L74) ___ ### initSourceFiles -▸ `Private`initSourceFiles(): Promise<void\\> +▸ `Private`initSourceFiles(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L134) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:171](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L171) ___ ### loadEntityMetadata -▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> +▸ loadEntityMetadata(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `name`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| `name` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L18) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L18) ___ ### loadFromCache -▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void +▸ loadFromCache(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `cache`: [EntityMetadata](core.entitymetadata.md)<any\\>): void + +Re-hydrates missing attributes like `customType` (functions/instances are lost when caching to JSON) #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`cache` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| Returns: void -Inherited from: [MetadataProvider](core.metadataprovider.md) +Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/core/src/metadata/MetadataProvider.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L15) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L39) ___ ### processWrapper -▸ `Private`processWrapper(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `wrapper`: string): void +▸ `Private`processWrapper(`prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>, `wrapper`: string): void #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| `wrapper` \| string \| Returns: void -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:114](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L114) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:151](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L151) ___ ### readTypeFromSource -▸ `Private`readTypeFromSource(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): Promise<{ `optional?`: undefined \\\| boolean ; `type`: string }\\> +▸ `Private`readTypeFromSource(`meta`: [EntityMetadata](core.entitymetadata.md)<any\\>, `prop`: [EntityProperty](../interfaces/core.entityproperty.md)<any\\>): Promise<{ `optional?`: boolean ; `type`: string }\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| -`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`meta` \| [EntityMetadata](core.entitymetadata.md)<any\\> \| +`prop` \| [EntityProperty](../interfaces/core.entityproperty.md)<any\\> \| -Returns: Promise<{ `optional?`: undefined \\\| boolean ; `type`: string }\\> +Returns: Promise<{ `optional?`: boolean ; `type`: string }\\> -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:74](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L74) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L87) ___ @@ -235,4 +238,4 @@ ___ Overrides: [MetadataProvider](core.metadataprovider.md) -Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/reflection/src/TsMorphMetadataProvider.ts#L14) +Defined in: [packages/reflection/src/TsMorphMetadataProvider.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/reflection/src/TsMorphMetadataProvider.ts#L14) diff --git a/core.cascade.md b/core.cascade.md index 2ba4c02..a0b0de3 100644 --- a/core.cascade.md +++ b/core.cascade.md @@ -2,6 +2,7 @@ id: "core.cascade" title: "Enumeration: Cascade" sidebar_label: "Cascade" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • ALL: = "all" -Defined in: [packages/core/src/enums.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L81) +Defined in: [packages/core/src/enums.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L81) ___ @@ -23,7 +24,7 @@ ___ • MERGE: = "merge" -Defined in: [packages/core/src/enums.ts:79](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L79) +Defined in: [packages/core/src/enums.ts:79](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L79) ___ @@ -31,7 +32,7 @@ ___ • PERSIST: = "persist" -Defined in: [packages/core/src/enums.ts:78](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L78) +Defined in: [packages/core/src/enums.ts:78](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L78) ___ @@ -39,4 +40,4 @@ ___ • REMOVE: = "remove" -Defined in: [packages/core/src/enums.ts:80](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L80) +Defined in: [packages/core/src/enums.ts:80](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L80) diff --git a/core.changesettype.md b/core.changesettype.md index 44b0621..d0c0abe 100644 --- a/core.changesettype.md +++ b/core.changesettype.md @@ -2,6 +2,7 @@ id: "core.changesettype" title: "Enumeration: ChangeSetType" sidebar_label: "ChangeSetType" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • CREATE: = "create" -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L28) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L28) ___ @@ -23,7 +24,7 @@ ___ • DELETE: = "delete" -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L30) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L30) ___ @@ -31,4 +32,4 @@ ___ • UPDATE: = "update" -Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/ChangeSet.ts#L29) +Defined in: [packages/core/src/unit-of-work/ChangeSet.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/ChangeSet.ts#L29) diff --git a/core.eventtype.md b/core.eventtype.md index a7e1817..6aa7a4b 100644 --- a/core.eventtype.md +++ b/core.eventtype.md @@ -2,6 +2,7 @@ id: "core.eventtype" title: "Enumeration: EventType" sidebar_label: "EventType" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • afterCreate: = "afterCreate" -Defined in: [packages/core/src/enums.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L99) +Defined in: [packages/core/src/enums.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L99) ___ @@ -23,7 +24,7 @@ ___ • afterDelete: = "afterDelete" -Defined in: [packages/core/src/enums.ts:103](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L103) +Defined in: [packages/core/src/enums.ts:103](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L103) ___ @@ -31,7 +32,7 @@ ___ • afterFlush: = "afterFlush" -Defined in: [packages/core/src/enums.ts:106](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L106) +Defined in: [packages/core/src/enums.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L106) ___ @@ -39,7 +40,7 @@ ___ • afterTransactionCommit: = "afterTransactionCommit" -Defined in: [packages/core/src/enums.ts:110](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L110) +Defined in: [packages/core/src/enums.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L110) ___ @@ -47,7 +48,7 @@ ___ • afterTransactionRollback: = "afterTransactionRollback" -Defined in: [packages/core/src/enums.ts:112](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L112) +Defined in: [packages/core/src/enums.ts:112](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L112) ___ @@ -55,7 +56,7 @@ ___ • afterTransactionStart: = "afterTransactionStart" -Defined in: [packages/core/src/enums.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L108) +Defined in: [packages/core/src/enums.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L108) ___ @@ -63,7 +64,7 @@ ___ • afterUpdate: = "afterUpdate" -Defined in: [packages/core/src/enums.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L101) +Defined in: [packages/core/src/enums.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L101) ___ @@ -71,7 +72,7 @@ ___ • beforeCreate: = "beforeCreate" -Defined in: [packages/core/src/enums.ts:98](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L98) +Defined in: [packages/core/src/enums.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L98) ___ @@ -79,7 +80,7 @@ ___ • beforeDelete: = "beforeDelete" -Defined in: [packages/core/src/enums.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L102) +Defined in: [packages/core/src/enums.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L102) ___ @@ -87,7 +88,7 @@ ___ • beforeFlush: = "beforeFlush" -Defined in: [packages/core/src/enums.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L104) +Defined in: [packages/core/src/enums.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L104) ___ @@ -95,7 +96,7 @@ ___ • beforeTransactionCommit: = "beforeTransactionCommit" -Defined in: [packages/core/src/enums.ts:109](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L109) +Defined in: [packages/core/src/enums.ts:109](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L109) ___ @@ -103,7 +104,7 @@ ___ • beforeTransactionRollback: = "beforeTransactionRollback" -Defined in: [packages/core/src/enums.ts:111](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L111) +Defined in: [packages/core/src/enums.ts:111](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L111) ___ @@ -111,7 +112,7 @@ ___ • beforeTransactionStart: = "beforeTransactionStart" -Defined in: [packages/core/src/enums.ts:107](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L107) +Defined in: [packages/core/src/enums.ts:107](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L107) ___ @@ -119,7 +120,7 @@ ___ • beforeUpdate: = "beforeUpdate" -Defined in: [packages/core/src/enums.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L100) +Defined in: [packages/core/src/enums.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L100) ___ @@ -127,7 +128,7 @@ ___ • onFlush: = "onFlush" -Defined in: [packages/core/src/enums.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L105) +Defined in: [packages/core/src/enums.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L105) ___ @@ -135,4 +136,4 @@ ___ • onInit: = "onInit" -Defined in: [packages/core/src/enums.ts:97](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L97) +Defined in: [packages/core/src/enums.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L97) diff --git a/core.groupoperator.md b/core.groupoperator.md index db4381b..4a8efa4 100644 --- a/core.groupoperator.md +++ b/core.groupoperator.md @@ -2,6 +2,7 @@ id: "core.groupoperator" title: "Enumeration: GroupOperator" sidebar_label: "GroupOperator" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • $and: = "and" -Defined in: [packages/core/src/enums.ts:2](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L2) +Defined in: [packages/core/src/enums.ts:2](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L2) ___ @@ -23,4 +24,4 @@ ___ • $or: = "or" -Defined in: [packages/core/src/enums.ts:3](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L3) +Defined in: [packages/core/src/enums.ts:3](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L3) diff --git a/core.loadstrategy.md b/core.loadstrategy.md index e9fc132..9c42b3e 100644 --- a/core.loadstrategy.md +++ b/core.loadstrategy.md @@ -2,6 +2,7 @@ id: "core.loadstrategy" title: "Enumeration: LoadStrategy" sidebar_label: "LoadStrategy" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • JOINED: = "joined" -Defined in: [packages/core/src/enums.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L86) +Defined in: [packages/core/src/enums.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L86) ___ @@ -23,4 +24,4 @@ ___ • SELECT\\_IN: = "select-in" -Defined in: [packages/core/src/enums.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L85) +Defined in: [packages/core/src/enums.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L85) diff --git a/core.lockmode.md b/core.lockmode.md index 66894df..5c54267 100644 --- a/core.lockmode.md +++ b/core.lockmode.md @@ -2,6 +2,7 @@ id: "core.lockmode" title: "Enumeration: LockMode" sidebar_label: "LockMode" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • NONE: = 0 -Defined in: [packages/core/src/enums.ts:90](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L90) +Defined in: [packages/core/src/enums.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L90) ___ @@ -23,7 +24,7 @@ ___ • OPTIMISTIC: = 1 -Defined in: [packages/core/src/enums.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L91) +Defined in: [packages/core/src/enums.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L91) ___ @@ -31,7 +32,7 @@ ___ • PESSIMISTIC\\_READ: = 2 -Defined in: [packages/core/src/enums.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L92) +Defined in: [packages/core/src/enums.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L92) ___ @@ -39,4 +40,4 @@ ___ • PESSIMISTIC\\_WRITE: = 3 -Defined in: [packages/core/src/enums.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L93) +Defined in: [packages/core/src/enums.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L93) diff --git a/core.nodestate.md b/core.nodestate.md index 6356904..a3cfdf5 100644 --- a/core.nodestate.md +++ b/core.nodestate.md @@ -2,6 +2,7 @@ id: "core.nodestate" title: "Enumeration: NodeState" sidebar_label: "NodeState" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • IN\\_PROGRESS: = 1 -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L6) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L6) ___ @@ -23,7 +24,7 @@ ___ • NOT\\_VISITED: = 0 -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L5) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L5) ___ @@ -31,4 +32,4 @@ ___ • VISITED: = 2 -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L7) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L7) diff --git a/core.queryflag.md b/core.queryflag.md index 3e2c43c..e3c2541 100644 --- a/core.queryflag.md +++ b/core.queryflag.md @@ -2,6 +2,7 @@ id: "core.queryflag" title: "Enumeration: QueryFlag" sidebar_label: "QueryFlag" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • CONVERT\\_CUSTOM\\_TYPES: = "CONVERT\\_CUSTOM\\_TYPES" -Defined in: [packages/core/src/enums.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L62) +Defined in: [packages/core/src/enums.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L62) ___ @@ -23,7 +24,7 @@ ___ • DELETE\\_SUB\\_QUERY: = "DELETE\\_SUB\\_QUERY" -Defined in: [packages/core/src/enums.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L61) +Defined in: [packages/core/src/enums.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L61) ___ @@ -31,7 +32,7 @@ ___ • DISTINCT: = "DISTINCT" -Defined in: [packages/core/src/enums.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L58) +Defined in: [packages/core/src/enums.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L58) ___ @@ -39,7 +40,7 @@ ___ • INCLUDE\\_LAZY\\_FORMULAS: = "INCLUDE\\_LAZY\\_FORMULAS" -Defined in: [packages/core/src/enums.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L63) +Defined in: [packages/core/src/enums.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L63) ___ @@ -47,7 +48,7 @@ ___ • PAGINATE: = "PAGINATE" -Defined in: [packages/core/src/enums.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L59) +Defined in: [packages/core/src/enums.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L59) ___ @@ -55,4 +56,4 @@ ___ • UPDATE\\_SUB\\_QUERY: = "UPDATE\\_SUB\\_QUERY" -Defined in: [packages/core/src/enums.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L60) +Defined in: [packages/core/src/enums.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L60) diff --git a/core.queryoperator.md b/core.queryoperator.md index 8220427..cee1ece 100644 --- a/core.queryoperator.md +++ b/core.queryoperator.md @@ -2,6 +2,7 @@ id: "core.queryoperator" title: "Enumeration: QueryOperator" sidebar_label: "QueryOperator" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • $contained: = "<@" -Defined in: [packages/core/src/enums.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L21) +Defined in: [packages/core/src/enums.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L21) ___ @@ -23,7 +24,7 @@ ___ • $contains: = "@\\>" -Defined in: [packages/core/src/enums.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L20) +Defined in: [packages/core/src/enums.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L20) ___ @@ -31,7 +32,7 @@ ___ • $eq: = "=" -Defined in: [packages/core/src/enums.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L7) +Defined in: [packages/core/src/enums.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L7) ___ @@ -39,7 +40,7 @@ ___ • $gt: = "\\>" -Defined in: [packages/core/src/enums.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L10) +Defined in: [packages/core/src/enums.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L10) ___ @@ -47,7 +48,7 @@ ___ • $gte: = "\\>=" -Defined in: [packages/core/src/enums.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L11) +Defined in: [packages/core/src/enums.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L11) ___ @@ -55,7 +56,7 @@ ___ • $ilike: = "ilike" -Defined in: [packages/core/src/enums.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L18) +Defined in: [packages/core/src/enums.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L18) ___ @@ -63,7 +64,7 @@ ___ • $in: = "in" -Defined in: [packages/core/src/enums.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L8) +Defined in: [packages/core/src/enums.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L8) ___ @@ -71,7 +72,7 @@ ___ • $like: = "like" -Defined in: [packages/core/src/enums.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L16) +Defined in: [packages/core/src/enums.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L16) ___ @@ -79,7 +80,7 @@ ___ • $lt: = "<" -Defined in: [packages/core/src/enums.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L12) +Defined in: [packages/core/src/enums.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L12) ___ @@ -87,7 +88,7 @@ ___ • $lte: = "<=" -Defined in: [packages/core/src/enums.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L13) +Defined in: [packages/core/src/enums.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L13) ___ @@ -95,7 +96,7 @@ ___ • $ne: = "!=" -Defined in: [packages/core/src/enums.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L14) +Defined in: [packages/core/src/enums.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L14) ___ @@ -103,7 +104,7 @@ ___ • $nin: = "not in" -Defined in: [packages/core/src/enums.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L9) +Defined in: [packages/core/src/enums.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L9) ___ @@ -111,7 +112,7 @@ ___ • $not: = "not" -Defined in: [packages/core/src/enums.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L15) +Defined in: [packages/core/src/enums.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L15) ___ @@ -119,7 +120,7 @@ ___ • $overlap: = "&&" -Defined in: [packages/core/src/enums.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L19) +Defined in: [packages/core/src/enums.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L19) ___ @@ -127,4 +128,4 @@ ___ • $re: = "regexp" -Defined in: [packages/core/src/enums.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L17) +Defined in: [packages/core/src/enums.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L17) diff --git a/core.queryorder.md b/core.queryorder.md index 232778f..549d7b5 100644 --- a/core.queryorder.md +++ b/core.queryorder.md @@ -2,6 +2,7 @@ id: "core.queryorder" title: "Enumeration: QueryOrder" sidebar_label: "QueryOrder" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • ASC: = "ASC" -Defined in: [packages/core/src/enums.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L27) +Defined in: [packages/core/src/enums.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L27) ___ @@ -23,7 +24,7 @@ ___ • ASC\\_NULLS\\_FIRST: = "ASC NULLS FIRST" -Defined in: [packages/core/src/enums.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L29) +Defined in: [packages/core/src/enums.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L29) ___ @@ -31,7 +32,7 @@ ___ • ASC\\_NULLS\\_LAST: = "ASC NULLS LAST" -Defined in: [packages/core/src/enums.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L28) +Defined in: [packages/core/src/enums.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L28) ___ @@ -39,7 +40,7 @@ ___ • DESC: = "DESC" -Defined in: [packages/core/src/enums.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L30) +Defined in: [packages/core/src/enums.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L30) ___ @@ -47,7 +48,7 @@ ___ • DESC\\_NULLS\\_FIRST: = "DESC NULLS FIRST" -Defined in: [packages/core/src/enums.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L32) +Defined in: [packages/core/src/enums.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L32) ___ @@ -55,7 +56,7 @@ ___ • DESC\\_NULLS\\_LAST: = "DESC NULLS LAST" -Defined in: [packages/core/src/enums.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L31) +Defined in: [packages/core/src/enums.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L31) ___ @@ -63,7 +64,7 @@ ___ • asc: = "asc" -Defined in: [packages/core/src/enums.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L33) +Defined in: [packages/core/src/enums.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L33) ___ @@ -71,7 +72,7 @@ ___ • asc\\_nulls\\_first: = "asc nulls first" -Defined in: [packages/core/src/enums.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L35) +Defined in: [packages/core/src/enums.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L35) ___ @@ -79,7 +80,7 @@ ___ • asc\\_nulls\\_last: = "asc nulls last" -Defined in: [packages/core/src/enums.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L34) +Defined in: [packages/core/src/enums.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L34) ___ @@ -87,7 +88,7 @@ ___ • desc: = "desc" -Defined in: [packages/core/src/enums.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L36) +Defined in: [packages/core/src/enums.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L36) ___ @@ -95,7 +96,7 @@ ___ • desc\\_nulls\\_first: = "desc nulls first" -Defined in: [packages/core/src/enums.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L38) +Defined in: [packages/core/src/enums.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L38) ___ @@ -103,4 +104,4 @@ ___ • desc\\_nulls\\_last: = "desc nulls last" -Defined in: [packages/core/src/enums.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L37) +Defined in: [packages/core/src/enums.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L37) diff --git a/core.queryordernumeric.md b/core.queryordernumeric.md index 978869c..923327a 100644 --- a/core.queryordernumeric.md +++ b/core.queryordernumeric.md @@ -2,6 +2,7 @@ id: "core.queryordernumeric" title: "Enumeration: QueryOrderNumeric" sidebar_label: "QueryOrderNumeric" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • ASC: = 1 -Defined in: [packages/core/src/enums.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L42) +Defined in: [packages/core/src/enums.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L42) ___ @@ -23,4 +24,4 @@ ___ • DESC: = -1 -Defined in: [packages/core/src/enums.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L43) +Defined in: [packages/core/src/enums.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L43) diff --git a/core.referencetype.md b/core.referencetype.md index 23e65c6..17d6d02 100644 --- a/core.referencetype.md +++ b/core.referencetype.md @@ -2,6 +2,7 @@ id: "core.referencetype" title: "Enumeration: ReferenceType" sidebar_label: "ReferenceType" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • EMBEDDED: = "embedded" -Defined in: [packages/core/src/enums.ts:74](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L74) +Defined in: [packages/core/src/enums.ts:74](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L74) ___ @@ -23,7 +24,7 @@ ___ • MANY\\_TO\\_MANY: = "m:n" -Defined in: [packages/core/src/enums.ts:73](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L73) +Defined in: [packages/core/src/enums.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L73) ___ @@ -31,7 +32,7 @@ ___ • MANY\\_TO\\_ONE: = "m:1" -Defined in: [packages/core/src/enums.ts:72](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L72) +Defined in: [packages/core/src/enums.ts:72](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L72) ___ @@ -39,7 +40,7 @@ ___ • ONE\\_TO\\_MANY: = "1:m" -Defined in: [packages/core/src/enums.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L71) +Defined in: [packages/core/src/enums.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L71) ___ @@ -47,7 +48,7 @@ ___ • ONE\\_TO\\_ONE: = "1:1" -Defined in: [packages/core/src/enums.ts:70](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L70) +Defined in: [packages/core/src/enums.ts:70](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L70) ___ @@ -55,4 +56,4 @@ ___ • SCALAR: = "scalar" -Defined in: [packages/core/src/enums.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L69) +Defined in: [packages/core/src/enums.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L69) diff --git a/knex.querytype.md b/knex.querytype.md index 759f8f0..a462369 100644 --- a/knex.querytype.md +++ b/knex.querytype.md @@ -2,6 +2,7 @@ id: "knex.querytype" title: "Enumeration: QueryType" sidebar_label: "QueryType" +custom_edit_url: null hide_title: true --- @@ -15,7 +16,7 @@ hide_title: true • COUNT: = "COUNT" -Defined in: [packages/knex/src/query/enums.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L4) +Defined in: [packages/knex/src/query/enums.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L4) ___ @@ -23,7 +24,7 @@ ___ • DELETE: = "DELETE" -Defined in: [packages/knex/src/query/enums.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L7) +Defined in: [packages/knex/src/query/enums.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L7) ___ @@ -31,7 +32,7 @@ ___ • INSERT: = "INSERT" -Defined in: [packages/knex/src/query/enums.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L5) +Defined in: [packages/knex/src/query/enums.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L5) ___ @@ -39,7 +40,7 @@ ___ • SELECT: = "SELECT" -Defined in: [packages/knex/src/query/enums.ts:3](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L3) +Defined in: [packages/knex/src/query/enums.ts:3](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L3) ___ @@ -47,7 +48,7 @@ ___ • TRUNCATE: = "TRUNCATE" -Defined in: [packages/knex/src/query/enums.ts:2](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L2) +Defined in: [packages/knex/src/query/enums.ts:2](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L2) ___ @@ -55,4 +56,4 @@ ___ • UPDATE: = "UPDATE" -Defined in: [packages/knex/src/query/enums.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/query/enums.ts#L6) +Defined in: [packages/knex/src/query/enums.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/query/enums.ts#L6) diff --git a/index.md b/index.md index 9a07823..e3cde82 100644 --- a/index.md +++ b/index.md @@ -0,0 +1,57 @@ +--- +layout: homepage +title: MikroORM v4 +hide_title: true +--- + +## Table of contents + +- Overview + - [Installation & Usage](installation.md) + - [Defining Entities](defining-entities.md) + - [Persisting, Cascading and Fetching Entities with `EntityManager`](entity-manager.md) + - [Using `EntityRepository` instead of `EntityManager`](repositories.md) +- Fundamentals + - [Identity Map and Request Context](identity-map.md) + - [Entity References and `Reference<T>` Wrapper](entity-references.md) + - [Using Entity Constructors](entity-constructors.md) + - [Modelling Relationships](relationships.md) + - [Collections](collections.md) + - [Unit of Work](unit-of-work.md) + - [Transactions](transactions.md) + - [Cascading persist and remove](cascading.md) + - [Filters](filters.md) + - [Deployment](deployment.md) +- Advanced Features + - [Smart Nested Populate](nested-populate.md) + - [Smart Query Conditions](query-conditions.md) + - [Using `QueryBuilder`](query-builder.md) + - [Serializing](serializing.md) + - [Updating Entity Values with `Entity.assign()`](entity-helper.md) + - [Property Validation](property-validation.md) + - [Lifecycle Hooks](lifecycle-hooks.md) + - [Loading Strategies](loading-strategies.md) + - [Naming Strategy](naming-strategy.md) + - [Metadata Providers](metadata-providers.md) + - [Metadata Cache](metadata-cache.md) + - [Debugging](debugging.md) + - [Schema Generator](schema-generator.md) + - [Entity Generator](entity-generator.md) + - [Migrations](migrations.md) + - [Read Replica Connections](read-connections.md) +- Usage with Different Drivers + - [Usage with SQL Drivers](usage-with-sql.md) + - [Usage with MongoDB](usage-with-mongo.md) +- Recipes + - [Usage with NestJS](usage-with-nestjs.md) + - [Usage with Vanilla JS](usage-with-js.md) + - [Creating Custom Driver](custom-driver.md) + - [Using Multiple Schemas](multiple-schemas.md) +- Example Integrations + - [Express + MongoDB + TypeScript](https://github.com/mikro-orm/mikro-orm-examples/tree/master/express-ts) + - [Nest + MySQL + TypeScript](https://github.com/mikro-orm/mikro-orm-examples/tree/master/nest) + - [RealWorld example app (Nest + MySQL)](https://github.com/mikro-orm/nestjs-realworld-example-app) + - [Express + MongoDB + JavaScript](https://github.com/mikro-orm/mikro-orm-examples/tree/master/express-js) + - [GraphQL + PostgreSQL + Typescript](https://github.com/driescroons/mikro-orm-graphql-example) + - [Inversify + PostgreSQL](https://github.com/PodaruDragos/inversify-example-app) + - [NextJS + MySQL](https://github.com/jonahallibone/mikro-orm-nextjs) diff --git a/core.cacheadapter.md b/core.cacheadapter.md index b5c5ace..ae93357 100644 --- a/core.cacheadapter.md +++ b/core.cacheadapter.md @@ -2,6 +2,7 @@ id: "core.cacheadapter" title: "Interface: CacheAdapter" sidebar_label: "CacheAdapter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).CacheAdapter -## Hierarchy - -* CacheAdapter - ## Implemented by * [FileCacheAdapter](../classes/core.filecacheadapter.md) @@ -23,49 +20,61 @@ hide_title: true ### clear -▸ clear(): Promise<void\\> +▸ clear(): Promise<void\\> Clears all items stored in the cache. -Returns: Promise<void\\> +Returns: Promise<void\\> + +Defined in: [packages/core/src/cache/CacheAdapter.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/CacheAdapter.ts#L16) + +___ + +### close + +▸ `Optional`close(): Promise<void\\> + +Called inside `MikroORM.close()` Allows graceful shutdowns (e.g. for redis). + +Returns: Promise<void\\> -Defined in: [packages/core/src/cache/CacheAdapter.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/CacheAdapter.ts#L16) +Defined in: [packages/core/src/cache/CacheAdapter.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/CacheAdapter.ts#L21) ___ ### get -▸ get(`name`: string): Promise<any\\> +▸ get(`name`: string): Promise<any\\> Gets the items under `name` key from the cache. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Defined in: [packages/core/src/cache/CacheAdapter.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/CacheAdapter.ts#L6) +Defined in: [packages/core/src/cache/CacheAdapter.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/CacheAdapter.ts#L6) ___ ### set -▸ set(`name`: string, `data`: any, `origin`: string, `expiration?`: number): Promise<void\\> +▸ set(`name`: string, `data`: any, `origin`: string, `expiration?`: number): Promise<void\\> Sets the item to the cache. `origin` is used for cache invalidation and should reflect the change in data. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `name` \| string \| `data` \| any \| `origin` \| string \| `expiration?` \| number \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/cache/CacheAdapter.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/cache/CacheAdapter.ts#L11) +Defined in: [packages/core/src/cache/CacheAdapter.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/cache/CacheAdapter.ts#L11) diff --git a/core.connectionconfig.md b/core.connectionconfig.md index df1211b..18f2665 100644 --- a/core.connectionconfig.md +++ b/core.connectionconfig.md @@ -2,6 +2,7 @@ id: "core.connectionconfig" title: "Interface: ConnectionConfig" sidebar_label: "ConnectionConfig" +custom_edit_url: null hide_title: true --- @@ -9,46 +10,42 @@ hide_title: true [core](../modules/core.md).ConnectionConfig -## Hierarchy - -* ConnectionConfig - ## Properties ### database -• `Optional` database: undefined \\\| string +• `Optional` database: string -Defined in: [packages/core/src/connections/Connection.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L138) +Defined in: [packages/core/src/connections/Connection.ts:138](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L138) ___ ### host -• `Optional` host: undefined \\\| string +• `Optional` host: string -Defined in: [packages/core/src/connections/Connection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L134) +Defined in: [packages/core/src/connections/Connection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L134) ___ ### password -• `Optional` password: undefined \\\| string +• `Optional` password: string -Defined in: [packages/core/src/connections/Connection.ts:137](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L137) +Defined in: [packages/core/src/connections/Connection.ts:137](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L137) ___ ### port -• `Optional` port: undefined \\\| number +• `Optional` port: number -Defined in: [packages/core/src/connections/Connection.ts:135](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L135) +Defined in: [packages/core/src/connections/Connection.ts:135](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L135) ___ ### user -• `Optional` user: undefined \\\| string +• `Optional` user: string -Defined in: [packages/core/src/connections/Connection.ts:136](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L136) +Defined in: [packages/core/src/connections/Connection.ts:136](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L136) diff --git a/core.deleteoptions.md b/core.deleteoptions.md index e314cf4..4a40e34 100644 --- a/core.deleteoptions.md +++ b/core.deleteoptions.md @@ -2,6 +2,7 @@ id: "core.deleteoptions" title: "Interface: DeleteOptions<T>" sidebar_label: "DeleteOptions" +custom_edit_url: null hide_title: true --- @@ -12,17 +13,13 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| -## Hierarchy - -* DeleteOptions - ## Properties ### filters -• `Optional` filters: undefined \\\| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L122) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:122](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L122) diff --git a/core.edge.md b/core.edge.md index b1b3a69..d87f6ab 100644 --- a/core.edge.md +++ b/core.edge.md @@ -2,6 +2,7 @@ id: "core.edge" title: "Interface: Edge" sidebar_label: "Edge" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [core](../modules/core.md).Edge -## Hierarchy - -* Edge - ## Properties ### from • from: string -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L17) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L17) ___ @@ -27,7 +24,7 @@ ___ • to: string -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L18) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L18) ___ @@ -35,4 +32,4 @@ ___ • weight: number -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L19) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L19) diff --git a/core.eventargs.md b/core.eventargs.md index 29a920b..ecf5b4f 100644 --- a/core.eventargs.md +++ b/core.eventargs.md @@ -2,6 +2,7 @@ id: "core.eventargs" title: "Interface: EventArgs<T>" sidebar_label: "EventArgs" +custom_edit_url: null hide_title: true --- @@ -12,20 +13,16 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| -## Hierarchy - -* EventArgs - ## Properties ### changeSet -• `Optional` changeSet: undefined \\\| [ChangeSet](../classes/core.changeset.md)<T\\> +• `Optional` changeSet: [ChangeSet](../classes/core.changeset.md)<T\\> -Defined in: [packages/core/src/events/EventSubscriber.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L9) +Defined in: [packages/core/src/events/EventSubscriber.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L9) ___ @@ -33,7 +30,7 @@ ___ • em: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> -Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L8) +Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L8) ___ @@ -41,4 +38,4 @@ ___ • entity: T -Defined in: [packages/core/src/events/EventSubscriber.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L7) +Defined in: [packages/core/src/events/EventSubscriber.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L7) diff --git a/core.factoryoptions.md b/core.factoryoptions.md index bc2d192..8202508 100644 --- a/core.factoryoptions.md +++ b/core.factoryoptions.md @@ -2,6 +2,7 @@ id: "core.factoryoptions" title: "Interface: FactoryOptions" sidebar_label: "FactoryOptions" +custom_edit_url: null hide_title: true --- @@ -9,46 +10,42 @@ hide_title: true [core](../modules/core.md).FactoryOptions -## Hierarchy - -* FactoryOptions - ## Properties ### convertCustomTypes -• `Optional` convertCustomTypes: undefined \\\| boolean +• `Optional` convertCustomTypes: boolean -Defined in: [packages/core/src/entity/EntityFactory.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L12) +Defined in: [packages/core/src/entity/EntityFactory.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L12) ___ ### initialized -• `Optional` initialized: undefined \\\| boolean +• `Optional` initialized: boolean -Defined in: [packages/core/src/entity/EntityFactory.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L8) +Defined in: [packages/core/src/entity/EntityFactory.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L8) ___ ### merge -• `Optional` merge: undefined \\\| boolean +• `Optional` merge: boolean -Defined in: [packages/core/src/entity/EntityFactory.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L10) +Defined in: [packages/core/src/entity/EntityFactory.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L10) ___ ### newEntity -• `Optional` newEntity: undefined \\\| boolean +• `Optional` newEntity: boolean -Defined in: [packages/core/src/entity/EntityFactory.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L9) +Defined in: [packages/core/src/entity/EntityFactory.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L9) ___ ### refresh -• `Optional` refresh: undefined \\\| boolean +• `Optional` refresh: boolean -Defined in: [packages/core/src/entity/EntityFactory.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityFactory.ts#L11) +Defined in: [packages/core/src/entity/EntityFactory.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityFactory.ts#L11) diff --git a/core.findoneorfailoptions.md b/core.findoneorfailoptions.md index a9c354a..6952ecc 100644 --- a/core.findoneorfailoptions.md +++ b/core.findoneorfailoptions.md @@ -2,6 +2,7 @@ id: "core.findoneorfailoptions" title: "Interface: FindOneOrFailOptions<T, P>" sidebar_label: "FindOneOrFailOptions" +custom_edit_url: null hide_title: true --- @@ -12,9 +13,9 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| - \| - \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\\\> \| +`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\> \| ## Hierarchy @@ -26,156 +27,171 @@ Name \| Type \| Default \| ### cache -• `Optional` cache: undefined \\\| number \\\| boolean \\\| [string, number] +• `Optional` cache: number \\\| boolean \\\| [string, number] Inherited from: [FindOneOptions](core.findoneoptions.md).[cache](core.findoneoptions.md#cache) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L85) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L85) ___ ### convertCustomTypes -• `Optional` convertCustomTypes: undefined \\\| boolean +• `Optional` convertCustomTypes: boolean Inherited from: [FindOneOptions](core.findoneoptions.md).[convertCustomTypes](core.findoneoptions.md#convertcustomtypes) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L89) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L89) ___ ### disableIdentityMap -• `Optional` disableIdentityMap: undefined \\\| boolean +• `Optional` disableIdentityMap: boolean Inherited from: [FindOneOptions](core.findoneoptions.md).[disableIdentityMap](core.findoneoptions.md#disableidentitymap) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L90) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L90) ___ ### failHandler -• `Optional` failHandler: undefined \\\| (`entityName`: string, `where`: any) => Error +• `Optional` failHandler: (`entityName`: string, `where`: any) => Error -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:106](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L106) +#### Type declaration: + +▸ (`entityName`: string, `where`: any): Error + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entityName` \| string \| +`where` \| any \| + +Returns: Error + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L106) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L106) ___ ### fields -• `Optional` fields: undefined \\\| (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] +• `Optional` fields: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] Inherited from: [FindOneOptions](core.findoneoptions.md).[fields](core.findoneoptions.md#fields) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L91) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L91) ___ ### filters -• `Optional` filters: undefined \\\| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> Inherited from: [FindOneOptions](core.findoneoptions.md).[filters](core.findoneoptions.md#filters) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:97](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L97) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L97) ___ ### flags -• `Optional` flags: undefined \\\| [QueryFlag](../enums/core.queryflag.md)[] +• `Optional` flags: [QueryFlag](../enums/core.queryflag.md)[] Inherited from: [FindOneOptions](core.findoneoptions.md).[flags](core.findoneoptions.md#flags) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L93) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L93) ___ ### groupBy -• `Optional` groupBy: undefined \\\| string \\\| string[] +• `Optional` groupBy: string \\\| string[] Inherited from: [FindOneOptions](core.findoneoptions.md).[groupBy](core.findoneoptions.md#groupby) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L94) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L94) ___ ### having -• `Optional` having: undefined \\\| { `__@PrimaryKeyType@41543?`: any } \\\| { `__@PrimaryKeyType@41543?`: any } & [Dictionary](../modules/core.md#dictionary)<any\\> \\\| NonNullable<Query<T\\>\\> \\\| NonNullable<Query<T\\>\\> & [Dictionary](../modules/core.md#dictionary)<any\\> +• `Optional` having: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> Inherited from: [FindOneOptions](core.findoneoptions.md).[having](core.findoneoptions.md#having) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:95](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L95) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L95) ___ ### lockMode -• `Optional` lockMode: undefined \\\| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write) +• `Optional` lockMode: [LockMode](../enums/core.lockmode.md) Inherited from: [FindOneOptions](core.findoneoptions.md).[lockMode](core.findoneoptions.md#lockmode) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L101) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L101) ___ ### lockVersion -• `Optional` lockVersion: undefined \\\| number \\\| Date +• `Optional` lockVersion: number \\\| Date Inherited from: [FindOneOptions](core.findoneoptions.md).[lockVersion](core.findoneoptions.md#lockversion) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L102) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L102) ___ ### orderBy -• `Optional` orderBy: undefined \\\| [QueryOrderMap](core.queryordermap.md) +• `Optional` orderBy: [QueryOrderMap](core.queryordermap.md) Inherited from: [FindOneOptions](core.findoneoptions.md).[orderBy](core.findoneoptions.md#orderby) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:84](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L84) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L84) ___ ### populate -• `Optional` populate: undefined \\\| P +• `Optional` populate: P Inherited from: [FindOneOptions](core.findoneoptions.md).[populate](core.findoneoptions.md#populate) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L83) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L83) ___ ### refresh -• `Optional` refresh: undefined \\\| boolean +• `Optional` refresh: boolean Inherited from: [FindOneOptions](core.findoneoptions.md).[refresh](core.findoneoptions.md#refresh) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L88) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L88) ___ ### schema -• `Optional` schema: undefined \\\| string +• `Optional` schema: string Inherited from: [FindOneOptions](core.findoneoptions.md).[schema](core.findoneoptions.md#schema) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L92) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L92) ___ ### strategy -• `Optional` strategy: undefined \\\| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) Inherited from: [FindOneOptions](core.findoneoptions.md).[strategy](core.findoneoptions.md#strategy) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L96) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L96) diff --git a/core.flatqueryordermap.md b/core.flatqueryordermap.md index 13564b2..fa72d11 100644 --- a/core.flatqueryordermap.md +++ b/core.flatqueryordermap.md @@ -2,6 +2,7 @@ id: "core.flatqueryordermap" title: "Interface: FlatQueryOrderMap" sidebar_label: "FlatQueryOrderMap" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).FlatQueryOrderMap -## Hierarchy - -* FlatQueryOrderMap - ## Indexable ▪ [x: string]: [QueryOrderKeysFlat](../modules/core.md#queryorderkeysflat) diff --git a/core.flusheventargs.md b/core.flusheventargs.md index 423ccc9..9227b27 100644 --- a/core.flusheventargs.md +++ b/core.flusheventargs.md @@ -2,6 +2,7 @@ id: "core.flusheventargs" title: "Interface: FlushEventArgs" sidebar_label: "FlushEventArgs" +custom_edit_url: null hide_title: true --- @@ -11,7 +12,7 @@ hide_title: true ## Hierarchy -* Omit<[EventArgs](core.eventargs.md)<unknown\\>, entity\\> +* Omit<[EventArgs](core.eventargs.md)<unknown\\>, entity\\> ↳ FlushEventArgs @@ -19,9 +20,11 @@ hide_title: true ### changeSet -• `Optional` changeSet: undefined \\\| [ChangeSet](../classes/core.changeset.md)<unknown\\> +• `Optional` changeSet: [ChangeSet](../classes/core.changeset.md)<unknown\\> -Defined in: [packages/core/src/events/EventSubscriber.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L9) +Inherited from: void + +Defined in: [packages/core/src/events/EventSubscriber.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L9) ___ @@ -29,7 +32,9 @@ ___ • em: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> -Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L8) +Inherited from: void + +Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L8) ___ @@ -37,4 +42,4 @@ ___ • uow: [UnitOfWork](../classes/core.unitofwork.md) -Defined in: [packages/core/src/events/EventSubscriber.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L13) +Defined in: [packages/core/src/events/EventSubscriber.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L13) diff --git a/core.highlighter.md b/core.highlighter.md index 4ed923a..86dfc49 100644 --- a/core.highlighter.md +++ b/core.highlighter.md @@ -2,6 +2,7 @@ id: "core.highlighter" title: "Interface: Highlighter" sidebar_label: "Highlighter" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).Highlighter -## Hierarchy - -* Highlighter - ## Implemented by * [NullHighlighter](../classes/core.nullhighlighter.md) @@ -26,9 +23,9 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `text` \| string \| Returns: string -Defined in: [packages/core/src/typings.ts:418](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L418) +Defined in: [packages/core/src/typings.ts:424](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L424) diff --git a/core.iconfiguration.md b/core.iconfiguration.md index d2ef901..0a0a88c 100644 --- a/core.iconfiguration.md +++ b/core.iconfiguration.md @@ -2,6 +2,7 @@ id: "core.iconfiguration" title: "Interface: IConfiguration" sidebar_label: "IConfiguration" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).IConfiguration -## Hierarchy - -* IConfiguration - ## Methods ### get @@ -22,10 +19,10 @@ hide_title: true #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `key` \| string \| `defaultValue?` \| any \| Returns: any -Defined in: [packages/core/src/metadata/MetadataProvider.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/metadata/MetadataProvider.ts#L6) +Defined in: [packages/core/src/metadata/MetadataProvider.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/metadata/MetadataProvider.ts#L6) diff --git a/core.idatabasedriver.md b/core.idatabasedriver.md index dd59b76..64abe13 100644 --- a/core.idatabasedriver.md +++ b/core.idatabasedriver.md @@ -2,6 +2,7 @@ id: "core.idatabasedriver" title: "Interface: IDatabaseDriver<C>" sidebar_label: "IDatabaseDriver" +custom_edit_url: null hide_title: true --- @@ -12,57 +13,53 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `C` \| [Connection](../classes/core.connection.md) \| [Connection](../classes/core.connection.md) \| -## Hierarchy - -* IDatabaseDriver - ## Implemented by * [DatabaseDriver](../classes/core.databasedriver.md) ## Properties -### \\_\\_@EntityManagerType@43871 +### [EntityManagerType] -• \\_\\_@EntityManagerType@43871: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<C\\>\\> +• [EntityManagerType]: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<C\\>\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L14) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L14) ## Methods ### aggregate -▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> +▸ aggregate(`entityName`: string, `pipeline`: any[]): Promise<any[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `pipeline` \| any[] \| -Returns: Promise<any[]\\> +Returns: Promise<any[]\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L50) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L50) ___ ### close -▸ close(`force?`: boolean): Promise<void\\> +▸ close(`force?`: boolean): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `force?` \| boolean \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L20) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L20) ___ @@ -72,7 +69,7 @@ ___ Returns: Promise<C\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L18) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L18) ___ @@ -85,37 +82,37 @@ Converts native db errors to standardized driver exceptions #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `exception` \| Error \| Returns: [DriverException](../classes/core.driverexception.md) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:76](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L76) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:76](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L76) ___ ### count -▸ count<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](core.countoptions.md)<T\\>, `ctx?`: any): Promise<number\\> +▸ count<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [CountOptions](core.countoptions.md)<T\\>, `ctx?`: any): Promise<number\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `options?` \| [CountOptions](core.countoptions.md)<T\\> \| `ctx?` \| any \| -Returns: Promise<number\\> +Returns: Promise<number\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L48) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L48) ___ @@ -126,82 +123,82 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`D` \| [IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md), D\\> \| [IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\\\> \| +:------ \| :------ \| :------ \| +`D` \| [IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md), D\\> \| [IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `useContext?` \| boolean \| Returns: D[typeof [EntityManagerType](../modules/core.md#entitymanagertype)] -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L16) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L16) ___ ### ensureIndexes -▸ ensureIndexes(): Promise<void\\> +▸ ensureIndexes(): Promise<void\\> -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L63) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L63) ___ ### find -▸ find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: any): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> +▸ find<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOptions](core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: any): Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> Finds selection of entities #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOptions](core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `ctx?` \| any \| Returns: Promise<[EntityData](../modules/core.md#entitydata)<T\\>[]\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L29) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L29) ___ ### findOne -▸ findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>, `ctx?`: any): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> +▸ findOne<T\\>(`entityName`: string, `where`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `options?`: [FindOneOptions](core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>, `ctx?`: any): Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> Finds single entity (table row, document) #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| -`options?` \| [FindOneOptions](core.findoneoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOneOptions](core.findoneoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| `ctx?` \| any \| Returns: Promise<null \\\| [EntityData](../modules/core.md#entitydata)<T\\>\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L34) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L34) ___ @@ -212,12 +209,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `type?` \| read \\\| write \| Returns: C -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L24) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L24) ___ @@ -230,7 +227,7 @@ for SQL drivers it also returns `knex` in the array as connectors are not used d Returns: string[] -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L69) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L69) ___ @@ -240,85 +237,85 @@ ___ Returns: [Platform](../classes/core.platform.md) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L59) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L59) ___ ### loadFromPivotTable -▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> +▸ loadFromPivotTable<T, O\\>(`prop`: [EntityProperty](core.entityproperty.md)<any\\>, `owners`: [Primary](../modules/core.md#primary)<O\\>[][], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](core.queryordermap.md), `ctx?`: any, `options?`: [FindOptions](core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> When driver uses pivot tables for M:N, this method will load identifiers for given collections from them #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| `O` \| [AnyEntity](../modules/core.md#anyentity)<O\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| -`prop` \| [EntityProperty](core.entityproperty.md)<any\\> \| +:------ \| :------ \| +`prop` \| [EntityProperty](core.entityproperty.md)<any\\> \| `owners` \| [Primary](../modules/core.md#primary)<O\\>[][] \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](core.queryordermap.md) \| `ctx?` \| any \| -`options?` \| [FindOptions](core.findoptions.md)<T, [Populate](../modules/core.md#populate)<T\\>\\> \| +`options?` \| [FindOptions](core.findoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| Returns: Promise<[Dictionary](../modules/core.md#dictionary)<T[]\\>\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L57) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L57) ___ ### lockPessimistic -▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> +▸ lockPessimistic<T\\>(`entity`: T, `mode`: [LockMode](../enums/core.lockmode.md), `ctx?`: any): Promise<void\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `mode` \| [LockMode](../enums/core.lockmode.md) \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L71) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L71) ___ ### mapResult -▸ mapResult<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](../classes/core.entitymetadata.md)<any\\>, `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[]): null \\\| [EntityData](../modules/core.md#entitydata)<T\\> +▸ mapResult<T\\>(`result`: [EntityData](../modules/core.md#entitydata)<T\\>, `meta`: [EntityMetadata](../classes/core.entitymetadata.md)<any\\>, `populate?`: [PopulateOptions](../modules/core.md#populateoptions)<T\\>[]): null \\\| [EntityData](../modules/core.md#entitydata)<T\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `result` \| [EntityData](../modules/core.md#entitydata)<T\\> \| -`meta` \| [EntityMetadata](../classes/core.entitymetadata.md)<any\\> \| +`meta` \| [EntityMetadata](../classes/core.entitymetadata.md)<any\\> \| `populate?` \| [PopulateOptions](../modules/core.md#populateoptions)<T\\>[] \| Returns: null \\\| [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L52) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L52) ___ @@ -329,20 +326,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `ctx?` \| any \| Returns: Promise<[QueryResult](core.queryresult.md)\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L44) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L44) ___ @@ -353,13 +350,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| `ctx?` \| any \| @@ -367,7 +364,7 @@ Name \| Type \| Returns: Promise<[QueryResult](core.queryresult.md)\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L36) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L36) ___ @@ -378,13 +375,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| `ctx?` \| any \| @@ -393,7 +390,7 @@ Name \| Type \| Returns: Promise<[QueryResult](core.queryresult.md)\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L38) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L38) ___ @@ -404,13 +401,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\> \| @@ -419,7 +416,7 @@ Name \| Type \| Returns: Promise<[QueryResult](core.queryresult.md)\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L40) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L40) ___ @@ -430,13 +427,13 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `where` \| [FilterQuery](../modules/core.md#filterquery)<T\\>[] \| `data` \| [EntityData](../modules/core.md#entitydata)<T\\>[] \| @@ -446,7 +443,7 @@ Name \| Type \| Returns: Promise<[QueryResult](core.queryresult.md)\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L42) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L42) ___ @@ -456,7 +453,7 @@ ___ Returns: Promise<C\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L22) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L22) ___ @@ -467,33 +464,33 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `metadata` \| [MetadataStorage](../classes/core.metadatastorage.md) \| Returns: void -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L61) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L61) ___ ### syncCollection -▸ syncCollection<T, O\\>(`collection`: [Collection](../classes/core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> +▸ syncCollection<T, O\\>(`collection`: [Collection](../classes/core.collection.md)<T, O\\>, `ctx?`: any): Promise<void\\> #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `collection` \| [Collection](../classes/core.collection.md)<T, O\\> \| `ctx?` \| any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L46) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L46) diff --git a/core.indexoptions.md b/core.indexoptions.md index dd2b118..cc228eb 100644 --- a/core.indexoptions.md +++ b/core.indexoptions.md @@ -2,6 +2,7 @@ id: "core.indexoptions" title: "Interface: IndexOptions<T>" sidebar_label: "IndexOptions" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| ## Hierarchy @@ -25,36 +26,36 @@ Name \| Type \| ### name -• `Optional` name: undefined \\\| string +• `Optional` name: string Inherited from: [UniqueOptions](core.uniqueoptions.md).[name](core.uniqueoptions.md#name) -Defined in: [packages/core/src/decorators/Indexed.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L29) +Defined in: [packages/core/src/decorators/Indexed.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L29) ___ ### options -• `Optional` options: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\> +• `Optional` options: [Dictionary](../modules/core.md#dictionary)<any\\> Inherited from: [UniqueOptions](core.uniqueoptions.md).[options](core.uniqueoptions.md#options) -Defined in: [packages/core/src/decorators/Indexed.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L31) +Defined in: [packages/core/src/decorators/Indexed.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L31) ___ ### properties -• `Optional` properties: undefined \\\| keyof T \\\| keyof T[] +• `Optional` properties: keyof T \\\| keyof T[] Inherited from: [UniqueOptions](core.uniqueoptions.md).[properties](core.uniqueoptions.md#properties) -Defined in: [packages/core/src/decorators/Indexed.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L30) +Defined in: [packages/core/src/decorators/Indexed.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L30) ___ ### type -• `Optional` type: undefined \\\| string +• `Optional` type: string -Defined in: [packages/core/src/decorators/Indexed.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L35) +Defined in: [packages/core/src/decorators/Indexed.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L35) diff --git a/core.iwrappedentity.md b/core.iwrappedentity.md index d905b1d..d436d40 100644 --- a/core.iwrappedentity.md +++ b/core.iwrappedentity.md @@ -2,6 +2,7 @@ id: "core.iwrappedentity" title: "Interface: IWrappedEntity<T, PK, P>" sidebar_label: "IWrappedEntity" +custom_edit_url: null hide_title: true --- @@ -12,15 +13,11 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| `PK` \| keyof T \| - \| `P` \| [Populate](../modules/core.md#populate)<T\\> \\\| unknown \| unknown \| -## Hierarchy - -* IWrappedEntity - ## Implemented by * [BaseEntity](../classes/core.baseentity.md) @@ -34,37 +31,37 @@ Name \| Type \| Default \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| `options?` \| boolean \\\| [AssignOptions](core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/typings.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L87) +Defined in: [packages/core/src/typings.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L87) ___ ### init -▸ init<P\\>(`populated?`: boolean, `populate?`: P, `lockMode?`: [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write)): Promise<T\\> +▸ init<P\\>(`populated?`: boolean, `populate?`: P, `lockMode?`: [LockMode](../enums/core.lockmode.md)): Promise<T\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\\\> \| +:------ \| :------ \| :------ \| +`P` \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populated?` \| boolean \| `populate?` \| P \| -`lockMode?` \| [NONE](../enums/core.lockmode.md#none) \\\| [OPTIMISTIC](../enums/core.lockmode.md#optimistic) \\\| [PESSIMISTIC\\_READ](../enums/core.lockmode.md#pessimistic_read) \\\| [PESSIMISTIC\\_WRITE](../enums/core.lockmode.md#pessimistic_write) \| +`lockMode?` \| [LockMode](../enums/core.lockmode.md) \| Returns: Promise<T\\> -Defined in: [packages/core/src/typings.ts:82](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L82) +Defined in: [packages/core/src/typings.ts:82](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L82) ___ @@ -74,7 +71,7 @@ ___ Returns: boolean -Defined in: [packages/core/src/typings.ts:80](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L80) +Defined in: [packages/core/src/typings.ts:80](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L80) ___ @@ -85,44 +82,44 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populated?` \| boolean \| Returns: void -Defined in: [packages/core/src/typings.ts:81](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L81) +Defined in: [packages/core/src/typings.ts:81](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L81) ___ ### toJSON -▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/typings.ts:85](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L85) +Defined in: [packages/core/src/typings.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L85) ___ ### toObject -▸ toObject(`ignoreFields?`: string[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toObject(`ignoreFields?`: string[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ignoreFields?` \| string[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/typings.ts:84](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L84) +Defined in: [packages/core/src/typings.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L84) ___ @@ -132,7 +129,7 @@ ___ Returns: [EntityData](../modules/core.md#entitydata)<T\\> -Defined in: [packages/core/src/typings.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L86) +Defined in: [packages/core/src/typings.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L86) ___ @@ -143,10 +140,10 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`PK2` \| unknown \| [PrimaryProperty](../modules/core.md#primaryproperty)<T\\\\> \| +:------ \| :------ \| :------ \| +`PK2` \| unknown \| [PrimaryProperty](../modules/core.md#primaryproperty)<T\\> \| `P2` \| unknown \| unknown \| Returns: [IdentifiedReference](../modules/core.md#identifiedreference)<T, PK2\\> & [LoadedReference](core.loadedreference.md)<T, P2\\> -Defined in: [packages/core/src/typings.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L83) +Defined in: [packages/core/src/typings.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L83) diff --git a/core.loadedcollection.md b/core.loadedcollection.md index 43e073a..f596777 100644 --- a/core.loadedcollection.md +++ b/core.loadedcollection.md @@ -2,6 +2,7 @@ id: "core.loadedcollection" title: "Interface: LoadedCollection<T, P>" sidebar_label: "LoadedCollection" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| `P` \| - \| never \| @@ -28,17 +29,17 @@ Name \| Type \| Default \| • $: readonly T & P[] -Defined in: [packages/core/src/typings.ts:384](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L384) +Defined in: [packages/core/src/typings.ts:390](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L390) ___ ### \\_count -• `Protected` `Optional` \\_count: undefined \\\| number +• `Protected` `Optional` \\_count: number Inherited from: [Collection](../classes/core.collection.md).[_count](../classes/core.collection.md#_count) -Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L13) +Defined in: [packages/core/src/entity/ArrayCollection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L13) ___ @@ -48,7 +49,7 @@ ___ Inherited from: [Collection](../classes/core.collection.md).[initialized](../classes/core.collection.md#initialized) -Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L12) +Defined in: [packages/core/src/entity/ArrayCollection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L12) ___ @@ -58,13 +59,13 @@ ___ Inherited from: [Collection](../classes/core.collection.md).[items](../classes/core.collection.md#items) -Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L11) +Defined in: [packages/core/src/entity/ArrayCollection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L11) ___ ### owner -• `Readonly` owner: Partial<unknown\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: undefined \\\| IWrappedEntityInternal<unknown, never, never\\> ; `__meta?`: undefined \\\| [EntityMetadata](../classes/core.entitymetadata.md)<unknown\\> ; `__platform?`: undefined \\\| [Platform](../classes/core.platform.md) } +• `Readonly` owner: Partial<unknown\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<unknown, never, never\\> ; `__meta?`: [EntityMetadata](../classes/core.entitymetadata.md)<unknown\\> ; `__platform?`: [Platform](../classes/core.platform.md) } Inherited from: [Collection](../classes/core.collection.md).[owner](../classes/core.collection.md#owner) @@ -72,23 +73,23 @@ Inherited from: [Collection](../classes/core.collection.md).[owner](../classes/c ### length -• length(): number +• get length(): number Returns: number -Defined in: [packages/core/src/entity/ArrayCollection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L134) +Defined in: [packages/core/src/entity/ArrayCollection.ts:139](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L139) ___ ### property -• property(): [EntityProperty](core.entityproperty.md)<T\\> +• get property(): [EntityProperty](core.entityproperty.md)<T\\> `internal` Returns: [EntityProperty](core.entityproperty.md)<T\\> -Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L147) +Defined in: [packages/core/src/entity/ArrayCollection.ts:152](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L152) ## Methods @@ -100,7 +101,7 @@ Defined in: [packages/core/src/entity/ArrayCollection.ts:147](https://github.com Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:138](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L138) +Defined in: [packages/core/src/entity/ArrayCollection.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L143) ___ @@ -111,14 +112,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](../classes/core.reference.md)<T\\>)[] \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L91) +Defined in: [packages/core/src/entity/Collection.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L118) ___ @@ -129,7 +130,7 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `item` \| T \\\| [Reference](../classes/core.reference.md)<T\\> \| - \| `check` \| boolean \| true \| @@ -137,7 +138,7 @@ Name \| Type \| Default value \| Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:134](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L134) +Defined in: [packages/core/src/entity/Collection.ts:161](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L161) ___ @@ -149,7 +150,7 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:142](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L142) +Defined in: [packages/core/src/entity/Collection.ts:169](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L169) ___ @@ -159,7 +160,7 @@ ___ Returns: readonly T & P[] -Defined in: [packages/core/src/typings.ts:385](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L385) +Defined in: [packages/core/src/typings.ts:391](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L391) ___ @@ -170,20 +171,20 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| -`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\\\> & string \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & number \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & bigint \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & Date \\\\\| [Primary](../modules/core.md#primary)<T\\\\> & { \\`toHexString\\`: () =\\> string } \| +:------ \| :------ \| :------ \| +`U` \| IPrimaryKeyValue \| [Primary](../modules/core.md#primary)<T\\> & IPrimaryKeyValue \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field?` \| string \| Returns: U[] Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L53) +Defined in: [packages/core/src/entity/ArrayCollection.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L53) ___ @@ -196,14 +197,14 @@ Returns the items (the collection must be initialized) #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `check` \| boolean \| true \| Returns: T[] Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:75](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L75) +Defined in: [packages/core/src/entity/Collection.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L102) ___ @@ -217,7 +218,7 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:226](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L226) +Defined in: [packages/core/src/entity/Collection.ts:249](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L249) ___ @@ -230,14 +231,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| T[] \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L116) +Defined in: [packages/core/src/entity/Collection.ts:143](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L143) ___ @@ -248,14 +249,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `value` \| number \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:197](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L197) +Defined in: [packages/core/src/entity/ArrayCollection.ts:202](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L202) ___ @@ -266,30 +267,30 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| [InitOptions](core.initoptions.md)<T\\> \| Returns: Promise<[LoadedCollection](core.loadedcollection.md)<T, P\\>\\> Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:164](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L164) +Defined in: [packages/core/src/entity/Collection.ts:191](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L191) -▸ init(`populate?`: string[], `where?`: { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\>, `orderBy?`: [QueryOrderMap](core.queryordermap.md)): Promise<[LoadedCollection](core.loadedcollection.md)<T, P\\>\\> +▸ init(`populate?`: string[], `where?`: [FilterQuery](../modules/core.md#filterquery)<T\\>, `orderBy?`: [QueryOrderMap](core.queryordermap.md)): Promise<[LoadedCollection](core.loadedcollection.md)<T, P\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populate?` \| string[] \| -`where?` \| { `__@PrimaryKeyType@41543?`: any } \\\| NonNullable<Query<T\\>\\> \| +`where?` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \| `orderBy?` \| [QueryOrderMap](core.queryordermap.md) \| Returns: Promise<[LoadedCollection](core.loadedcollection.md)<T, P\\>\\> Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L165) +Defined in: [packages/core/src/entity/Collection.ts:192](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L192) ___ @@ -301,7 +302,7 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:156](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L156) +Defined in: [packages/core/src/entity/Collection.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L183) ___ @@ -312,20 +313,20 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `fully` \| boolean \| false \| Returns: boolean Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:126](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L126) +Defined in: [packages/core/src/entity/ArrayCollection.ts:131](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L131) ___ ### loadCount -▸ loadCount(`refresh?`: boolean): Promise<number\\> +▸ loadCount(`refresh?`: boolean): Promise<number\\> Gets the count of collection items from database instead of counting loaded items. The value is cached, use `refresh = true` to force reload it. @@ -333,14 +334,14 @@ The value is cached, use `refresh = true` to force reload it. #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `refresh` \| boolean \| false \| -Returns: Promise<number\\> +Returns: Promise<number\\> Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L54) +Defined in: [packages/core/src/entity/Collection.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L63) ___ @@ -354,7 +355,25 @@ Initializes the collection and returns the items Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L42) +Defined in: [packages/core/src/entity/Collection.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L51) + +___ + +### matching + +▸ matching(`options`: [MatchingOptions](core.matchingoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\>): Promise<T[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`options` \| [MatchingOptions](core.matchingoptions.md)<T, readonly string[] \\\| readonly keyof T[] \\\| boolean \\\| [LoadStrategy](../enums/core.loadstrategy.md) \\\| PopulateChildren<T\\>\\> \| + +Returns: Promise<T[]\\> + +Inherited from: [Collection](../classes/core.collection.md) + +Defined in: [packages/core/src/entity/Collection.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L77) ___ @@ -365,14 +384,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `populated` \| boolean \| true \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:151](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L151) +Defined in: [packages/core/src/entity/Collection.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L178) ___ @@ -383,7 +402,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -391,7 +410,7 @@ Name \| Type \| Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:157](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L157) +Defined in: [packages/core/src/entity/ArrayCollection.ts:162](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L162) ___ @@ -402,7 +421,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -410,7 +429,7 @@ Name \| Type \| Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:165](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L165) +Defined in: [packages/core/src/entity/ArrayCollection.ts:170](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L170) ___ @@ -421,7 +440,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `item` \| T \| `method` \| add \\\| remove \| @@ -429,7 +448,7 @@ Name \| Type \| Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:173](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L173) +Defined in: [packages/core/src/entity/ArrayCollection.ts:178](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L178) ___ @@ -440,14 +459,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...items` \| (T \\\| [Reference](../classes/core.reference.md)<T\\>)[] \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L122) +Defined in: [packages/core/src/entity/Collection.ts:149](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L149) ___ @@ -459,7 +478,7 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:113](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L113) +Defined in: [packages/core/src/entity/ArrayCollection.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L118) ___ @@ -470,14 +489,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `items` \| (T \\\| [Reference](../classes/core.reference.md)<T\\>)[] \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:98](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L98) +Defined in: [packages/core/src/entity/Collection.ts:125](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L125) ___ @@ -488,14 +507,14 @@ ___ #### Parameters: Name \| Type \| Default value \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `dirty` \| boolean \| true \| Returns: void Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:160](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L160) +Defined in: [packages/core/src/entity/Collection.ts:187](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L187) ___ @@ -507,26 +526,26 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:147](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L147) +Defined in: [packages/core/src/entity/Collection.ts:174](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L174) ___ ### shouldPropagateToCollection -▸ `Protected`shouldPropagateToCollection(`collection`: [ArrayCollection](../classes/core.arraycollection.md)<unknown, T\\>, `method`: add \\\| remove): boolean +▸ `Protected`shouldPropagateToCollection(`collection`: [ArrayCollection](../classes/core.arraycollection.md)<unknown, T\\>, `method`: add \\\| remove): boolean #### Parameters: Name \| Type \| ------- \| ------ \| -`collection` \| [ArrayCollection](../classes/core.arraycollection.md)<unknown, T\\> \| +:------ \| :------ \| +`collection` \| [ArrayCollection](../classes/core.arraycollection.md)<unknown, T\\> \| `method` \| add \\\| remove \| Returns: boolean Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:184](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L184) +Defined in: [packages/core/src/entity/ArrayCollection.ts:189](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L189) ___ @@ -540,28 +559,28 @@ ___ Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:218](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L218) +Defined in: [packages/core/src/entity/Collection.ts:241](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L241) ___ ### toArray -▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toArray(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/ArrayCollection.ts#L38) +Defined in: [packages/core/src/entity/ArrayCollection.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/ArrayCollection.ts#L38) ___ ### toJSON -▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] +▸ toJSON(): [Dictionary](../modules/core.md#dictionary)<any\\>[] -Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] +Returns: [Dictionary](../modules/core.md#dictionary)<any\\>[] Inherited from: [Collection](../classes/core.collection.md) -Defined in: [packages/core/src/entity/Collection.ts:83](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Collection.ts#L83) +Defined in: [packages/core/src/entity/Collection.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L110) diff --git a/core.loadedreference.md b/core.loadedreference.md index 7d66cb8..8a6d76b 100644 --- a/core.loadedreference.md +++ b/core.loadedreference.md @@ -2,6 +2,7 @@ id: "core.loadedreference" title: "Interface: LoadedReference<T, P>" sidebar_label: "LoadedReference" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| - \| `P` \| - \| never \| @@ -28,7 +29,7 @@ Name \| Type \| Default \| • $: T & P -Defined in: [packages/core/src/typings.ts:379](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L379) +Defined in: [packages/core/src/typings.ts:385](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L385) ## Methods @@ -38,7 +39,7 @@ Defined in: [packages/core/src/typings.ts:379](https://github.com/mikro-orm/mikr Returns: T & P -Defined in: [packages/core/src/typings.ts:380](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L380) +Defined in: [packages/core/src/typings.ts:386](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L386) ___ @@ -50,7 +51,7 @@ ___ Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L108) +Defined in: [packages/core/src/entity/Reference.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L108) ___ @@ -61,20 +62,20 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `K` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| K \| Returns: T[K] Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L116) +Defined in: [packages/core/src/entity/Reference.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L116) ___ @@ -86,7 +87,7 @@ ___ Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L120) +Defined in: [packages/core/src/entity/Reference.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L120) ___ @@ -101,7 +102,7 @@ Returns the entity. Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L67) +Defined in: [packages/core/src/entity/Reference.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L67) ▸ load<K\\>(`prop`: K): Promise<T[K]\\> @@ -111,20 +112,20 @@ Returns the requested property instead of the whole entity. #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `K` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prop` \| K \| Returns: Promise<T[K]\\> Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:73](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L73) +Defined in: [packages/core/src/entity/Reference.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L73) ___ @@ -135,14 +136,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `populated?` \| boolean \| Returns: void Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L124) +Defined in: [packages/core/src/entity/Reference.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L124) ___ @@ -153,32 +154,32 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \\\| [IdentifiedReference](../modules/core.md#identifiedreference)<T, [PrimaryProperty](../modules/core.md#primaryproperty)<T\\>\\> \| Returns: void Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L91) +Defined in: [packages/core/src/entity/Reference.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L91) ___ ### toJSON -▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> +▸ toJSON(...`args`: any[]): [Dictionary](../modules/core.md#dictionary)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...args` \| any[] \| -Returns: [Dictionary](../modules/core.md#dictionary)<any\\> +Returns: [Dictionary](../modules/core.md#dictionary)<any\\> Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L128) +Defined in: [packages/core/src/entity/Reference.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L128) ___ @@ -190,4 +191,4 @@ ___ Inherited from: [Reference](../classes/core.reference.md) -Defined in: [packages/core/src/entity/Reference.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L104) +Defined in: [packages/core/src/entity/Reference.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L104) diff --git a/core.manytomanyoptions.md b/core.manytomanyoptions.md index 10b1ecc..8f3419c 100644 --- a/core.manytomanyoptions.md +++ b/core.manytomanyoptions.md @@ -2,6 +2,7 @@ id: "core.manytomanyoptions" title: "Interface: ManyToManyOptions<T, O>" sidebar_label: "ManyToManyOptions" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| `O` \| @@ -26,347 +27,391 @@ Name \| ### cascade -• `Optional` cascade: undefined \\\| [Cascade](../enums/core.cascade.md)[] +• `Optional` cascade: [Cascade](../enums/core.cascade.md)[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[cascade](core.referenceoptions.md#cascade) -Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L67) +Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L67) ___ ### columnType -• `Optional` columnType: undefined \\\| string +• `Optional` columnType: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[columnType](core.referenceoptions.md#columntype) -Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L42) +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) ___ ### comment -• `Optional` comment: undefined \\\| string +• `Optional` comment: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[comment](core.referenceoptions.md#comment) -Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L62) +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) ___ ### customType -• `Optional` customType: undefined \\\| [Type](../classes/core.type.md)<any, any\\> +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> Inherited from: [ReferenceOptions](core.referenceoptions.md).[customType](core.referenceoptions.md#customtype) -Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L41) +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) ___ ### default -• `Optional` default: undefined \\\| null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[default](core.referenceoptions.md#default) -Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L47) +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) ___ ### defaultRaw -• `Optional` defaultRaw: undefined \\\| string +• `Optional` defaultRaw: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[defaultRaw](core.referenceoptions.md#defaultraw) -Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L48) +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) ___ ### eager -• `Optional` eager: undefined \\\| boolean +• `Optional` eager: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[eager](core.referenceoptions.md#eager) -Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L68) +Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L68) ___ ### entity -• `Optional` entity: undefined \\\| string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> +• `Optional` entity: string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> Inherited from: [ReferenceOptions](core.referenceoptions.md).[entity](core.referenceoptions.md#entity) -Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L66) +Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L66) ___ ### fieldName -• `Optional` fieldName: undefined \\\| string +• `Optional` fieldName: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[fieldName](core.referenceoptions.md#fieldname) -Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L39) +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) ___ ### fieldNames -• `Optional` fieldNames: undefined \\\| string[] +• `Optional` fieldNames: string[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[fieldNames](core.referenceoptions.md#fieldnames) -Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L40) +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) ___ ### fixedOrder -• `Optional` fixedOrder: undefined \\\| boolean +• `Optional` fixedOrder: boolean -Defined in: [packages/core/src/decorators/ManyToMany.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L28) +Defined in: [packages/core/src/decorators/ManyToMany.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L28) ___ ### fixedOrderColumn -• `Optional` fixedOrderColumn: undefined \\\| string +• `Optional` fixedOrderColumn: string -Defined in: [packages/core/src/decorators/ManyToMany.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L29) +Defined in: [packages/core/src/decorators/ManyToMany.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L29) ___ ### formula -• `Optional` formula: undefined \\\| string \\\| (`alias`: string) => string +• `Optional` formula: string \\\| (`alias`: string) => string Inherited from: [ReferenceOptions](core.referenceoptions.md).[formula](core.referenceoptions.md#formula) -Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L49) +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) ___ ### hidden -• `Optional` hidden: undefined \\\| boolean +• `Optional` hidden: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[hidden](core.referenceoptions.md#hidden) -Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L53) +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) ___ ### index -• `Optional` index: undefined \\\| string \\\| boolean +• `Optional` index: string \\\| boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[index](core.referenceoptions.md#index) -Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L55) +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) ___ ### inverseJoinColumn -• `Optional` inverseJoinColumn: undefined \\\| string +• `Optional` inverseJoinColumn: string -Defined in: [packages/core/src/decorators/ManyToMany.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L33) +Defined in: [packages/core/src/decorators/ManyToMany.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L33) ___ ### inverseJoinColumns -• `Optional` inverseJoinColumns: undefined \\\| string[] +• `Optional` inverseJoinColumns: string[] -Defined in: [packages/core/src/decorators/ManyToMany.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L34) +Defined in: [packages/core/src/decorators/ManyToMany.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L34) ___ ### inversedBy -• `Optional` inversedBy: undefined \\\| string & keyof T \\\| (`e`: T) => any +• `Optional` inversedBy: string & keyof T \\\| (`e`: T) => any -Defined in: [packages/core/src/decorators/ManyToMany.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L25) +Defined in: [packages/core/src/decorators/ManyToMany.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L25) ___ ### joinColumn -• `Optional` joinColumn: undefined \\\| string +• `Optional` joinColumn: string -Defined in: [packages/core/src/decorators/ManyToMany.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L31) +Defined in: [packages/core/src/decorators/ManyToMany.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L31) ___ ### joinColumns -• `Optional` joinColumns: undefined \\\| string[] +• `Optional` joinColumns: string[] -Defined in: [packages/core/src/decorators/ManyToMany.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L32) +Defined in: [packages/core/src/decorators/ManyToMany.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L32) ___ ### lazy -• `Optional` lazy: undefined \\\| boolean +• `Optional` lazy: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[lazy](core.referenceoptions.md#lazy) -Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L57) +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) ___ ### length -• `Optional` length: undefined \\\| number +• `Optional` length: number Inherited from: [ReferenceOptions](core.referenceoptions.md).[length](core.referenceoptions.md#length) -Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L44) +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) ___ ### mappedBy -• `Optional` mappedBy: undefined \\\| string & keyof T \\\| (`e`: T) => any +• `Optional` mappedBy: string & keyof T \\\| (`e`: T) => any -Defined in: [packages/core/src/decorators/ManyToMany.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L26) +Defined in: [packages/core/src/decorators/ManyToMany.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L26) ___ ### name -• `Optional` name: undefined \\\| string +• `Optional` name: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[name](core.referenceoptions.md#name) -Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L38) +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) ___ ### nullable -• `Optional` nullable: undefined \\\| boolean +• `Optional` nullable: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[nullable](core.referenceoptions.md#nullable) -Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L50) +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) ___ ### onCreate -• `Optional` onCreate: undefined \\\| (`entity`: O) => any +• `Optional` onCreate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) Inherited from: [ReferenceOptions](core.referenceoptions.md).[onCreate](core.referenceoptions.md#oncreate) -Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L45) +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) ___ ### onUpdate -• `Optional` onUpdate: undefined \\\| (`entity`: O) => any +• `Optional` onUpdate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) Inherited from: [ReferenceOptions](core.referenceoptions.md).[onUpdate](core.referenceoptions.md#onupdate) -Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L46) +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) ___ ### orderBy -• `Optional` orderBy: undefined \\\| { [field: string]: [QueryOrder](../enums/core.queryorder.md); } +• `Optional` orderBy: object + +#### Type declaration: -Defined in: [packages/core/src/decorators/ManyToMany.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L27) +Defined in: [packages/core/src/decorators/ManyToMany.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L27) ___ ### owner -• `Optional` owner: undefined \\\| boolean +• `Optional` owner: boolean -Defined in: [packages/core/src/decorators/ManyToMany.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L24) +Defined in: [packages/core/src/decorators/ManyToMany.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L24) ___ ### persist -• `Optional` persist: undefined \\\| boolean +• `Optional` persist: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[persist](core.referenceoptions.md#persist) -Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L52) +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) ___ ### pivotTable -• `Optional` pivotTable: undefined \\\| string +• `Optional` pivotTable: string -Defined in: [packages/core/src/decorators/ManyToMany.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L30) +Defined in: [packages/core/src/decorators/ManyToMany.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L30) ___ ### primary -• `Optional` primary: undefined \\\| boolean +• `Optional` primary: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[primary](core.referenceoptions.md#primary) -Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L58) +Defined in: [packages/core/src/decorators/Property.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L58) ___ ### referenceColumnName -• `Optional` referenceColumnName: undefined \\\| string +• `Optional` referenceColumnName: string -Defined in: [packages/core/src/decorators/ManyToMany.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L35) +Defined in: [packages/core/src/decorators/ManyToMany.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L35) ___ ### serializedName -• `Optional` serializedName: undefined \\\| string +• `Optional` serializedName: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializedName](core.referenceoptions.md#serializedname) -Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L61) +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) ___ ### serializedPrimaryKey -• `Optional` serializedPrimaryKey: undefined \\\| boolean +• `Optional` serializedPrimaryKey: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializedPrimaryKey](core.referenceoptions.md#serializedprimarykey) -Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L59) +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) ___ ### serializer -• `Optional` serializer: undefined \\\| (`value`: any) => any +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializer](core.referenceoptions.md#serializer) -Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L60) +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) ___ ### strategy -• `Optional` strategy: undefined \\\| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) Inherited from: [ReferenceOptions](core.referenceoptions.md).[strategy](core.referenceoptions.md#strategy) -Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L69) +Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L69) ___ @@ -376,34 +421,34 @@ ___ Inherited from: [ReferenceOptions](core.referenceoptions.md).[type](core.referenceoptions.md#type) -Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L43) +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) ___ ### unique -• `Optional` unique: undefined \\\| string \\\| boolean +• `Optional` unique: string \\\| boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[unique](core.referenceoptions.md#unique) -Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L56) +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) ___ ### unsigned -• `Optional` unsigned: undefined \\\| boolean +• `Optional` unsigned: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[unsigned](core.referenceoptions.md#unsigned) -Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L51) +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) ___ ### version -• `Optional` version: undefined \\\| boolean +• `Optional` version: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[version](core.referenceoptions.md#version) -Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L54) +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) diff --git a/core.manytooneoptions.md b/core.manytooneoptions.md index a78e9bd..79fa134 100644 --- a/core.manytooneoptions.md +++ b/core.manytooneoptions.md @@ -2,6 +2,7 @@ id: "core.manytooneoptions" title: "Interface: ManyToOneOptions<T, O>" sidebar_label: "ManyToOneOptions" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| `O` \| @@ -26,299 +27,341 @@ Name \| ### cascade -• `Optional` cascade: undefined \\\| [Cascade](../enums/core.cascade.md)[] +• `Optional` cascade: [Cascade](../enums/core.cascade.md)[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[cascade](core.referenceoptions.md#cascade) -Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L67) +Defined in: [packages/core/src/decorators/Property.ts:67](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L67) ___ ### columnType -• `Optional` columnType: undefined \\\| string +• `Optional` columnType: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[columnType](core.referenceoptions.md#columntype) -Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L42) +Defined in: [packages/core/src/decorators/Property.ts:42](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L42) ___ ### comment -• `Optional` comment: undefined \\\| string +• `Optional` comment: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[comment](core.referenceoptions.md#comment) -Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L62) +Defined in: [packages/core/src/decorators/Property.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L62) ___ ### customType -• `Optional` customType: undefined \\\| [Type](../classes/core.type.md)<any, any\\> +• `Optional` customType: [Type](../classes/core.type.md)<any, any\\> Inherited from: [ReferenceOptions](core.referenceoptions.md).[customType](core.referenceoptions.md#customtype) -Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L41) +Defined in: [packages/core/src/decorators/Property.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L41) ___ ### default -• `Optional` default: undefined \\\| null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] +• `Optional` default: null \\\| string \\\| number \\\| boolean \\\| string[] \\\| number[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[default](core.referenceoptions.md#default) -Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L47) +Defined in: [packages/core/src/decorators/Property.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L47) ___ ### defaultRaw -• `Optional` defaultRaw: undefined \\\| string +• `Optional` defaultRaw: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[defaultRaw](core.referenceoptions.md#defaultraw) -Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L48) +Defined in: [packages/core/src/decorators/Property.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L48) ___ ### eager -• `Optional` eager: undefined \\\| boolean +• `Optional` eager: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[eager](core.referenceoptions.md#eager) -Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L68) +Defined in: [packages/core/src/decorators/Property.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L68) ___ ### entity -• `Optional` entity: undefined \\\| string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> +• `Optional` entity: string \\\| () => [EntityName](../modules/core.md#entityname)<T\\> Inherited from: [ReferenceOptions](core.referenceoptions.md).[entity](core.referenceoptions.md#entity) -Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L66) +Defined in: [packages/core/src/decorators/Property.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L66) ___ ### fieldName -• `Optional` fieldName: undefined \\\| string +• `Optional` fieldName: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[fieldName](core.referenceoptions.md#fieldname) -Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L39) +Defined in: [packages/core/src/decorators/Property.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L39) ___ ### fieldNames -• `Optional` fieldNames: undefined \\\| string[] +• `Optional` fieldNames: string[] Inherited from: [ReferenceOptions](core.referenceoptions.md).[fieldNames](core.referenceoptions.md#fieldnames) -Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L40) +Defined in: [packages/core/src/decorators/Property.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L40) ___ ### formula -• `Optional` formula: undefined \\\| string \\\| (`alias`: string) => string +• `Optional` formula: string \\\| (`alias`: string) => string Inherited from: [ReferenceOptions](core.referenceoptions.md).[formula](core.referenceoptions.md#formula) -Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L49) +Defined in: [packages/core/src/decorators/Property.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L49) ___ ### hidden -• `Optional` hidden: undefined \\\| boolean +• `Optional` hidden: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[hidden](core.referenceoptions.md#hidden) -Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L53) +Defined in: [packages/core/src/decorators/Property.ts:53](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L53) ___ ### index -• `Optional` index: undefined \\\| string \\\| boolean +• `Optional` index: string \\\| boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[index](core.referenceoptions.md#index) -Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L55) +Defined in: [packages/core/src/decorators/Property.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L55) ___ ### inversedBy -• `Optional` inversedBy: undefined \\\| string & keyof T \\\| (`e`: T) => any +• `Optional` inversedBy: string & keyof T \\\| (`e`: T) => any -Defined in: [packages/core/src/decorators/ManyToOne.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L23) +Defined in: [packages/core/src/decorators/ManyToOne.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L23) ___ ### joinColumn -• `Optional` joinColumn: undefined \\\| string +• `Optional` joinColumn: string -Defined in: [packages/core/src/decorators/ManyToOne.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L27) +Defined in: [packages/core/src/decorators/ManyToOne.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L27) ___ ### joinColumns -• `Optional` joinColumns: undefined \\\| string[] +• `Optional` joinColumns: string[] -Defined in: [packages/core/src/decorators/ManyToOne.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L28) +Defined in: [packages/core/src/decorators/ManyToOne.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L28) ___ ### lazy -• `Optional` lazy: undefined \\\| boolean +• `Optional` lazy: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[lazy](core.referenceoptions.md#lazy) -Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L57) +Defined in: [packages/core/src/decorators/Property.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L57) ___ ### length -• `Optional` length: undefined \\\| number +• `Optional` length: number Inherited from: [ReferenceOptions](core.referenceoptions.md).[length](core.referenceoptions.md#length) -Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L44) +Defined in: [packages/core/src/decorators/Property.ts:44](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L44) ___ ### mapToPk -• `Optional` mapToPk: undefined \\\| boolean +• `Optional` mapToPk: boolean -Defined in: [packages/core/src/decorators/ManyToOne.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L26) +Defined in: [packages/core/src/decorators/ManyToOne.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L26) ___ ### name -• `Optional` name: undefined \\\| string +• `Optional` name: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[name](core.referenceoptions.md#name) -Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L38) +Defined in: [packages/core/src/decorators/Property.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L38) ___ ### nullable -• `Optional` nullable: undefined \\\| boolean +• `Optional` nullable: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[nullable](core.referenceoptions.md#nullable) -Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L50) +Defined in: [packages/core/src/decorators/Property.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L50) ___ ### onCreate -• `Optional` onCreate: undefined \\\| (`entity`: O) => any +• `Optional` onCreate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) Inherited from: [ReferenceOptions](core.referenceoptions.md).[onCreate](core.referenceoptions.md#oncreate) -Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L45) +Defined in: [packages/core/src/decorators/Property.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L45) ___ ### onDelete -• `Optional` onDelete: undefined \\\| string +• `Optional` onDelete: string -Defined in: [packages/core/src/decorators/ManyToOne.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L29) +Defined in: [packages/core/src/decorators/ManyToOne.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L29) ___ ### onUpdate -• `Optional` onUpdate: undefined \\\| (`entity`: O) => any +• `Optional` onUpdate: (`entity`: O) => any + +#### Type declaration: + +▸ (`entity`: O): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`entity` \| O \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) Inherited from: [ReferenceOptions](core.referenceoptions.md).[onUpdate](core.referenceoptions.md#onupdate) -Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L46) +Defined in: [packages/core/src/decorators/Property.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L46) ___ ### onUpdateIntegrity -• `Optional` onUpdateIntegrity: undefined \\\| string +• `Optional` onUpdateIntegrity: string -Defined in: [packages/core/src/decorators/ManyToOne.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L30) +Defined in: [packages/core/src/decorators/ManyToOne.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L30) ___ ### persist -• `Optional` persist: undefined \\\| boolean +• `Optional` persist: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[persist](core.referenceoptions.md#persist) -Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L52) +Defined in: [packages/core/src/decorators/Property.ts:52](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L52) ___ ### primary -• `Optional` primary: undefined \\\| boolean +• `Optional` primary: boolean Overrides: [ReferenceOptions](core.referenceoptions.md).[primary](core.referenceoptions.md#primary) -Defined in: [packages/core/src/decorators/ManyToOne.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L25) +Defined in: [packages/core/src/decorators/ManyToOne.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L25) ___ ### serializedName -• `Optional` serializedName: undefined \\\| string +• `Optional` serializedName: string Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializedName](core.referenceoptions.md#serializedname) -Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L61) +Defined in: [packages/core/src/decorators/Property.ts:61](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L61) ___ ### serializedPrimaryKey -• `Optional` serializedPrimaryKey: undefined \\\| boolean +• `Optional` serializedPrimaryKey: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializedPrimaryKey](core.referenceoptions.md#serializedprimarykey) -Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L59) +Defined in: [packages/core/src/decorators/Property.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L59) ___ ### serializer -• `Optional` serializer: undefined \\\| (`value`: any) => any +• `Optional` serializer: (`value`: any) => any + +#### Type declaration: + +▸ (`value`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| any \| + +Returns: any + +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) Inherited from: [ReferenceOptions](core.referenceoptions.md).[serializer](core.referenceoptions.md#serializer) -Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L60) +Defined in: [packages/core/src/decorators/Property.ts:60](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L60) ___ ### strategy -• `Optional` strategy: undefined \\\| [SELECT\\_IN](../enums/core.loadstrategy.md#select_in) \\\| [JOINED](../enums/core.loadstrategy.md#joined) +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) Inherited from: [ReferenceOptions](core.referenceoptions.md).[strategy](core.referenceoptions.md#strategy) -Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L69) +Defined in: [packages/core/src/decorators/Property.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L69) ___ @@ -328,42 +371,42 @@ ___ Inherited from: [ReferenceOptions](core.referenceoptions.md).[type](core.referenceoptions.md#type) -Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L43) +Defined in: [packages/core/src/decorators/Property.ts:43](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L43) ___ ### unique -• `Optional` unique: undefined \\\| string \\\| boolean +• `Optional` unique: string \\\| boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[unique](core.referenceoptions.md#unique) -Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L56) +Defined in: [packages/core/src/decorators/Property.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L56) ___ ### unsigned -• `Optional` unsigned: undefined \\\| boolean +• `Optional` unsigned: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[unsigned](core.referenceoptions.md#unsigned) -Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L51) +Defined in: [packages/core/src/decorators/Property.ts:51](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L51) ___ ### version -• `Optional` version: undefined \\\| boolean +• `Optional` version: boolean Inherited from: [ReferenceOptions](core.referenceoptions.md).[version](core.referenceoptions.md#version) -Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L54) +Defined in: [packages/core/src/decorators/Property.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L54) ___ ### wrappedReference -• `Optional` wrappedReference: undefined \\\| boolean +• `Optional` wrappedReference: boolean -Defined in: [packages/core/src/decorators/ManyToOne.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L24) +Defined in: [packages/core/src/decorators/ManyToOne.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L24) diff --git a/core.matchingoptions.md b/core.matchingoptions.md index 3984215..d59c316 100644 --- a/core.matchingoptions.md +++ b/core.matchingoptions.md @@ -0,0 +1,198 @@ +--- +id: "core.matchingoptions" +title: "Interface: MatchingOptions<T, P>" +sidebar_label: "MatchingOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: MatchingOptions<T, P\\> + +[core](../modules/core.md).MatchingOptions + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`T` \| - \| - \| +`P` \| [Populate](../modules/core.md#populate)<T\\> \| [Populate](../modules/core.md#populate)<T\\> \| + +## Hierarchy + +* [FindOptions](core.findoptions.md)<T, P\\> + + ↳ MatchingOptions + +## Properties + +### cache + +• `Optional` cache: number \\\| boolean \\\| [string, number] + +Inherited from: [FindOptions](core.findoptions.md).[cache](core.findoptions.md#cache) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:85](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L85) + +___ + +### convertCustomTypes + +• `Optional` convertCustomTypes: boolean + +Inherited from: [FindOptions](core.findoptions.md).[convertCustomTypes](core.findoptions.md#convertcustomtypes) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L89) + +___ + +### ctx + +• `Optional` ctx: any + +Defined in: [packages/core/src/entity/Collection.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L13) + +___ + +### disableIdentityMap + +• `Optional` disableIdentityMap: boolean + +Inherited from: [FindOptions](core.findoptions.md).[disableIdentityMap](core.findoptions.md#disableidentitymap) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L90) + +___ + +### fields + +• `Optional` fields: (string \\\| [FieldsMap](../modules/core.md#fieldsmap))[] + +Inherited from: [FindOptions](core.findoptions.md).[fields](core.findoptions.md#fields) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L91) + +___ + +### filters + +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> + +Inherited from: [FindOptions](core.findoptions.md).[filters](core.findoptions.md#filters) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L97) + +___ + +### flags + +• `Optional` flags: [QueryFlag](../enums/core.queryflag.md)[] + +Inherited from: [FindOptions](core.findoptions.md).[flags](core.findoptions.md#flags) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L93) + +___ + +### groupBy + +• `Optional` groupBy: string \\\| string[] + +Inherited from: [FindOptions](core.findoptions.md).[groupBy](core.findoptions.md#groupby) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L94) + +___ + +### having + +• `Optional` having: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> + +Inherited from: [FindOptions](core.findoptions.md).[having](core.findoptions.md#having) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L95) + +___ + +### limit + +• `Optional` limit: number + +Inherited from: [FindOptions](core.findoptions.md).[limit](core.findoptions.md#limit) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L86) + +___ + +### offset + +• `Optional` offset: number + +Inherited from: [FindOptions](core.findoptions.md).[offset](core.findoptions.md#offset) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L87) + +___ + +### orderBy + +• `Optional` orderBy: [QueryOrderMap](core.queryordermap.md) + +Inherited from: [FindOptions](core.findoptions.md).[orderBy](core.findoptions.md#orderby) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:84](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L84) + +___ + +### populate + +• `Optional` populate: P + +Inherited from: [FindOptions](core.findoptions.md).[populate](core.findoptions.md#populate) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:83](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L83) + +___ + +### refresh + +• `Optional` refresh: boolean + +Inherited from: [FindOptions](core.findoptions.md).[refresh](core.findoptions.md#refresh) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L88) + +___ + +### schema + +• `Optional` schema: string + +Inherited from: [FindOptions](core.findoptions.md).[schema](core.findoptions.md#schema) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L92) + +___ + +### store + +• `Optional` store: boolean + +Defined in: [packages/core/src/entity/Collection.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L12) + +___ + +### strategy + +• `Optional` strategy: [LoadStrategy](../enums/core.loadstrategy.md) + +Inherited from: [FindOptions](core.findoptions.md).[strategy](core.findoptions.md#strategy) + +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L96) + +___ + +### where + +• `Optional` where: [FilterQuery](../modules/core.md#filterquery)<T\\> + +Defined in: [packages/core/src/entity/Collection.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Collection.ts#L11) diff --git a/core.migrationobject.md b/core.migrationobject.md index 80cde70..fad9653 100644 --- a/core.migrationobject.md +++ b/core.migrationobject.md @@ -2,6 +2,7 @@ id: "core.migrationobject" title: "Interface: MigrationObject" sidebar_label: "MigrationObject" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [core](../modules/core.md).MigrationObject -## Hierarchy - -* MigrationObject - ## Properties ### class • class: [Constructor](../modules/core.md#constructor)<Migration\\> -Defined in: [packages/core/src/typings.ts:355](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L355) +Defined in: [packages/core/src/typings.ts:355](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L355) ___ @@ -27,4 +24,4 @@ ___ • name: string -Defined in: [packages/core/src/typings.ts:354](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L354) +Defined in: [packages/core/src/typings.ts:354](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L354) diff --git a/core.namingstrategy.md b/core.namingstrategy.md index b223713..19e43cd 100644 --- a/core.namingstrategy.md +++ b/core.namingstrategy.md @@ -2,6 +2,7 @@ id: "core.namingstrategy" title: "Interface: NamingStrategy" sidebar_label: "NamingStrategy" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).NamingStrategy -## Hierarchy - -* NamingStrategy - ## Implemented by * [AbstractNamingStrategy](../classes/core.abstractnamingstrategy.md) @@ -28,12 +25,12 @@ Return a migration name. This name should allow ordering. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `timestamp` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L16) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L16) ___ @@ -46,12 +43,12 @@ Return a table name for an entity class #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L11) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L11) ___ @@ -64,13 +61,13 @@ Return a name of the class based on its file name #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `file` \| string \| `separator?` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L6) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L6) ___ @@ -83,12 +80,12 @@ Return a join column name for a property #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L31) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L31) ___ @@ -101,14 +98,14 @@ Return the foreign key column name for the given parameters #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entityName` \| string \| `referencedColumnName?` \| string \| `composite?` \| boolean \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L41) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L41) ___ @@ -121,14 +118,14 @@ Return a join table name #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sourceEntity` \| string \| `targetEntity` \| string \| `propertyName` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L36) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L36) ___ @@ -141,12 +138,12 @@ Return a column name for a property #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `propertyName` \| string \| Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L21) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L21) ___ @@ -158,4 +155,4 @@ Return the default reference column name Returns: string -Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/naming-strategy/NamingStrategy.ts#L26) +Defined in: [packages/core/src/naming-strategy/NamingStrategy.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/naming-strategy/NamingStrategy.ts#L26) diff --git a/core.node.md b/core.node.md index 68ea674..d565bd1 100644 --- a/core.node.md +++ b/core.node.md @@ -2,6 +2,7 @@ id: "core.node" title: "Interface: Node" sidebar_label: "Node" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [core](../modules/core.md).Node -## Hierarchy - -* Node - ## Properties ### dependencies • dependencies: [Dictionary](../modules/core.md#dictionary)<[Edge](core.edge.md)\\> -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L13) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L13) ___ @@ -27,7 +24,7 @@ ___ • hash: string -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L11) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L11) ___ @@ -35,4 +32,4 @@ ___ • state: [NodeState](../enums/core.nodestate.md) -Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L12) +Defined in: [packages/core/src/unit-of-work/CommitOrderCalculator.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/unit-of-work/CommitOrderCalculator.ts#L12) diff --git a/core.queryordermap.md b/core.queryordermap.md index d89ff48..4b9c8f4 100644 --- a/core.queryordermap.md +++ b/core.queryordermap.md @@ -2,6 +2,7 @@ id: "core.queryordermap" title: "Interface: QueryOrderMap" sidebar_label: "QueryOrderMap" +custom_edit_url: null hide_title: true --- @@ -9,10 +10,6 @@ hide_title: true [core](../modules/core.md).QueryOrderMap -## Hierarchy - -* QueryOrderMap - ## Indexable ▪ [x: string]: [QueryOrderKeys](../modules/core.md#queryorderkeys) diff --git a/core.queryresult.md b/core.queryresult.md index 394b93c..8e8c9cd 100644 --- a/core.queryresult.md +++ b/core.queryresult.md @@ -2,6 +2,7 @@ id: "core.queryresult" title: "Interface: QueryResult" sidebar_label: "QueryResult" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [core](../modules/core.md).QueryResult -## Hierarchy - -* QueryResult - ## Properties ### affectedRows • affectedRows: number -Defined in: [packages/core/src/connections/Connection.ts:127](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L127) +Defined in: [packages/core/src/connections/Connection.ts:127](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L127) ___ @@ -27,20 +24,20 @@ ___ • insertId: number -Defined in: [packages/core/src/connections/Connection.ts:128](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L128) +Defined in: [packages/core/src/connections/Connection.ts:128](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L128) ___ ### row -• `Optional` row: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\> +• `Optional` row: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/connections/Connection.ts:129](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L129) +Defined in: [packages/core/src/connections/Connection.ts:129](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L129) ___ ### rows -• `Optional` rows: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\>[] +• `Optional` rows: [Dictionary](../modules/core.md#dictionary)<any\\>[] -Defined in: [packages/core/src/connections/Connection.ts:130](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L130) +Defined in: [packages/core/src/connections/Connection.ts:130](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L130) diff --git a/core.transactioneventargs.md b/core.transactioneventargs.md index aaf4666..665123d 100644 --- a/core.transactioneventargs.md +++ b/core.transactioneventargs.md @@ -2,6 +2,7 @@ id: "core.transactioneventargs" title: "Interface: TransactionEventArgs" sidebar_label: "TransactionEventArgs" +custom_edit_url: null hide_title: true --- @@ -11,7 +12,7 @@ hide_title: true ## Hierarchy -* Omit<[EventArgs](core.eventargs.md)<unknown\\>, entity \\\| changeSet\\> +* Omit<[EventArgs](core.eventargs.md)<unknown\\>, entity \\\| changeSet\\> ↳ TransactionEventArgs @@ -21,7 +22,9 @@ hide_title: true • em: [EntityManager](../classes/core.entitymanager.md)<[IDatabaseDriver](core.idatabasedriver.md)<[Connection](../classes/core.connection.md)\\>\\> -Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L8) +Inherited from: void + +Defined in: [packages/core/src/events/EventSubscriber.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L8) ___ @@ -29,12 +32,12 @@ ___ • `Optional` transaction: any -Defined in: [packages/core/src/events/EventSubscriber.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L17) +Defined in: [packages/core/src/events/EventSubscriber.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L17) ___ ### uow -• `Optional` uow: undefined \\\| [UnitOfWork](../classes/core.unitofwork.md) +• `Optional` uow: [UnitOfWork](../classes/core.unitofwork.md) -Defined in: [packages/core/src/events/EventSubscriber.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/events/EventSubscriber.ts#L18) +Defined in: [packages/core/src/events/EventSubscriber.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/events/EventSubscriber.ts#L18) diff --git a/core.uniqueoptions.md b/core.uniqueoptions.md index c050c34..3d240c6 100644 --- a/core.uniqueoptions.md +++ b/core.uniqueoptions.md @@ -2,6 +2,7 @@ id: "core.uniqueoptions" title: "Interface: UniqueOptions<T>" sidebar_label: "UniqueOptions" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](../modules/core.md#anyentity)<T\\> \| ## Hierarchy @@ -25,22 +26,22 @@ Name \| Type \| ### name -• `Optional` name: undefined \\\| string +• `Optional` name: string -Defined in: [packages/core/src/decorators/Indexed.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L29) +Defined in: [packages/core/src/decorators/Indexed.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L29) ___ ### options -• `Optional` options: undefined \\\| [Dictionary](../modules/core.md#dictionary)<any\\> +• `Optional` options: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/core/src/decorators/Indexed.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L31) +Defined in: [packages/core/src/decorators/Indexed.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L31) ___ ### properties -• `Optional` properties: undefined \\\| keyof T \\\| keyof T[] +• `Optional` properties: keyof T \\\| keyof T[] -Defined in: [packages/core/src/decorators/Indexed.ts:30](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L30) +Defined in: [packages/core/src/decorators/Indexed.ts:30](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L30) diff --git a/core.updateoptions.md b/core.updateoptions.md index cba0b05..bee416c 100644 --- a/core.updateoptions.md +++ b/core.updateoptions.md @@ -2,6 +2,7 @@ id: "core.updateoptions" title: "Interface: UpdateOptions<T>" sidebar_label: "UpdateOptions" +custom_edit_url: null hide_title: true --- @@ -12,17 +13,13 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| -## Hierarchy - -* UpdateOptions - ## Properties ### filters -• `Optional` filters: undefined \\\| boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> +• `Optional` filters: boolean \\\| string[] \\\| [Dictionary](../modules/core.md#dictionary)<boolean \\\| [Dictionary](../modules/core.md#dictionary)<any\\>\\> -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L118) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L118) diff --git a/knex.column.md b/knex.column.md index 313baa0..0ba2ec1 100644 --- a/knex.column.md +++ b/knex.column.md @@ -2,6 +2,7 @@ id: "knex.column" title: "Interface: Column" sidebar_label: "Column" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).Column -## Hierarchy - -* Column - ## Properties ### defaultValue • defaultValue: null \\\| string -Defined in: [packages/knex/src/typings.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L40) +Defined in: [packages/knex/src/typings.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L40) ___ @@ -27,7 +24,7 @@ ___ • enumItems: string[] -Defined in: [packages/knex/src/typings.ts:41](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L41) +Defined in: [packages/knex/src/typings.ts:41](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L41) ___ @@ -35,7 +32,7 @@ ___ • fk: [ForeignKey](knex.foreignkey.md) -Defined in: [packages/knex/src/typings.ts:33](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L33) +Defined in: [packages/knex/src/typings.ts:33](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L33) ___ @@ -43,7 +40,7 @@ ___ • fks: [ForeignKey](knex.foreignkey.md)[] -Defined in: [packages/knex/src/typings.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L34) +Defined in: [packages/knex/src/typings.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L34) ___ @@ -51,7 +48,7 @@ ___ • indexes: [Index](knex.index.md)[] -Defined in: [packages/knex/src/typings.ts:35](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L35) +Defined in: [packages/knex/src/typings.ts:35](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L35) ___ @@ -59,7 +56,7 @@ ___ • maxLength: number -Defined in: [packages/knex/src/typings.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L39) +Defined in: [packages/knex/src/typings.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L39) ___ @@ -67,7 +64,7 @@ ___ • name: string -Defined in: [packages/knex/src/typings.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L31) +Defined in: [packages/knex/src/typings.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L31) ___ @@ -75,7 +72,7 @@ ___ • nullable: boolean -Defined in: [packages/knex/src/typings.ts:38](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L38) +Defined in: [packages/knex/src/typings.ts:38](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L38) ___ @@ -83,7 +80,7 @@ ___ • primary: boolean -Defined in: [packages/knex/src/typings.ts:36](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L36) +Defined in: [packages/knex/src/typings.ts:36](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L36) ___ @@ -91,7 +88,7 @@ ___ • type: string -Defined in: [packages/knex/src/typings.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L32) +Defined in: [packages/knex/src/typings.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L32) ___ @@ -99,4 +96,4 @@ ___ • unique: boolean -Defined in: [packages/knex/src/typings.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L37) +Defined in: [packages/knex/src/typings.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L37) diff --git a/knex.foreignkey.md b/knex.foreignkey.md index af4f96a..d1bee22 100644 --- a/knex.foreignkey.md +++ b/knex.foreignkey.md @@ -2,6 +2,7 @@ id: "knex.foreignkey" title: "Interface: ForeignKey" sidebar_label: "ForeignKey" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).ForeignKey -## Hierarchy - -* ForeignKey - ## Properties ### columnName • columnName: string -Defined in: [packages/knex/src/typings.ts:45](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L45) +Defined in: [packages/knex/src/typings.ts:45](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L45) ___ @@ -27,7 +24,7 @@ ___ • constraintName: string -Defined in: [packages/knex/src/typings.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L46) +Defined in: [packages/knex/src/typings.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L46) ___ @@ -35,7 +32,7 @@ ___ • deleteRule: string -Defined in: [packages/knex/src/typings.ts:50](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L50) +Defined in: [packages/knex/src/typings.ts:50](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L50) ___ @@ -43,7 +40,7 @@ ___ • referencedColumnName: string -Defined in: [packages/knex/src/typings.ts:48](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L48) +Defined in: [packages/knex/src/typings.ts:48](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L48) ___ @@ -51,7 +48,7 @@ ___ • referencedTableName: string -Defined in: [packages/knex/src/typings.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L47) +Defined in: [packages/knex/src/typings.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L47) ___ @@ -59,4 +56,4 @@ ___ • updateRule: string -Defined in: [packages/knex/src/typings.ts:49](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L49) +Defined in: [packages/knex/src/typings.ts:49](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L49) diff --git a/knex.icriterianode.md b/knex.icriterianode.md index da93575..81305e7 100644 --- a/knex.icriterianode.md +++ b/knex.icriterianode.md @@ -2,6 +2,7 @@ id: "knex.icriterianode" title: "Interface: ICriteriaNode" sidebar_label: "ICriteriaNode" +custom_edit_url: null hide_title: true --- @@ -9,33 +10,29 @@ hide_title: true [knex](../modules/knex.md).ICriteriaNode -## Hierarchy - -* ICriteriaNode - ## Properties ### entityName • `Readonly` entityName: string -Defined in: [packages/knex/src/typings.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L115) +Defined in: [packages/knex/src/typings.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L115) ___ ### key -• `Optional` `Readonly` key: undefined \\\| string +• `Optional` `Readonly` key: string -Defined in: [packages/knex/src/typings.ts:117](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L117) +Defined in: [packages/knex/src/typings.ts:117](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L117) ___ ### parent -• `Optional` `Readonly` parent: undefined \\\| [ICriteriaNode](knex.icriterianode.md) +• `Optional` `Readonly` parent: [ICriteriaNode](knex.icriterianode.md) -Defined in: [packages/knex/src/typings.ts:116](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L116) +Defined in: [packages/knex/src/typings.ts:116](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L116) ___ @@ -43,15 +40,15 @@ ___ • payload: any -Defined in: [packages/knex/src/typings.ts:118](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L118) +Defined in: [packages/knex/src/typings.ts:118](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L118) ___ ### prop -• `Optional` prop: undefined \\\| [EntityProperty](core.entityproperty.md)<any\\> +• `Optional` prop: [EntityProperty](core.entityproperty.md)<any\\> -Defined in: [packages/knex/src/typings.ts:119](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L119) +Defined in: [packages/knex/src/typings.ts:119](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L119) ## Methods @@ -61,7 +58,7 @@ Defined in: [packages/knex/src/typings.ts:119](https://github.com/mikro-orm/mikr Returns: string -Defined in: [packages/knex/src/typings.ts:125](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L125) +Defined in: [packages/knex/src/typings.ts:125](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L125) ___ @@ -72,12 +69,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: string -Defined in: [packages/knex/src/typings.ts:126](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L126) +Defined in: [packages/knex/src/typings.ts:126](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L126) ___ @@ -88,19 +85,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| Returns: any -Defined in: [packages/knex/src/typings.ts:120](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L120) +Defined in: [packages/knex/src/typings.ts:120](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L120) ___ @@ -111,18 +108,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](knex.iquerybuilder.md)<T\\> \| Returns: string -Defined in: [packages/knex/src/typings.ts:124](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L124) +Defined in: [packages/knex/src/typings.ts:124](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L124) ___ @@ -133,12 +130,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean -Defined in: [packages/knex/src/typings.ts:121](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L121) +Defined in: [packages/knex/src/typings.ts:121](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L121) ___ @@ -149,12 +146,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `payload` \| any \| Returns: boolean -Defined in: [packages/knex/src/typings.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L123) +Defined in: [packages/knex/src/typings.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L123) ___ @@ -165,16 +162,16 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `qb` \| [IQueryBuilder](knex.iquerybuilder.md)<T\\> \| `alias?` \| string \| Returns: boolean -Defined in: [packages/knex/src/typings.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L122) +Defined in: [packages/knex/src/typings.ts:122](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L122) diff --git a/knex.index.md b/knex.index.md index 09dca6e..1f7ffa6 100644 --- a/knex.index.md +++ b/knex.index.md @@ -2,6 +2,7 @@ id: "knex.index" title: "Interface: Index" sidebar_label: "Index" +custom_edit_url: null hide_title: true --- @@ -9,25 +10,21 @@ hide_title: true [knex](../modules/knex.md).Index -## Hierarchy - -* Index - ## Properties ### columnName • columnName: string -Defined in: [packages/knex/src/typings.ts:54](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L54) +Defined in: [packages/knex/src/typings.ts:54](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L54) ___ ### composite -• `Optional` composite: undefined \\\| boolean +• `Optional` composite: boolean -Defined in: [packages/knex/src/typings.ts:58](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L58) +Defined in: [packages/knex/src/typings.ts:58](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L58) ___ @@ -35,7 +32,7 @@ ___ • keyName: string -Defined in: [packages/knex/src/typings.ts:55](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L55) +Defined in: [packages/knex/src/typings.ts:55](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L55) ___ @@ -43,7 +40,7 @@ ___ • primary: boolean -Defined in: [packages/knex/src/typings.ts:57](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L57) +Defined in: [packages/knex/src/typings.ts:57](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L57) ___ @@ -51,4 +48,4 @@ ___ • unique: boolean -Defined in: [packages/knex/src/typings.ts:56](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L56) +Defined in: [packages/knex/src/typings.ts:56](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L56) diff --git a/knex.indexdef.md b/knex.indexdef.md index 6632a12..ddff7e2 100644 --- a/knex.indexdef.md +++ b/knex.indexdef.md @@ -2,6 +2,7 @@ id: "knex.indexdef" title: "Interface: IndexDef" sidebar_label: "IndexDef" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).IndexDef -## Hierarchy - -* IndexDef - ## Properties ### columnNames • columnNames: string[] -Defined in: [packages/knex/src/typings.ts:63](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L63) +Defined in: [packages/knex/src/typings.ts:63](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L63) ___ @@ -27,7 +24,7 @@ ___ • keyName: string -Defined in: [packages/knex/src/typings.ts:62](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L62) +Defined in: [packages/knex/src/typings.ts:62](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L62) ___ @@ -35,4 +32,4 @@ ___ • unique: boolean -Defined in: [packages/knex/src/typings.ts:64](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L64) +Defined in: [packages/knex/src/typings.ts:64](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L64) diff --git a/knex.iquerybuilder.md b/knex.iquerybuilder.md index 39cee96..7f0e659 100644 --- a/knex.iquerybuilder.md +++ b/knex.iquerybuilder.md @@ -2,6 +2,7 @@ id: "knex.iquerybuilder" title: "Interface: IQueryBuilder<T>" sidebar_label: "IQueryBuilder" +custom_edit_url: null hide_title: true --- @@ -12,20 +13,16 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `T` \| -## Hierarchy - -* IQueryBuilder - ## Properties ### \\_fields -• `Optional` \\_fields: undefined \\\| [Field](../modules/knex.md#field)<T\\>[] +• `Optional` \\_fields: [Field](../modules/knex.md#field)<T\\>[] -Defined in: [packages/knex/src/typings.ts:88](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L88) +Defined in: [packages/knex/src/typings.ts:88](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L88) ___ @@ -33,7 +30,7 @@ ___ • `Readonly` alias: string -Defined in: [packages/knex/src/typings.ts:86](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L86) +Defined in: [packages/knex/src/typings.ts:86](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L86) ___ @@ -41,7 +38,7 @@ ___ • `Readonly` type: [QueryType](../enums/knex.querytype.md) -Defined in: [packages/knex/src/typings.ts:87](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L87) +Defined in: [packages/knex/src/typings.ts:87](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L87) ## Methods @@ -52,41 +49,41 @@ Defined in: [packages/knex/src/typings.ts:87](https://github.com/mikro-orm/mikro #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fields` \| string \\\| string[] \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:90](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L90) +Defined in: [packages/knex/src/typings.ts:90](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L90) ___ ### andWhere -▸ andWhere(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>): [IQueryBuilder](knex.iquerybuilder.md)<T\\> +▸ andWhere(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:103](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L103) +Defined in: [packages/knex/src/typings.ts:103](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L103) ▸ andWhere(`cond`: string, `params?`: any[]): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:104](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L104) +Defined in: [packages/knex/src/typings.ts:104](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L104) ___ @@ -97,13 +94,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field?` \| string \\\| string[] \| `distinct?` \| boolean \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:95](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L95) +Defined in: [packages/knex/src/typings.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L95) ___ @@ -114,12 +111,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond?` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:93](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L93) +Defined in: [packages/knex/src/typings.ts:93](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L93) ___ @@ -130,12 +127,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `path` \| string \| Returns: undefined \\\| string -Defined in: [packages/knex/src/typings.ts:110](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L110) +Defined in: [packages/knex/src/typings.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L110) ___ @@ -146,12 +143,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `prefix?` \| string \| Returns: string -Defined in: [packages/knex/src/typings.ts:111](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L111) +Defined in: [packages/knex/src/typings.ts:111](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L111) ___ @@ -162,12 +159,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `fields` \| string \\\| keyof T \\\| (string \\\| keyof T)[] \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:108](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L108) +Defined in: [packages/knex/src/typings.ts:108](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L108) ___ @@ -178,13 +175,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond?` \| any \| `params?` \| any[] \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:109](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L109) +Defined in: [packages/knex/src/typings.ts:109](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L109) ___ @@ -195,12 +192,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:91](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L91) +Defined in: [packages/knex/src/typings.ts:91](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L91) ___ @@ -211,7 +208,7 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| `alias` \| string \| `cond?` \| any \| @@ -220,7 +217,7 @@ Name \| Type \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:96](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L96) +Defined in: [packages/knex/src/typings.ts:96](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L96) ___ @@ -231,14 +228,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| `alias` \| string \| `cond?` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:98](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L98) +Defined in: [packages/knex/src/typings.ts:98](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L98) ___ @@ -249,14 +246,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| `alias` \| string \| `cond?` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:97](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L97) +Defined in: [packages/knex/src/typings.ts:97](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L97) ___ @@ -267,43 +264,43 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `field` \| string \| `alias` \| string \| `cond?` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:99](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L99) +Defined in: [packages/knex/src/typings.ts:99](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L99) ___ ### orWhere -▸ orWhere(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>): [IQueryBuilder](knex.iquerybuilder.md)<T\\> +▸ orWhere(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:105](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L105) +Defined in: [packages/knex/src/typings.ts:105](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L105) ▸ orWhere(`cond`: string, `params?`: any[]): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:106](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L106) +Defined in: [packages/knex/src/typings.ts:106](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L106) ___ @@ -314,29 +311,29 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `orderBy` \| [QueryOrderMap](core.queryordermap.md) \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:107](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L107) +Defined in: [packages/knex/src/typings.ts:107](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L107) ___ ### select -▸ select(`fields`: string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[], `distinct?`: boolean): [IQueryBuilder](knex.iquerybuilder.md)<T\\> +▸ select(`fields`: [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[], `distinct?`: boolean): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`fields` \| string \\\| [KnexStringRef](../modules/knex.md#knexstringref) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| keyof T \\\| [Field](../modules/knex.md#field)<T\\>[] \| +:------ \| :------ \| +`fields` \| [Field](../modules/knex.md#field)<T\\> \\\| [Field](../modules/knex.md#field)<T\\>[] \| `distinct?` \| boolean \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:89](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L89) +Defined in: [packages/knex/src/typings.ts:89](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L89) ___ @@ -346,7 +343,7 @@ ___ Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:94](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L94) +Defined in: [packages/knex/src/typings.ts:94](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L94) ___ @@ -357,57 +354,57 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `data` \| any \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:92](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L92) +Defined in: [packages/knex/src/typings.ts:92](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L92) ___ ### where -▸ where(`cond`: [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\>, `operator?`: $and \\\| $or): [IQueryBuilder](knex.iquerybuilder.md)<T\\> +▸ where(`cond`: [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\>, `operator?`: $and \\\| $or): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`cond` \| [QBFilterQuery](../modules/core.md#qbfilterquery)<T\\> \| +:------ \| :------ \| +`cond` \| [FilterQuery](../modules/core.md#filterquery)<T\\> \\\| [FilterQuery](../modules/core.md#filterquery)<T\\> & [Dictionary](../modules/core.md#dictionary)<any\\> \| `operator?` \| $and \\\| $or \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:101](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L101) +Defined in: [packages/knex/src/typings.ts:101](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L101) ▸ where(`cond`: string, `params?`: any[], `operator?`: $and \\\| $or): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `cond` \| string \| `params?` \| any[] \| `operator?` \| $and \\\| $or \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:102](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L102) +Defined in: [packages/knex/src/typings.ts:102](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L102) ___ ### withSubQuery -▸ withSubQuery(`subQuery`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\>, `alias`: string): [IQueryBuilder](knex.iquerybuilder.md)<T\\> +▸ withSubQuery(`subQuery`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>, `alias`: string): [IQueryBuilder](knex.iquerybuilder.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`subQuery` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \| +:------ \| :------ \| +`subQuery` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \| `alias` \| string \| Returns: [IQueryBuilder](knex.iquerybuilder.md)<T\\> -Defined in: [packages/knex/src/typings.ts:100](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L100) +Defined in: [packages/knex/src/typings.ts:100](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L100) diff --git a/knex.joinoptions.md b/knex.joinoptions.md index 00741d0..a0fdee7 100644 --- a/knex.joinoptions.md +++ b/knex.joinoptions.md @@ -2,6 +2,7 @@ id: "knex.joinoptions" title: "Interface: JoinOptions" sidebar_label: "JoinOptions" +custom_edit_url: null hide_title: true --- @@ -9,49 +10,45 @@ hide_title: true [knex](../modules/knex.md).JoinOptions -## Hierarchy - -* JoinOptions - ## Properties ### alias • alias: string -Defined in: [packages/knex/src/typings.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L19) +Defined in: [packages/knex/src/typings.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L19) ___ ### cond -• cond: [Dictionary](../modules/core.md#dictionary)<any\\> +• cond: [Dictionary](../modules/core.md#dictionary)<any\\> -Defined in: [packages/knex/src/typings.ts:27](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L27) +Defined in: [packages/knex/src/typings.ts:27](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L27) ___ ### inverseAlias -• `Optional` inverseAlias: undefined \\\| string +• `Optional` inverseAlias: string -Defined in: [packages/knex/src/typings.ts:21](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L21) +Defined in: [packages/knex/src/typings.ts:21](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L21) ___ ### inverseJoinColumns -• `Optional` inverseJoinColumns: undefined \\\| string[] +• `Optional` inverseJoinColumns: string[] -Defined in: [packages/knex/src/typings.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L23) +Defined in: [packages/knex/src/typings.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L23) ___ ### joinColumns -• `Optional` joinColumns: undefined \\\| string[] +• `Optional` joinColumns: string[] -Defined in: [packages/knex/src/typings.ts:22](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L22) +Defined in: [packages/knex/src/typings.ts:22](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L22) ___ @@ -59,31 +56,31 @@ ___ • ownerAlias: string -Defined in: [packages/knex/src/typings.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L20) +Defined in: [packages/knex/src/typings.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L20) ___ ### path -• `Optional` path: undefined \\\| string +• `Optional` path: string -Defined in: [packages/knex/src/typings.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L25) +Defined in: [packages/knex/src/typings.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L25) ___ ### primaryKeys -• `Optional` primaryKeys: undefined \\\| string[] +• `Optional` primaryKeys: string[] -Defined in: [packages/knex/src/typings.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L24) +Defined in: [packages/knex/src/typings.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L24) ___ ### prop -• prop: [EntityProperty](core.entityproperty.md)<any\\> +• prop: [EntityProperty](core.entityproperty.md)<any\\> -Defined in: [packages/knex/src/typings.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L26) +Defined in: [packages/knex/src/typings.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L26) ___ @@ -91,7 +88,7 @@ ___ • table: string -Defined in: [packages/knex/src/typings.ts:17](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L17) +Defined in: [packages/knex/src/typings.ts:17](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L17) ___ @@ -99,4 +96,4 @@ ___ • type: leftJoin \\\| innerJoin \\\| pivotJoin -Defined in: [packages/knex/src/typings.ts:18](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L18) +Defined in: [packages/knex/src/typings.ts:18](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L18) diff --git a/knex.knex-1.aliasdict.md b/knex.knex-1.aliasdict.md index 3a5191d..aa330e3 100644 --- a/knex.knex-1.aliasdict.md +++ b/knex.knex-1.aliasdict.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.aliasdict" +id: "knex.knex-1.aliasdict" title: "Interface: AliasDict" sidebar_label: "AliasDict" +custom_edit_url: null hide_title: true --- @@ -11,6 +12,6 @@ hide_title: true ## Hierarchy -* Dict<string\\> +* Dict<string\\> ↳ AliasDict diff --git a/knex.knex-1.aliasquerybuilder.md b/knex.knex-1.aliasquerybuilder.md index d663fba..2db29de 100644 --- a/knex.knex-1.aliasquerybuilder.md +++ b/knex.knex-1.aliasquerybuilder.md @@ -0,0 +1,102 @@ +--- +id: "knex.knex-1.aliasquerybuilder" +title: "Interface: AliasQueryBuilder<TRecord, TResult>" +sidebar_label: "AliasQueryBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: AliasQueryBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AliasQueryBuilder + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| unknown[] \| + +## Hierarchy + +* AliasQueryBuilder + + ↳ [Select](knex.knex-1.select.md) + +## Callable + +▸ AliasQueryBuilder<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:918 + +▸ AliasQueryBuilder<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:929 + +▸ AliasQueryBuilder<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:941 + +▸ AliasQueryBuilder<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:953 diff --git a/knex.knex-1.altercolumnbuilder.md b/knex.knex-1.altercolumnbuilder.md index 84631c5..6b8b395 100644 --- a/knex.knex-1.altercolumnbuilder.md +++ b/knex.knex-1.altercolumnbuilder.md @@ -0,0 +1,277 @@ +--- +id: "knex.knex-1.altercolumnbuilder" +title: "Interface: AlterColumnBuilder" +sidebar_label: "AlterColumnBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: AlterColumnBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AlterColumnBuilder + +## Hierarchy + +* [ColumnBuilder](knex.knex-1.columnbuilder.md) + + ↳ AlterColumnBuilder + + ↳↳ [MySqlAlterColumnBuilder](knex.knex-1.mysqlaltercolumnbuilder.md) + +## Methods + +### after + +▸ after(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1817 + +___ + +### alter + +▸ alter(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1814 + +___ + +### comment + +▸ comment(`value`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1813 + +___ + +### defaultTo + +▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1809 + +___ + +### first + +▸ first(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1818 + +___ + +### index + +▸ index(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1803 + +___ + +### notNullable + +▸ notNullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1811 + +___ + +### nullable + +▸ nullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1812 + +___ + +### onDelete + +▸ onDelete(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1807 + +___ + +### onUpdate + +▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1808 + +___ + +### primary + +▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1804 + +___ + +### queryContext + +▸ queryContext(`context`: any): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1815 + +___ + +### references + +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1806 + +___ + +### unique + +▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1805 + +___ + +### unsigned + +▸ unsigned(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1810 + +___ + +### withKeyName + +▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`keyName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1816 diff --git a/knex.knex-1.altertablebuilder.md b/knex.knex-1.altertablebuilder.md index 998289e..d5001a1 100644 --- a/knex.knex-1.altertablebuilder.md +++ b/knex.knex-1.altertablebuilder.md @@ -0,0 +1,719 @@ +--- +id: "knex.knex-1.altertablebuilder" +title: "Interface: AlterTableBuilder" +sidebar_label: "AlterTableBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: AlterTableBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AlterTableBuilder + +## Hierarchy + +* [TableBuilder](knex.knex-1.tablebuilder.md) + + ↳ AlterTableBuilder + +## Methods + +### bigIncrements + +▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1723 + +___ + +### bigInteger + +▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1728 + +___ + +### binary + +▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1757 + +___ + +### boolean + +▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1746 + +___ + +### comment + +▸ comment(`val`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1771 + +___ + +### date + +▸ date(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1747 + +___ + +### dateTime + +▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1748 + +___ + +### decimal + +▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| null \\\| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1741 + +___ + +### double + +▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1736 + +___ + +### dropColumn + +▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1724 + +___ + +### dropColumns + +▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| string[] \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1725 + +___ + +### dropForeign + +▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`foreignKeyName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1785 + +___ + +### dropIndex + +▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1788 + +___ + +### dropPrimary + +▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1787 + +___ + +### dropTimestamps + +▸ dropTimestamps(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1789 + +___ + +### dropUnique + +▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1786 + +___ + +### enu + +▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1763 + +___ + +### enum + +▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1758 + +___ + +### float + +▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1731 + +___ + +### foreign + +▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| +`foreignKeyName?` \| string \| + +Returns: [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1780 + +▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly string[] \| +`foreignKeyName?` \| string \| + +Returns: [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1781 + +___ + +### increments + +▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1722 + +___ + +### index + +▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| +`indexType?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1774 + +___ + +### integer + +▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1727 + +___ + +### json + +▸ json(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1768 + +___ + +### jsonb + +▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1769 + +___ + +### primary + +▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`constraintName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1773 + +___ + +### queryContext + +▸ queryContext(`context`: any): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1790 + +___ + +### renameColumn + +▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`from` \| string \| +`to` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1726 + +___ + +### specificType + +▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`type` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1772 + +___ + +### string + +▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1730 + +___ + +### text + +▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`textType?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1729 + +___ + +### time + +▸ time(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1749 + +___ + +### timestamp + +▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1750 + +▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +`deprecated` + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`withoutTz?` \| boolean \| +`precision?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1752 + +___ + +### timestamps + +▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`useTimestampType?` \| boolean \| +`makeDefaultNow?` \| boolean \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1753 + +___ + +### unique + +▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1779 + +___ + +### uuid + +▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1770 diff --git a/knex.knex-1.as.md b/knex.knex-1.as.md index 7c467a4..6805505 100644 --- a/knex.knex-1.as.md +++ b/knex.knex-1.as.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.as" +id: "knex.knex-1.as" title: "Interface: As<TRecord, TResult>" sidebar_label: "As" +custom_edit_url: null hide_title: true --- @@ -12,36 +13,32 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `TRecord` \| `TResult` \| -## Hierarchy - -* As - ## Callable -▸ As(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ As(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| keyof TRecord \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:899 +Defined in: node_modules/knex/types/index.d.ts:900 -▸ As(`columnName`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ As(`columnName`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:900 +Defined in: node_modules/knex/types/index.d.ts:901 diff --git a/knex.knex-1.asymmetricaggregation.md b/knex.knex-1.asymmetricaggregation.md index 2fb3008..a0aebb5 100644 --- a/knex.knex-1.asymmetricaggregation.md +++ b/knex.knex-1.asymmetricaggregation.md @@ -0,0 +1,76 @@ +--- +id: "knex.knex-1.asymmetricaggregation" +title: "Interface: AsymmetricAggregation<TRecord, TResult, TValue>" +sidebar_label: "AsymmetricAggregation" +custom_edit_url: null +hide_title: true +--- + +# Interface: AsymmetricAggregation<TRecord, TResult, TValue\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).AsymmetricAggregation + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| +`TValue` \| any \| + +## Callable + +▸ AsymmetricAggregation<TResult2\\>(...`columnNames`: readonly keyof [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\>, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\>, never\\> : Dict<TValue\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly keyof [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1330 + +▸ AsymmetricAggregation<TAliases, TResult2\\>(`aliases`: TAliases): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TAliases` \| object \| Record<string, string \\\| string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\> \| +`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & { [k in string \\\| number \\\| symbol]?: TValue}, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, { [k in string \\\| number \\\| symbol]?: TValue}, never\\> : { [k in string \\\| number \\\| symbol]?: TValue}\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| TAliases \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1333 + +▸ AsymmetricAggregation<TResult2\\>(...`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\>\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\>, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\>, never\\> : Dict<TValue\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\>\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1337 diff --git a/knex.knex-1.batchinsertbuilder.md b/knex.knex-1.batchinsertbuilder.md index 71ed752..bf1f956 100644 --- a/knex.knex-1.batchinsertbuilder.md +++ b/knex.knex-1.batchinsertbuilder.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.batchinsertbuilder" +id: "knex.knex-1.batchinsertbuilder" title: "Interface: BatchInsertBuilder<TRecord, TResult>" sidebar_label: "BatchInsertBuilder" +custom_edit_url: null hide_title: true --- @@ -12,13 +13,13 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| any \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| `TResult` \| - \| number[] \| ## Hierarchy -* Promise<ResolveResult<TResult\\>\\> +* Promise<ResolveResult<TResult\\>\\> ↳ BatchInsertBuilder @@ -28,39 +29,43 @@ Name \| Type \| Default \| • `Readonly` [Symbol.toStringTag]: string +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 ## Methods ### catch -▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> +▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> Attaches a callback for only the rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| -Returns: Promise<Resolve<TResult\\> \\\| TResult\\> +Returns: Promise<Resolve<TResult\\> \\\| TResult\\> A Promise for the completion of the callback. -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 +Inherited from: void + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 ___ ### finally -▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> +▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback. @@ -68,86 +73,88 @@ resolved value cannot be modified from the callback. #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| -Returns: Promise<Resolve<TResult\\>\\> +Returns: Promise<Resolve<TResult\\>\\> A Promise for the completion of the callback. +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 ___ ### returning -▸ returning(`column`: **): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> +▸ returning(`column`: *): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| \| -Returns:** [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> -Defined in: node_modules/knex/types/index.d.ts:1541 +Defined in: node_modules/knex/types/index.d.ts:1547 -▸ returning<TKey, TResult2\\>(`column`: TKey): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +▸ returning<TKey, TResult2\\>(`column`: TKey): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, true\\\\>[] \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| TKey \| -Returns: [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> -Defined in: node_modules/knex/types/index.d.ts:1542 +Defined in: node_modules/knex/types/index.d.ts:1548 -▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[]): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[]): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `TKey` \| string \| - \| -`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\\\>\\\\>, TKey\\\\>, {}\\\\>, false\\\\>[] \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>, false\\>[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columns` \| readonly TKey[] \| -Returns: [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> -Defined in: node_modules/knex/types/index.d.ts:1552 +Defined in: node_modules/knex/types/index.d.ts:1558 -▸ returning<TResult2\\>(`column`: unknown extends TRecord ? string \\\| readonly string[] : never): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +▸ returning<TResult2\\>(`column`: unknown extends TRecord ? string \\\| readonly string[] : never): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> #### Type parameters: Name \| Default \| ------- \| ------ \| -`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\\\>\\\\>[] \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| unknown extends TRecord ? string \\\| readonly string[] : never \| -Returns: [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult2\\> +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult2\\> -Defined in: node_modules/knex/types/index.d.ts:1562 +Defined in: node_modules/knex/types/index.d.ts:1568 ___ @@ -160,14 +167,14 @@ Attaches callbacks for the resolution and/or rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| -`TResult1` \| Resolve<TResult\\\\> \| +:------ \| :------ \| +`TResult1` \| Resolve<TResult\\> \| `TResult2` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfulfilled?` \| null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| `onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| @@ -175,20 +182,22 @@ Name \| Type \| Description \| A Promise for the completion of which ever callback is executed. -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 +Inherited from: void + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 ___ ### transacting -▸ transacting(`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>): [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult\\> +▸ transacting(`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`trx` \| [Transaction](knex.knex-1.transaction.md)<any, any\\> \| -Returns: [BatchInsertBuilder](knex.knex.batchinsertbuilder.md)<TRecord, TResult\\> +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1539 +Defined in: node_modules/knex/types/index.d.ts:1545 diff --git a/knex.knex-1.chainableinterface.md b/knex.knex-1.chainableinterface.md index 3329a17..fbae58d 100644 --- a/knex.knex-1.chainableinterface.md +++ b/knex.knex-1.chainableinterface.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.chainableinterface" +id: "knex.knex-1.chainableinterface" title: "Interface: ChainableInterface<T>" sidebar_label: "ChainableInterface" +custom_edit_url: null hide_title: true --- @@ -12,22 +13,22 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| ## Hierarchy -* Pick<Promise<T\\>, keyof Promise<T\\> & [ExposedPromiseKeys](../modules/knex.knex-1.md#exposedpromisekeys)\\> +* Pick<Promise<T\\>, keyof Promise<T\\> & [ExposedPromiseKeys](../modules/knex.knex-1.md#exposedpromisekeys)\\> -* [StringTagSupport](knex.knex.stringtagsupport.md) +* [StringTagSupport](knex.knex-1.stringtagsupport.md) ↳ ChainableInterface - ↳↳ [Raw](knex.knex.raw.md) + ↳↳ [Raw](knex.knex-1.raw.md) - ↳↳ [QueryBuilder](../classes/knex.knex.querybuilder.md) + ↳↳ [QueryBuilder](../classes/knex.knex-1.querybuilder.md) - ↳↳ [SchemaBuilder](knex.knex.schemabuilder.md) + ↳↳ [SchemaBuilder](knex.knex-1.schemabuilder.md) ## Properties @@ -35,9 +36,9 @@ Name \| Default \| • `Readonly` [Symbol.toStringTag]: string -Inherited from: [StringTagSupport](knex.knex.stringtagsupport.md).[[Symbol.toStringTag]](knex.knex.stringtagsupport.md#[symbol.tostringtag]) +Inherited from: [StringTagSupport](knex.knex-1.stringtagsupport.md).[[Symbol.toStringTag]](knex.knex-1.stringtagsupport.md#[symbol.tostringtag]) -Defined in: node_modules/knex/types/index.d.ts:1639 +Defined in: node_modules/knex/types/index.d.ts:1645 ## Methods @@ -48,12 +49,12 @@ Defined in: node_modules/knex/types/index.d.ts:1639 #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| Function \| Returns: Promise<T\\> -Defined in: node_modules/knex/types/index.d.ts:1657 +Defined in: node_modules/knex/types/index.d.ts:1663 ___ @@ -66,52 +67,54 @@ Attaches a callback for only the rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| Returns: Promise<T \\\| TResult\\> A Promise for the completion of the callback. -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 +Inherited from: void + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 ___ ### connection -▸ connection(`connection`: any): [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +▸ connection(`connection`: any): [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +Returns: [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> -Defined in: node_modules/knex/types/index.d.ts:1644 +Defined in: node_modules/knex/types/index.d.ts:1650 ___ ### debug -▸ debug(`enabled`: boolean): [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +▸ debug(`enabled`: boolean): [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `enabled` \| boolean \| -Returns: [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +Returns: [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> -Defined in: node_modules/knex/types/index.d.ts:1645 +Defined in: node_modules/knex/types/index.d.ts:1651 ___ @@ -125,30 +128,32 @@ resolved value cannot be modified from the callback. #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| Returns: Promise<T\\> A Promise for the completion of the callback. +Inherited from: void + Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 ___ ### options -▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| -Returns: [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +Returns: [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> -Defined in: node_modules/knex/types/index.d.ts:1643 +Defined in: node_modules/knex/types/index.d.ts:1649 ___ @@ -159,60 +164,60 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| WritableStream<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `writable` \| T \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Defined in: node_modules/knex/types/index.d.ts:1653 +Defined in: node_modules/knex/types/index.d.ts:1659 ___ ### stream -▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Defined in: node_modules/knex/types/index.d.ts:1647 +Defined in: node_modules/knex/types/index.d.ts:1653 -▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Defined in: node_modules/knex/types/index.d.ts:1648 +Defined in: node_modules/knex/types/index.d.ts:1654 ▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Defined in: node_modules/knex/types/index.d.ts:1652 +Defined in: node_modules/knex/types/index.d.ts:1658 ___ @@ -225,14 +230,14 @@ Attaches callbacks for the resolution and/or rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult1` \| T \| `TResult2` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfulfilled?` \| null \\\| (`value`: T) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| `onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| @@ -240,7 +245,9 @@ Name \| Type \| Description \| A Promise for the completion of which ever callback is executed. -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 +Inherited from: void + +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 ___ @@ -250,20 +257,20 @@ ___ Returns: string -Defined in: node_modules/knex/types/index.d.ts:1642 +Defined in: node_modules/knex/types/index.d.ts:1648 ___ ### transacting -▸ transacting(`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>): [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +▸ transacting(`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>): [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`trx` \| [Transaction](knex.knex-1.transaction.md)<any, any\\> \| -Returns: [ChainableInterface](knex.knex.chainableinterface.md)<T\\> +Returns: [ChainableInterface](knex.knex-1.chainableinterface.md)<T\\> -Defined in: node_modules/knex/types/index.d.ts:1646 +Defined in: node_modules/knex/types/index.d.ts:1652 diff --git a/knex.knex-1.columnbuilder.md b/knex.knex-1.columnbuilder.md index 93c76a1..3b3285d 100644 --- a/knex.knex-1.columnbuilder.md +++ b/knex.knex-1.columnbuilder.md @@ -0,0 +1,247 @@ +--- +id: "knex.knex-1.columnbuilder" +title: "Interface: ColumnBuilder" +sidebar_label: "ColumnBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: ColumnBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ColumnBuilder + +## Hierarchy + +* ColumnBuilder + + ↳ [PostgreSqlColumnBuilder](knex.knex-1.postgresqlcolumnbuilder.md) + + ↳ [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + + ↳ [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +## Methods + +### after + +▸ after(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1817 + +___ + +### alter + +▸ alter(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1814 + +___ + +### comment + +▸ comment(`value`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1813 + +___ + +### defaultTo + +▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1809 + +___ + +### first + +▸ first(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1818 + +___ + +### index + +▸ index(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1803 + +___ + +### notNullable + +▸ notNullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1811 + +___ + +### nullable + +▸ nullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1812 + +___ + +### onDelete + +▸ onDelete(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1807 + +___ + +### onUpdate + +▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1808 + +___ + +### primary + +▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1804 + +___ + +### queryContext + +▸ queryContext(`context`: any): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1815 + +___ + +### references + +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1806 + +___ + +### unique + +▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1805 + +___ + +### unsigned + +▸ unsigned(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1810 + +___ + +### withKeyName + +▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`keyName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1816 diff --git a/knex.knex-1.columninfo.md b/knex.knex-1.columninfo.md index f0f75d7..5a46446 100644 --- a/knex.knex-1.columninfo.md +++ b/knex.knex-1.columninfo.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.columninfo" +id: "knex.knex-1.columninfo" title: "Interface: ColumnInfo" sidebar_label: "ColumnInfo" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ColumnInfo -## Hierarchy - -* ColumnInfo - ## Properties ### defaultValue • defaultValue: [Value](../modules/knex.knex-1.md#value) -Defined in: node_modules/knex/types/index.d.ts:1843 +Defined in: node_modules/knex/types/index.d.ts:1849 ___ @@ -27,7 +24,7 @@ ___ • maxLength: number -Defined in: node_modules/knex/types/index.d.ts:1845 +Defined in: node_modules/knex/types/index.d.ts:1851 ___ @@ -35,7 +32,7 @@ ___ • nullable: boolean -Defined in: node_modules/knex/types/index.d.ts:1846 +Defined in: node_modules/knex/types/index.d.ts:1852 ___ @@ -43,4 +40,4 @@ ___ • type: string -Defined in: node_modules/knex/types/index.d.ts:1844 +Defined in: node_modules/knex/types/index.d.ts:1850 diff --git a/knex.knex-1.columnnamequerybuilder.md b/knex.knex-1.columnnamequerybuilder.md index 7ea1506..0842e39 100644 --- a/knex.knex-1.columnnamequerybuilder.md +++ b/knex.knex-1.columnnamequerybuilder.md @@ -0,0 +1,116 @@ +--- +id: "knex.knex-1.columnnamequerybuilder" +title: "Interface: ColumnNameQueryBuilder<TRecord, TResult>" +sidebar_label: "ColumnNameQueryBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: ColumnNameQueryBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ColumnNameQueryBuilder + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* ColumnNameQueryBuilder + + ↳ [Select](knex.knex-1.select.md) + + ↳ [Distinct](knex.knex-1.distinct.md) + + ↳ [GroupBy](knex.knex-1.groupby.md) + +## Callable + +▸ ColumnNameQueryBuilder(`columnName`: **): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:1434 + +▸ ColumnNameQueryBuilder<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1440 + +▸ ColumnNameQueryBuilder<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1451 + +▸ ColumnNameQueryBuilder<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1462 + +▸ ColumnNameQueryBuilder<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1474 diff --git a/knex.knex-1.config.md b/knex.knex-1.config.md index e99e8bc..3f50853 100644 --- a/knex.knex-1.config.md +++ b/knex.knex-1.config.md @@ -0,0 +1,168 @@ +--- +id: "knex.knex-1.config" +title: "Interface: Config<SV>" +sidebar_label: "Config" +custom_edit_url: null +hide_title: true +--- + +# Interface: Config<SV\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Config + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`SV` \| object \| any \| + +## Properties + +### acquireConnectionTimeout + +• `Optional` acquireConnectionTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1870 + +___ + +### asyncStackTraces + +• `Optional` asyncStackTraces: boolean + +Defined in: node_modules/knex/types/index.d.ts:1873 + +___ + +### client + +• `Optional` client: string \\\| typeof [Client](../classes/knex.knex-1.client.md) + +Defined in: node_modules/knex/types/index.d.ts:1857 + +___ + +### connection + +• `Optional` connection: string \\\| [StaticConnectionConfig](../modules/knex.knex-1.md#staticconnectionconfig) \\\| [ConnectionConfigProvider](../modules/knex.knex-1.md#connectionconfigprovider) + +Defined in: node_modules/knex/types/index.d.ts:1860 + +___ + +### debug + +• `Optional` debug: boolean + +Defined in: node_modules/knex/types/index.d.ts:1856 + +___ + +### dialect + +• `Optional` dialect: string + +Defined in: node_modules/knex/types/index.d.ts:1858 + +___ + +### log + +• `Optional` log: [Logger](knex.knex-1.logger.md) + +Defined in: node_modules/knex/types/index.d.ts:1874 + +___ + +### migrations + +• `Optional` migrations: [MigratorConfig](knex.knex-1.migratorconfig.md) + +Defined in: node_modules/knex/types/index.d.ts:1862 + +___ + +### pool + +• `Optional` pool: [PoolConfig](knex.knex-1.poolconfig.md) + +Defined in: node_modules/knex/types/index.d.ts:1861 + +___ + +### postProcessResponse + +• `Optional` postProcessResponse: (`result`: any, `queryContext`: any) => any + +#### Type declaration: + +▸ (`result`: any, `queryContext`: any): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`result` \| any \| +`queryContext` \| any \| + +Returns: any + +Defined in: node_modules/knex/types/index.d.ts:1863 + +Defined in: node_modules/knex/types/index.d.ts:1863 + +___ + +### searchPath + +• `Optional` searchPath: string \\\| readonly string[] + +Defined in: node_modules/knex/types/index.d.ts:1872 + +___ + +### seeds + +• `Optional` seeds: [SeederConfig](knex.knex-1.seederconfig.md)<SV\\> + +Defined in: node_modules/knex/types/index.d.ts:1869 + +___ + +### useNullAsDefault + +• `Optional` useNullAsDefault: boolean + +Defined in: node_modules/knex/types/index.d.ts:1871 + +___ + +### version + +• `Optional` version: string + +Defined in: node_modules/knex/types/index.d.ts:1859 + +___ + +### wrapIdentifier + +• `Optional` wrapIdentifier: (`value`: string, `origImpl`: (`value`: string) => string, `queryContext`: any) => string + +#### Type declaration: + +▸ (`value`: string, `origImpl`: (`value`: string) => string, `queryContext`: any): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| +`origImpl` \| (`value`: string) => string \| +`queryContext` \| any \| + +Returns: string + +Defined in: node_modules/knex/types/index.d.ts:1864 + +Defined in: node_modules/knex/types/index.d.ts:1864 diff --git a/knex.knex-1.connectionconfig.md b/knex.knex-1.connectionconfig.md index 7169b16..f0860fe 100644 --- a/knex.knex-1.connectionconfig.md +++ b/knex.knex-1.connectionconfig.md @@ -0,0 +1,75 @@ +--- +id: "knex.knex-1.connectionconfig" +title: "Interface: ConnectionConfig" +sidebar_label: "ConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: ConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ConnectionConfig + +## Properties + +### database + +• database: string + +Defined in: node_modules/knex/types/index.d.ts:1897 + +___ + +### debug + +• `Optional` debug: boolean + +Defined in: node_modules/knex/types/index.d.ts:1900 + +___ + +### domain + +• `Optional` domain: string + +Defined in: node_modules/knex/types/index.d.ts:1898 + +___ + +### host + +• host: string + +Defined in: node_modules/knex/types/index.d.ts:1894 + +___ + +### instanceName + +• `Optional` instanceName: string + +Defined in: node_modules/knex/types/index.d.ts:1899 + +___ + +### password + +• password: string + +Defined in: node_modules/knex/types/index.d.ts:1896 + +___ + +### requestTimeout + +• `Optional` requestTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1901 + +___ + +### user + +• user: string + +Defined in: node_modules/knex/types/index.d.ts:1895 diff --git a/knex.knex-1.createtablebuilder.md b/knex.knex-1.createtablebuilder.md index 426bd4d..15994ad 100644 --- a/knex.knex-1.createtablebuilder.md +++ b/knex.knex-1.createtablebuilder.md @@ -0,0 +1,783 @@ +--- +id: "knex.knex-1.createtablebuilder" +title: "Interface: CreateTableBuilder" +sidebar_label: "CreateTableBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: CreateTableBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).CreateTableBuilder + +## Hierarchy + +* [TableBuilder](knex.knex-1.tablebuilder.md) + + ↳ CreateTableBuilder + +## Methods + +### bigIncrements + +▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1723 + +___ + +### bigInteger + +▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1728 + +___ + +### binary + +▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1757 + +___ + +### boolean + +▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1746 + +___ + +### charset + +▸ charset(`val`: string): [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1795 + +___ + +### collate + +▸ collate(`val`: string): [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1796 + +___ + +### comment + +▸ comment(`val`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1771 + +___ + +### date + +▸ date(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1747 + +___ + +### dateTime + +▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1748 + +___ + +### decimal + +▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| null \\\| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1741 + +___ + +### double + +▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1736 + +___ + +### dropColumn + +▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1724 + +___ + +### dropColumns + +▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| string[] \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1725 + +___ + +### dropForeign + +▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`foreignKeyName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1785 + +___ + +### dropIndex + +▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1788 + +___ + +### dropPrimary + +▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1787 + +___ + +### dropTimestamps + +▸ dropTimestamps(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1789 + +___ + +### dropUnique + +▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1786 + +___ + +### engine + +▸ engine(`val`: string): [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1794 + +___ + +### enu + +▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1763 + +___ + +### enum + +▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1758 + +___ + +### float + +▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`precision?` \| number \| +`scale?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1731 + +___ + +### foreign + +▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| +`foreignKeyName?` \| string \| + +Returns: [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1780 + +▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly string[] \| +`foreignKeyName?` \| string \| + +Returns: [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1781 + +___ + +### increments + +▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1722 + +___ + +### index + +▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| +`indexType?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1774 + +___ + +### inherits + +▸ inherits(`val`: string): [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`val` \| string \| + +Returns: [CreateTableBuilder](knex.knex-1.createtablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1797 + +___ + +### integer + +▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1727 + +___ + +### json + +▸ json(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1768 + +___ + +### jsonb + +▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1769 + +___ + +### primary + +▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`constraintName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1773 + +___ + +### queryContext + +▸ queryContext(`context`: any): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1790 + +___ + +### renameColumn + +▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`from` \| string \| +`to` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1726 + +___ + +### specificType + +▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`type` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1772 + +___ + +### string + +▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`length?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1730 + +___ + +### text + +▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`textType?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1729 + +___ + +### time + +▸ time(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1749 + +___ + +### timestamp + +▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1750 + +▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +`deprecated` + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`withoutTz?` \| boolean \| +`precision?` \| number \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1752 + +___ + +### timestamps + +▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`useTimestampType?` \| boolean \| +`makeDefaultNow?` \| boolean \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1753 + +___ + +### unique + +▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| +`indexName?` \| string \| + +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1779 + +___ + +### uuid + +▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [TableBuilder](knex.knex-1.tablebuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1770 diff --git a/knex.knex-1.distinct.md b/knex.knex-1.distinct.md index 288d0e5..4ace7f5 100644 --- a/knex.knex-1.distinct.md +++ b/knex.knex-1.distinct.md @@ -0,0 +1,112 @@ +--- +id: "knex.knex-1.distinct" +title: "Interface: Distinct<TRecord, TResult>" +sidebar_label: "Distinct" +custom_edit_url: null +hide_title: true +--- + +# Interface: Distinct<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Distinct + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| - \| +`TResult` \| - \| {}[] \| + +## Hierarchy + +* [ColumnNameQueryBuilder](knex.knex-1.columnnamequerybuilder.md)<TRecord, TResult\\> + + ↳ Distinct + +## Callable + +▸ Distinct(`columnName`: **): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:1434 + +▸ Distinct<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1440 + +▸ Distinct<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1451 + +▸ Distinct<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1462 + +▸ Distinct<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1474 diff --git a/knex.knex-1.distincton.md b/knex.knex-1.distincton.md index 6ecf12b..3dc9f81 100644 --- a/knex.knex-1.distincton.md +++ b/knex.knex-1.distincton.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.distincton" +id: "knex.knex-1.distincton" title: "Interface: DistinctOn<TRecord, TResult>" sidebar_label: "DistinctOn" +custom_edit_url: null hide_title: true --- @@ -12,72 +13,68 @@ hide_title: true ## Type parameters Name \| Type \| Default \| ------- \| ------ \| ------ \| -`TRecord` \| {} \| - \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| - \| `TResult` \| - \| {}[] \| -## Hierarchy - -* DistinctOn - ## Callable -▸ DistinctOn<ColNameUT\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ DistinctOn<ColNameUT\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ColNameUT` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...columnNames` \| readonly ColNameUT[] \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1016 +Defined in: node_modules/knex/types/index.d.ts:1022 -▸ DistinctOn<ColNameUT\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ DistinctOn<ColNameUT\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ColNameUT` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnNames` \| readonly ColNameUT[] \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1019 +Defined in: node_modules/knex/types/index.d.ts:1025 -▸ DistinctOn(...`columnNames`: readonly string[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ DistinctOn(...`columnNames`: readonly string[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...columnNames` \| readonly string[] \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1023 +Defined in: node_modules/knex/types/index.d.ts:1029 -▸ DistinctOn(`columnNames`: readonly string[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ DistinctOn(`columnNames`: readonly string[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnNames` \| readonly string[] \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1025 +Defined in: node_modules/knex/types/index.d.ts:1031 diff --git a/knex.knex-1.enumoptions.md b/knex.knex-1.enumoptions.md index 4483449..c20c055 100644 --- a/knex.knex-1.enumoptions.md +++ b/knex.knex-1.enumoptions.md @@ -0,0 +1,43 @@ +--- +id: "knex.knex-1.enumoptions" +title: "Interface: EnumOptions" +sidebar_label: "EnumOptions" +custom_edit_url: null +hide_title: true +--- + +# Interface: EnumOptions + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).EnumOptions + +## Properties + +### enumName + +• enumName: string + +Defined in: node_modules/knex/types/index.d.ts:2173 + +___ + +### existingType + +• `Optional` existingType: boolean + +Defined in: node_modules/knex/types/index.d.ts:2171 + +___ + +### schemaName + +• `Optional` schemaName: string + +Defined in: node_modules/knex/types/index.d.ts:2172 + +___ + +### useNative + +• useNative: boolean + +Defined in: node_modules/knex/types/index.d.ts:2170 diff --git a/knex.knex-1.foreignconstraintbuilder.md b/knex.knex-1.foreignconstraintbuilder.md index d15e4ae..5cf565f 100644 --- a/knex.knex-1.foreignconstraintbuilder.md +++ b/knex.knex-1.foreignconstraintbuilder.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.foreignconstraintbuilder" +id: "knex.knex-1.foreignconstraintbuilder" title: "Interface: ForeignConstraintBuilder" sidebar_label: "ForeignConstraintBuilder" +custom_edit_url: null hide_title: true --- @@ -9,22 +10,18 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ForeignConstraintBuilder -## Hierarchy - -* ForeignConstraintBuilder - ## Methods ### references -▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1816 +Defined in: node_modules/knex/types/index.d.ts:1822 diff --git a/knex.knex-1.functionhelper.md b/knex.knex-1.functionhelper.md index b3804ff..5e6dd98 100644 --- a/knex.knex-1.functionhelper.md +++ b/knex.knex-1.functionhelper.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.functionhelper" +id: "knex.knex-1.functionhelper" title: "Interface: FunctionHelper" sidebar_label: "FunctionHelper" +custom_edit_url: null hide_title: true --- @@ -9,22 +10,18 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).FunctionHelper -## Hierarchy - -* FunctionHelper - ## Methods ### now -▸ now(`precision?`: number): [Raw](knex.knex.raw.md)<any\\> +▸ now(`precision?`: number): [Raw](knex.knex-1.raw.md)<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `precision?` \| number \| -Returns: [Raw](knex.knex.raw.md)<any\\> +Returns: [Raw](knex.knex-1.raw.md)<any\\> -Defined in: node_modules/knex/types/index.d.ts:2160 +Defined in: node_modules/knex/types/index.d.ts:2166 diff --git a/knex.knex-1.groupby.md b/knex.knex-1.groupby.md index 9149758..9c157a7 100644 --- a/knex.knex-1.groupby.md +++ b/knex.knex-1.groupby.md @@ -0,0 +1,151 @@ +--- +id: "knex.knex-1.groupby" +title: "Interface: GroupBy<TRecord, TResult>" +sidebar_label: "GroupBy" +custom_edit_url: null +hide_title: true +--- + +# Interface: GroupBy<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).GroupBy + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +* [ColumnNameQueryBuilder](knex.knex-1.columnnamequerybuilder.md)<TRecord, TResult\\> + + ↳ GroupBy + +## Callable + +▸ GroupBy<TResult2\\>(`sql`: string, `bindings?`: [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`bindings?` \| [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1489 + +▸ GroupBy<TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<TResult2\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1493 + +▸ GroupBy(`columnName`: **): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:1434 + +▸ GroupBy<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1440 + +▸ GroupBy<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1451 + +▸ GroupBy<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1462 + +▸ GroupBy<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1474 diff --git a/knex.knex-1.having.md b/knex.knex-1.having.md index 4c24b57..94a5f2f 100644 --- a/knex.knex-1.having.md +++ b/knex.knex-1.having.md @@ -0,0 +1,84 @@ +--- +id: "knex.knex-1.having" +title: "Interface: Having<TRecord, TResult>" +sidebar_label: "Having" +custom_edit_url: null +hide_title: true +--- + +# Interface: Having<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Having + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + + ↳ Having + +## Callable + +▸ Having<K\\>(`column`: K, `operator`: ComparisonOperator, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| K \| +`operator` \| ComparisonOperator \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1405 + +▸ Having(`column`: string \\\| [Raw](knex.knex-1.raw.md)<any\\>, `operator`: string, `value`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| [Raw](knex.knex-1.raw.md)<any\\> \| +`operator` \| string \| +`value` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1410 + +▸ Having(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1416 + +▸ Having(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1267 diff --git a/knex.knex-1.havingrange.md b/knex.knex-1.havingrange.md index 3f73e99..69aaeba 100644 --- a/knex.knex-1.havingrange.md +++ b/knex.knex-1.havingrange.md @@ -0,0 +1,52 @@ +--- +id: "knex.knex-1.havingrange" +title: "Interface: HavingRange<TRecord, TResult>" +sidebar_label: "HavingRange" +custom_edit_url: null +hide_title: true +--- + +# Interface: HavingRange<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).HavingRange + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Callable + +▸ HavingRange<K\\>(`columnName`: K, `values`: readonly [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`values` \| readonly [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1424 + +▸ HavingRange(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1428 diff --git a/knex.knex-1.hintcomment.md b/knex.knex-1.hintcomment.md index 18138a2..4f3cb20 100644 --- a/knex.knex-1.hintcomment.md +++ b/knex.knex-1.hintcomment.md @@ -0,0 +1,44 @@ +--- +id: "knex.knex-1.hintcomment" +title: "Interface: HintComment<TRecord, TResult>" +sidebar_label: "HintComment" +custom_edit_url: null +hide_title: true +--- + +# Interface: HintComment<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).HintComment + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| object \| any \| + +## Callable + +▸ HintComment(`hint`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`hint` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:982 + +▸ HintComment(`hints`: readonly string[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`hints` \| readonly string[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:983 diff --git a/knex.knex-1.intersect.md b/knex.knex-1.intersect.md index 272ada2..fd611e0 100644 --- a/knex.knex-1.intersect.md +++ b/knex.knex-1.intersect.md @@ -0,0 +1,51 @@ +--- +id: "knex.knex-1.intersect" +title: "Interface: Intersect<TRecord, TResult>" +sidebar_label: "Intersect" +custom_edit_url: null +hide_title: true +--- + +# Interface: Intersect<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Intersect + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* Intersect + + ↳ [Union](knex.knex-1.union.md) + +## Callable + +▸ Intersect(`callback`: MaybeArray<[Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>\\>, `wrap?`: boolean): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| MaybeArray<[Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>\\> \| +`wrap?` \| boolean \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1391 + +▸ Intersect(...`callbacks`: readonly ([Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...callbacks` \| readonly ([Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1395 diff --git a/knex.knex-1.join.md b/knex.knex-1.join.md index 352a205..b383c77 100644 --- a/knex.knex-1.join.md +++ b/knex.knex-1.join.md @@ -0,0 +1,236 @@ +--- +id: "knex.knex-1.join" +title: "Interface: Join<TRecord, TResult>" +sidebar_label: "Join" +custom_edit_url: null +hide_title: true +--- + +# Interface: Join<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Join + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| unknown[] \| + +## Callable + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1039 + +▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `clause`: [JoinCallback](knex.knex-1.joincallback.md)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TTable` \| never \| - \| +`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\> \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`clause` \| [JoinCallback](knex.knex-1.joincallback.md) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1046 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `clause`: [JoinCallback](knex.knex-1.joincallback.md)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`clause` \| [JoinCallback](knex.knex-1.joincallback.md) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1054 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `columns`: { [key: string]: string \\\| number \\\| boolean \\\| [Raw](knex.knex-1.raw.md); }): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`columns` \| object \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1062 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `raw`: [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1070 + +▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `column1`: string, `column2`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TTable` \| never \| - \| +`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\> \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`column1` \| string \| +`column2` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1078 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `column2`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`column1` \| string \| +`column2` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1087 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `raw`: [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`column1` \| string \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1096 + +▸ Join<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `column1`: string, `operator`: string, `column2`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TTable` \| never \| - \| +`TRecord2` \| - \| [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\> & [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\> \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`column1` \| string \| +`operator` \| string \| +`column2` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1105 + +▸ Join<TJoinTargetRecord, TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>, `column1`: string, `operator`: string, `column2`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TJoinTargetRecord` \| object \| any \| +`TRecord2` \| object \| TRecord & TJoinTargetRecord \| +`TResult2` \| - \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| +`column1` \| string \| +`operator` \| string \| +`column2` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1115 diff --git a/knex.knex-1.joincallback.md b/knex.knex-1.joincallback.md index 6e87c69..ef15b8c 100644 --- a/knex.knex-1.joincallback.md +++ b/knex.knex-1.joincallback.md @@ -0,0 +1,25 @@ +--- +id: "knex.knex-1.joincallback" +title: "Interface: JoinCallback" +sidebar_label: "JoinCallback" +custom_edit_url: null +hide_title: true +--- + +# Interface: JoinCallback + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinCallback + +## Callable + +▸ JoinCallback(`join`: [JoinClause](knex.knex-1.joinclause.md)): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`join` \| [JoinClause](knex.knex-1.joinclause.md) \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:1035 diff --git a/knex.knex-1.joinclause.md b/knex.knex-1.joinclause.md index 14ee4ae..f5c917e 100644 --- a/knex.knex-1.joinclause.md +++ b/knex.knex-1.joinclause.md @@ -0,0 +1,679 @@ +--- +id: "knex.knex-1.joinclause" +title: "Interface: JoinClause" +sidebar_label: "JoinClause" +custom_edit_url: null +hide_title: true +--- + +# Interface: JoinClause + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinClause + +## Methods + +### andOn + +▸ andOn(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1135 + +▸ andOn(`callback`: [JoinCallback](knex.knex-1.joincallback.md)): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [JoinCallback](knex.knex-1.joincallback.md) \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1136 + +▸ andOn(`columns`: { [key: string]: string \\\| [Raw](knex.knex-1.raw.md); }): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| object \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1137 + +▸ andOn(`column1`: string, `column2`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`column2` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1138 + +▸ andOn(`column1`: string, `raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1139 + +▸ andOn(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`operator` \| string \| +`column2` \| string \\\| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1140 + +___ + +### andOnBetween + +▸ andOnBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1166 + +___ + +### andOnExists + +▸ andOnExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1160 + +___ + +### andOnIn + +▸ andOnIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1148 + +___ + +### andOnNotBetween + +▸ andOnNotBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1169 + +___ + +### andOnNotExists + +▸ andOnNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1163 + +___ + +### andOnNotIn + +▸ andOnNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1151 + +___ + +### andOnNotNull + +▸ andOnNotNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1157 + +___ + +### andOnNull + +▸ andOnNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1154 + +___ + +### on + +▸ on(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1129 + +▸ on(`callback`: [JoinCallback](knex.knex-1.joincallback.md)): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [JoinCallback](knex.knex-1.joincallback.md) \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1130 + +▸ on(`columns`: { [key: string]: string \\\| [Raw](knex.knex-1.raw.md); }): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| object \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1131 + +▸ on(`column1`: string, `column2`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`column2` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1132 + +▸ on(`column1`: string, `raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1133 + +▸ on(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`operator` \| string \| +`column2` \| string \\\| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1134 + +___ + +### onBetween + +▸ onBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1165 + +___ + +### onExists + +▸ onExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1159 + +___ + +### onIn + +▸ onIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1147 + +___ + +### onNotBetween + +▸ onNotBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1168 + +___ + +### onNotExists + +▸ onNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1162 + +___ + +### onNotIn + +▸ onNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1150 + +___ + +### onNotNull + +▸ onNotNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1156 + +___ + +### onNull + +▸ onNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1153 + +___ + +### orOn + +▸ orOn(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1141 + +▸ orOn(`callback`: [JoinCallback](knex.knex-1.joincallback.md)): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [JoinCallback](knex.knex-1.joincallback.md) \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1142 + +▸ orOn(`columns`: { [key: string]: string \\\| [Raw](knex.knex-1.raw.md); }): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| object \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1143 + +▸ orOn(`column1`: string, `column2`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`column2` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1144 + +▸ orOn(`column1`: string, `raw`: [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1145 + +▸ orOn(`column1`: string, `operator`: string, `column2`: string \\\| [Raw](knex.knex-1.raw.md)<any\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`operator` \| string \| +`column2` \| string \\\| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1146 + +___ + +### orOnBetween + +▸ orOnBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1167 + +___ + +### orOnExists + +▸ orOnExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1161 + +___ + +### orOnIn + +▸ orOnIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1149 + +___ + +### orOnNotBetween + +▸ orOnNotBetween(`column1`: string, `range`: readonly [any, any]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`range` \| readonly [any, any] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1170 + +___ + +### orOnNotExists + +▸ orOnNotExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\>): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1164 + +___ + +### orOnNotIn + +▸ orOnNotIn(`column1`: string, `values`: readonly any[]): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| +`values` \| readonly any[] \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1152 + +___ + +### orOnNotNull + +▸ orOnNotNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1158 + +___ + +### orOnNull + +▸ orOnNull(`column1`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column1` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1155 + +___ + +### type + +▸ type(`type`: string): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`type` \| string \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1174 + +___ + +### using + +▸ using(`column`: string \\\| readonly string[] \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| { [key: string]: string \\\| [Raw](knex.knex-1.raw.md); }): [JoinClause](knex.knex-1.joinclause.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| readonly string[] \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| { [key: string]: string \\\| [Raw](knex.knex-1.raw.md); } \| + +Returns: [JoinClause](knex.knex-1.joinclause.md) + +Defined in: node_modules/knex/types/index.d.ts:1171 diff --git a/knex.knex-1.joinraw.md b/knex.knex-1.joinraw.md index 10bca30..8a316e2 100644 --- a/knex.knex-1.joinraw.md +++ b/knex.knex-1.joinraw.md @@ -0,0 +1,33 @@ +--- +id: "knex.knex-1.joinraw" +title: "Interface: JoinRaw<TRecord, TResult>" +sidebar_label: "JoinRaw" +custom_edit_url: null +hide_title: true +--- + +# Interface: JoinRaw<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).JoinRaw + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Callable + +▸ JoinRaw(`tableName`: string, `binding?`: [Value](../modules/knex.knex-1.md#value) \\\| [ValueDict](knex.knex-1.valuedict.md)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| string \| +`binding?` \| [Value](../modules/knex.knex-1.md#value) \\\| [ValueDict](knex.knex-1.valuedict.md) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1177 diff --git a/knex.knex-1.logger.md b/knex.knex-1.logger.md index 7ea38bb..9651d62 100644 --- a/knex.knex-1.logger.md +++ b/knex.knex-1.logger.md @@ -0,0 +1,74 @@ +--- +id: "knex.knex-1.logger" +title: "Interface: Logger" +sidebar_label: "Logger" +custom_edit_url: null +hide_title: true +--- + +# Interface: Logger + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Logger + +## Properties + +### debug + +• `Optional` debug: [LogFn](../modules/knex.knex-1.md#logfn) + +Defined in: node_modules/knex/types/index.d.ts:2103 + +___ + +### deprecate + +• `Optional` deprecate: (`method`: string, `alternative`: string) => void + +#### Type declaration: + +▸ (`method`: string, `alternative`: string): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`method` \| string \| +`alternative` \| string \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:2106 + +Defined in: node_modules/knex/types/index.d.ts:2106 + +___ + +### enableColors + +• `Optional` enableColors: boolean + +Defined in: node_modules/knex/types/index.d.ts:2105 + +___ + +### error + +• `Optional` error: [LogFn](../modules/knex.knex-1.md#logfn) + +Defined in: node_modules/knex/types/index.d.ts:2102 + +___ + +### inspectionDepth + +• `Optional` inspectionDepth: number + +Defined in: node_modules/knex/types/index.d.ts:2104 + +___ + +### warn + +• `Optional` warn: [LogFn](../modules/knex.knex-1.md#logfn) + +Defined in: node_modules/knex/types/index.d.ts:2101 diff --git a/knex.knex-1.mariasqlconnectionconfig.md b/knex.knex-1.mariasqlconnectionconfig.md index 0bc78ae..7f7890d 100644 --- a/knex.knex-1.mariasqlconnectionconfig.md +++ b/knex.knex-1.mariasqlconnectionconfig.md @@ -0,0 +1,173 @@ +--- +id: "knex.knex-1.mariasqlconnectionconfig" +title: "Interface: MariaSqlConnectionConfig" +sidebar_label: "MariaSqlConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: MariaSqlConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MariaSqlConnectionConfig + +## Properties + +### charset + +• `Optional` charset: string + +Defined in: node_modules/knex/types/index.d.ts:1968 + +___ + +### compress + +• `Optional` compress: boolean + +Defined in: node_modules/knex/types/index.d.ts:1963 + +___ + +### connTimeout + +• `Optional` connTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1960 + +___ + +### db + +• `Optional` db: string + +Defined in: node_modules/knex/types/index.d.ts:1957 + +___ + +### host + +• `Optional` host: string + +Defined in: node_modules/knex/types/index.d.ts:1953 + +___ + +### keepQueries + +• `Optional` keepQueries: boolean + +Defined in: node_modules/knex/types/index.d.ts:1958 + +___ + +### local\\_infile + +• `Optional` local\\_infile: boolean + +Defined in: node_modules/knex/types/index.d.ts:1965 + +___ + +### multiStatements + +• `Optional` multiStatements: boolean + +Defined in: node_modules/knex/types/index.d.ts:1959 + +___ + +### password + +• `Optional` password: string + +Defined in: node_modules/knex/types/index.d.ts:1952 + +___ + +### pingInterval + +• `Optional` pingInterval: number + +Defined in: node_modules/knex/types/index.d.ts:1961 + +___ + +### port + +• `Optional` port: number + +Defined in: node_modules/knex/types/index.d.ts:1954 + +___ + +### protocol + +• `Optional` protocol: string + +Defined in: node_modules/knex/types/index.d.ts:1956 + +___ + +### read\\_default\\_file + +• `Optional` read\\_default\\_file: string + +Defined in: node_modules/knex/types/index.d.ts:1966 + +___ + +### read\\_default\\_group + +• `Optional` read\\_default\\_group: string + +Defined in: node_modules/knex/types/index.d.ts:1967 + +___ + +### secureAuth + +• `Optional` secureAuth: boolean + +Defined in: node_modules/knex/types/index.d.ts:1962 + +___ + +### ssl + +• `Optional` ssl: boolean \\\| [MariaSslConfiguration](knex.knex-1.mariasslconfiguration.md) + +Defined in: node_modules/knex/types/index.d.ts:1964 + +___ + +### streamHWM + +• `Optional` streamHWM: number + +Defined in: node_modules/knex/types/index.d.ts:1969 + +___ + +### unixSocket + +• `Optional` unixSocket: string + +Defined in: node_modules/knex/types/index.d.ts:1955 + +___ + +### user + +• `Optional` user: string + +Defined in: node_modules/knex/types/index.d.ts:1951 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:1970 diff --git a/knex.knex-1.mariasslconfiguration.md b/knex.knex-1.mariasslconfiguration.md index b365ff2..94fcbb4 100644 --- a/knex.knex-1.mariasslconfiguration.md +++ b/knex.knex-1.mariasslconfiguration.md @@ -0,0 +1,69 @@ +--- +id: "knex.knex-1.mariasslconfiguration" +title: "Interface: MariaSslConfiguration" +sidebar_label: "MariaSslConfiguration" +custom_edit_url: null +hide_title: true +--- + +# Interface: MariaSslConfiguration + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MariaSslConfiguration + +## Properties + +### ca + +• `Optional` ca: string + +Defined in: node_modules/knex/types/index.d.ts:1976 + +___ + +### capath + +• `Optional` capath: string + +Defined in: node_modules/knex/types/index.d.ts:1977 + +___ + +### cert + +• `Optional` cert: string + +Defined in: node_modules/knex/types/index.d.ts:1975 + +___ + +### cipher + +• `Optional` cipher: string + +Defined in: node_modules/knex/types/index.d.ts:1978 + +___ + +### key + +• `Optional` key: string + +Defined in: node_modules/knex/types/index.d.ts:1974 + +___ + +### rejectUnauthorized + +• `Optional` rejectUnauthorized: boolean + +Defined in: node_modules/knex/types/index.d.ts:1979 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:1980 diff --git a/knex.knex-1.migration.md b/knex.knex-1.migration.md index 0b872be..b262ccd 100644 --- a/knex.knex-1.migration.md +++ b/knex.knex-1.migration.md @@ -0,0 +1,55 @@ +--- +id: "knex.knex-1.migration" +title: "Interface: Migration" +sidebar_label: "Migration" +custom_edit_url: null +hide_title: true +--- + +# Interface: Migration + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Migration + +## Properties + +### down + +• `Optional` down: (`kenx`: Knex<any, unknown[]\\>) => PromiseLike<any\\> + +#### Type declaration: + +▸ (`kenx`: Knex<any, unknown[]\\>): PromiseLike<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`kenx` \| Knex<any, unknown[]\\> \| + +Returns: PromiseLike<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2111 + +Defined in: node_modules/knex/types/index.d.ts:2111 + +___ + +### up + +• up: (`knex`: Knex<any, unknown[]\\>) => PromiseLike<any\\> + +#### Type declaration: + +▸ (`knex`: Knex<any, unknown[]\\>): PromiseLike<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`knex` \| Knex<any, unknown[]\\> \| + +Returns: PromiseLike<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2110 + +Defined in: node_modules/knex/types/index.d.ts:2110 diff --git a/knex.knex-1.migrationsource.md b/knex.knex-1.migrationsource.md index 3910a45..919374d 100644 --- a/knex.knex-1.migrationsource.md +++ b/knex.knex-1.migrationsource.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.migrationsource" +id: "knex.knex-1.migrationsource" title: "Interface: MigrationSource<TMigrationSpec>" sidebar_label: "MigrationSource" +custom_edit_url: null hide_title: true --- @@ -12,28 +13,24 @@ hide_title: true ## Type parameters Name \| ------- \| +:------ \| `TMigrationSpec` \| -## Hierarchy - -* MigrationSource - ## Methods ### getMigration -▸ getMigration(`migration`: TMigrationSpec): [Migration](knex.knex.migration.md) +▸ getMigration(`migration`: TMigrationSpec): [Migration](knex.knex-1.migration.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `migration` \| TMigrationSpec \| -Returns: [Migration](knex.knex.migration.md) +Returns: [Migration](knex.knex-1.migration.md) -Defined in: node_modules/knex/types/index.d.ts:2111 +Defined in: node_modules/knex/types/index.d.ts:2117 ___ @@ -44,12 +41,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `migration` \| TMigrationSpec \| Returns: string -Defined in: node_modules/knex/types/index.d.ts:2110 +Defined in: node_modules/knex/types/index.d.ts:2116 ___ @@ -60,9 +57,9 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `loadExtensions` \| readonly string[] \| Returns: Promise<TMigrationSpec[]\\> -Defined in: node_modules/knex/types/index.d.ts:2109 +Defined in: node_modules/knex/types/index.d.ts:2115 diff --git a/knex.knex-1.migrator.md b/knex.knex-1.migrator.md index 708b25b..8b664c9 100644 --- a/knex.knex-1.migrator.md +++ b/knex.knex-1.migrator.md @@ -0,0 +1,157 @@ +--- +id: "knex.knex-1.migrator" +title: "Interface: Migrator" +sidebar_label: "Migrator" +custom_edit_url: null +hide_title: true +--- + +# Interface: Migrator + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Migrator + +## Methods + +### currentVersion + +▸ currentVersion(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<string\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<string\\> + +Defined in: node_modules/knex/types/index.d.ts:2139 + +___ + +### down + +▸ down(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2142 + +___ + +### forceFreeMigrationsLock + +▸ forceFreeMigrationsLock(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2143 + +___ + +### latest + +▸ latest(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2136 + +___ + +### list + +▸ list(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2140 + +___ + +### make + +▸ make(`name`: string, `config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<string\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`name` \| string \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<string\\> + +Defined in: node_modules/knex/types/index.d.ts:2135 + +___ + +### rollback + +▸ rollback(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md), `all?`: boolean): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| +`all?` \| boolean \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2137 + +___ + +### status + +▸ status(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<number\\> + +Defined in: node_modules/knex/types/index.d.ts:2138 + +___ + +### up + +▸ up(`config?`: [MigratorConfig](knex.knex-1.migratorconfig.md)): Promise<any\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [MigratorConfig](knex.knex-1.migratorconfig.md) \| + +Returns: Promise<any\\> + +Defined in: node_modules/knex/types/index.d.ts:2141 diff --git a/knex.knex-1.migratorconfig.md b/knex.knex-1.migratorconfig.md index 599b4b0..72d4da0 100644 --- a/knex.knex-1.migratorconfig.md +++ b/knex.knex-1.migratorconfig.md @@ -0,0 +1,99 @@ +--- +id: "knex.knex-1.migratorconfig" +title: "Interface: MigratorConfig" +sidebar_label: "MigratorConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: MigratorConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MigratorConfig + +## Properties + +### database + +• `Optional` database: string + +Defined in: node_modules/knex/types/index.d.ts:2121 + +___ + +### directory + +• `Optional` directory: string \\\| readonly string[] + +Defined in: node_modules/knex/types/index.d.ts:2122 + +___ + +### disableMigrationsListValidation + +• `Optional` disableMigrationsListValidation: boolean + +Defined in: node_modules/knex/types/index.d.ts:2128 + +___ + +### disableTransactions + +• `Optional` disableTransactions: boolean + +Defined in: node_modules/knex/types/index.d.ts:2127 + +___ + +### extension + +• `Optional` extension: string + +Defined in: node_modules/knex/types/index.d.ts:2123 + +___ + +### loadExtensions + +• `Optional` loadExtensions: readonly string[] + +Defined in: node_modules/knex/types/index.d.ts:2130 + +___ + +### migrationSource + +• `Optional` migrationSource: [MigrationSource](knex.knex-1.migrationsource.md)<unknown\\> + +Defined in: node_modules/knex/types/index.d.ts:2131 + +___ + +### schemaName + +• `Optional` schemaName: string + +Defined in: node_modules/knex/types/index.d.ts:2126 + +___ + +### sortDirsSeparately + +• `Optional` sortDirsSeparately: boolean + +Defined in: node_modules/knex/types/index.d.ts:2129 + +___ + +### stub + +• `Optional` stub: string + +Defined in: node_modules/knex/types/index.d.ts:2124 + +___ + +### tableName + +• `Optional` tableName: string + +Defined in: node_modules/knex/types/index.d.ts:2125 diff --git a/knex.knex-1.mssqlconnectionconfig.md b/knex.knex-1.mssqlconnectionconfig.md index e4517bb..f1396c3 100644 --- a/knex.knex-1.mssqlconnectionconfig.md +++ b/knex.knex-1.mssqlconnectionconfig.md @@ -0,0 +1,125 @@ +--- +id: "knex.knex-1.mssqlconnectionconfig" +title: "Interface: MsSqlConnectionConfig" +sidebar_label: "MsSqlConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: MsSqlConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MsSqlConnectionConfig + +## Properties + +### connectionTimeout + +• `Optional` connectionTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1913 + +___ + +### database + +• database: string + +Defined in: node_modules/knex/types/index.d.ts:1912 + +___ + +### domain + +• `Optional` domain: string + +Defined in: node_modules/knex/types/index.d.ts:1911 + +___ + +### driver + +• `Optional` driver: string + +Defined in: node_modules/knex/types/index.d.ts:1906 + +___ + +### options + +• `Optional` options: Readonly<{ `abortTransactionOnError?`: boolean ; `appName?`: string ; `enableArithAbort?`: boolean ; `encrypt?`: boolean ; `instanceName?`: string ; `isolationLevel?`: READ_UNCOMMITTED \\\| READ_COMMITTED \\\| REPEATABLE_READ \\\| SERIALIZABLE \\\| SNAPSHOT ; `maxRetriesOnTransientErrors?`: number ; `multiSubnetFailover?`: boolean ; `packetSize?`: number ; `tdsVersion?`: string ; `trustedConnection?`: boolean ; `useUTC?`: boolean }\\> + +Defined in: node_modules/knex/types/index.d.ts:1918 + +___ + +### parseJSON + +• `Optional` parseJSON: boolean + +Defined in: node_modules/knex/types/index.d.ts:1916 + +___ + +### password + +• `Optional` password: string + +Defined in: node_modules/knex/types/index.d.ts:1908 + +___ + +### pool + +• `Optional` pool: Readonly<{ `Promise?`: any ; `acquireTimeoutMillis?`: number ; `autostart?`: boolean ; `evictionRunIntervalMillis?`: number ; `fifo?`: boolean ; `idleTimeoutMillis?`: number ; `max?`: number ; `maxWaitingClients?`: number ; `min?`: number ; `numTestsPerRun?`: number ; `priorityRange?`: number ; `softIdleTimeoutMillis?`: number ; `testOnBorrow?`: boolean }\\> + +Defined in: node_modules/knex/types/index.d.ts:1932 + +___ + +### port + +• `Optional` port: number + +Defined in: node_modules/knex/types/index.d.ts:1910 + +___ + +### requestTimeout + +• `Optional` requestTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1914 + +___ + +### server + +• server: string + +Defined in: node_modules/knex/types/index.d.ts:1909 + +___ + +### stream + +• `Optional` stream: boolean + +Defined in: node_modules/knex/types/index.d.ts:1915 + +___ + +### user + +• `Optional` user: string + +Defined in: node_modules/knex/types/index.d.ts:1907 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:1917 diff --git a/knex.knex-1.multikeyforeignconstraintbuilder.md b/knex.knex-1.multikeyforeignconstraintbuilder.md index 2960aa0..94bf7c8 100644 --- a/knex.knex-1.multikeyforeignconstraintbuilder.md +++ b/knex.knex-1.multikeyforeignconstraintbuilder.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.multikeyforeignconstraintbuilder" +id: "knex.knex-1.multikeyforeignconstraintbuilder" title: "Interface: MultikeyForeignConstraintBuilder" sidebar_label: "MultikeyForeignConstraintBuilder" +custom_edit_url: null hide_title: true --- @@ -9,22 +10,18 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MultikeyForeignConstraintBuilder -## Hierarchy - -* MultikeyForeignConstraintBuilder - ## Methods ### references -▸ references(`columnNames`: readonly string[]): [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) +▸ references(`columnNames`: readonly string[]): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnNames` \| readonly string[] \| -Returns: [ReferencingColumnBuilder](knex.knex.referencingcolumnbuilder.md) +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1820 +Defined in: node_modules/knex/types/index.d.ts:1826 diff --git a/knex.knex-1.mysql2connectionconfig.md b/knex.knex-1.mysql2connectionconfig.md index 3498422..1e4eaec 100644 --- a/knex.knex-1.mysql2connectionconfig.md +++ b/knex.knex-1.mysql2connectionconfig.md @@ -0,0 +1,405 @@ +--- +id: "knex.knex-1.mysql2connectionconfig" +title: "Interface: MySql2ConnectionConfig" +sidebar_label: "MySql2ConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: MySql2ConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySql2ConnectionConfig + +## Hierarchy + +* [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md) + + ↳ MySql2ConnectionConfig + +## Properties + +### authPlugins + +• `Optional` authPlugins: object + +#### Type declaration: + +Defined in: node_modules/knex/types/index.d.ts:2014 + +___ + +### authSwitchHandler + +• `Optional` authSwitchHandler: (`data`: any, `callback`: () => void) => any + +#### Type declaration: + +▸ (`data`: any, `callback`: () => void): any + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| any \| +`callback` \| () => void \| + +Returns: any + +Defined in: node_modules/knex/types/index.d.ts:2015 + +Defined in: node_modules/knex/types/index.d.ts:2015 + +___ + +### bigNumberStrings + +• `Optional` bigNumberStrings: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[bigNumberStrings](knex.knex-1.mysqlconnectionconfig.md#bignumberstrings) + +Defined in: node_modules/knex/types/index.d.ts:2000 + +___ + +### charset + +• `Optional` charset: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[charset](knex.knex-1.mysqlconnectionconfig.md#charset) + +Defined in: node_modules/knex/types/index.d.ts:1992 + +___ + +### charsetNumber + +• `Optional` charsetNumber: number + +Defined in: node_modules/knex/types/index.d.ts:2016 + +___ + +### compress + +• `Optional` compress: boolean + +Defined in: node_modules/knex/types/index.d.ts:2017 + +___ + +### connectAttributes + +• `Optional` connectAttributes: object + +#### Type declaration: + +Defined in: node_modules/knex/types/index.d.ts:2018 + +___ + +### connectTimeout + +• `Optional` connectTimeout: number + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[connectTimeout](knex.knex-1.mysqlconnectionconfig.md#connecttimeout) + +Defined in: node_modules/knex/types/index.d.ts:1994 + +___ + +### database + +• `Optional` database: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[database](knex.knex-1.mysqlconnectionconfig.md#database) + +Defined in: node_modules/knex/types/index.d.ts:1991 + +___ + +### dateStrings + +• `Optional` dateStrings: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[dateStrings](knex.knex-1.mysqlconnectionconfig.md#datestrings) + +Defined in: node_modules/knex/types/index.d.ts:2001 + +___ + +### debug + +• `Optional` debug: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[debug](knex.knex-1.mysqlconnectionconfig.md#debug) + +Defined in: node_modules/knex/types/index.d.ts:2002 + +___ + +### decimalNumbers + +• `Optional` decimalNumbers: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[decimalNumbers](knex.knex-1.mysqlconnectionconfig.md#decimalnumbers) + +Defined in: node_modules/knex/types/index.d.ts:2007 + +___ + +### enableKeepAlive + +• `Optional` enableKeepAlive: boolean + +Defined in: node_modules/knex/types/index.d.ts:2019 + +___ + +### flags + +• `Optional` flags: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[flags](knex.knex-1.mysqlconnectionconfig.md#flags) + +Defined in: node_modules/knex/types/index.d.ts:2005 + +___ + +### host + +• `Optional` host: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[host](knex.knex-1.mysqlconnectionconfig.md#host) + +Defined in: node_modules/knex/types/index.d.ts:1985 + +___ + +### insecureAuth + +• `Optional` insecureAuth: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[insecureAuth](knex.knex-1.mysqlconnectionconfig.md#insecureauth) + +Defined in: node_modules/knex/types/index.d.ts:1996 + +___ + +### keepAliveInitialDelay + +• `Optional` keepAliveInitialDelay: number + +Defined in: node_modules/knex/types/index.d.ts:2020 + +___ + +### localAddress + +• `Optional` localAddress: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[localAddress](knex.knex-1.mysqlconnectionconfig.md#localaddress) + +Defined in: node_modules/knex/types/index.d.ts:1987 + +___ + +### maxPreparedStatements + +• `Optional` maxPreparedStatements: number + +Defined in: node_modules/knex/types/index.d.ts:2021 + +___ + +### multipleStatements + +• `Optional` multipleStatements: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[multipleStatements](knex.knex-1.mysqlconnectionconfig.md#multiplestatements) + +Defined in: node_modules/knex/types/index.d.ts:2004 + +___ + +### namedPlaceholders + +• `Optional` namedPlaceholders: boolean + +Defined in: node_modules/knex/types/index.d.ts:2022 + +___ + +### nestTables + +• `Optional` nestTables: string \\\| boolean + +Defined in: node_modules/knex/types/index.d.ts:2023 + +___ + +### password + +• `Optional` password: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[password](knex.knex-1.mysqlconnectionconfig.md#password) + +Defined in: node_modules/knex/types/index.d.ts:1990 + +___ + +### passwordSha1 + +• `Optional` passwordSha1: string + +Defined in: node_modules/knex/types/index.d.ts:2024 + +___ + +### port + +• `Optional` port: number + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[port](knex.knex-1.mysqlconnectionconfig.md#port) + +Defined in: node_modules/knex/types/index.d.ts:1986 + +___ + +### queryFormat + +• `Optional` queryFormat: (`query`: string, `values`: any) => string + +#### Type declaration: + +▸ (`query`: string, `values`: any): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`query` \| string \| +`values` \| any \| + +Returns: string + +Defined in: node_modules/knex/types/index.d.ts:1998 + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[queryFormat](knex.knex-1.mysqlconnectionconfig.md#queryformat) + +Defined in: node_modules/knex/types/index.d.ts:1998 + +___ + +### rowsAsArray + +• `Optional` rowsAsArray: boolean + +Defined in: node_modules/knex/types/index.d.ts:2025 + +___ + +### socketPath + +• `Optional` socketPath: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[socketPath](knex.knex-1.mysqlconnectionconfig.md#socketpath) + +Defined in: node_modules/knex/types/index.d.ts:1988 + +___ + +### ssl + +• `Optional` ssl: string \\\| [MariaSslConfiguration](knex.knex-1.mariasslconfiguration.md) + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[ssl](knex.knex-1.mysqlconnectionconfig.md#ssl) + +Defined in: node_modules/knex/types/index.d.ts:2006 + +___ + +### stream + +• `Optional` stream: boolean \\\| (`opts`: any) => Stream \\\| Stream + +Defined in: node_modules/knex/types/index.d.ts:2026 + +___ + +### stringifyObjects + +• `Optional` stringifyObjects: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[stringifyObjects](knex.knex-1.mysqlconnectionconfig.md#stringifyobjects) + +Defined in: node_modules/knex/types/index.d.ts:1995 + +___ + +### supportBigNumbers + +• `Optional` supportBigNumbers: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[supportBigNumbers](knex.knex-1.mysqlconnectionconfig.md#supportbignumbers) + +Defined in: node_modules/knex/types/index.d.ts:1999 + +___ + +### timezone + +• `Optional` timezone: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[timezone](knex.knex-1.mysqlconnectionconfig.md#timezone) + +Defined in: node_modules/knex/types/index.d.ts:1993 + +___ + +### trace + +• `Optional` trace: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[trace](knex.knex-1.mysqlconnectionconfig.md#trace) + +Defined in: node_modules/knex/types/index.d.ts:2003 + +___ + +### typeCast + +• `Optional` typeCast: any + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[typeCast](knex.knex-1.mysqlconnectionconfig.md#typecast) + +Defined in: node_modules/knex/types/index.d.ts:1997 + +___ + +### uri + +• `Optional` uri: string + +Defined in: node_modules/knex/types/index.d.ts:2027 + +___ + +### user + +• `Optional` user: string + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md).[user](knex.knex-1.mysqlconnectionconfig.md#user) + +Defined in: node_modules/knex/types/index.d.ts:1989 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Inherited from: [MySqlConnectionConfig](knex.knex-1.mysqlconnectionconfig.md) + +Defined in: node_modules/knex/types/index.d.ts:2008 diff --git a/knex.knex-1.mysqlaltercolumnbuilder.md b/knex.knex-1.mysqlaltercolumnbuilder.md index 92dd617..757c644 100644 --- a/knex.knex-1.mysqlaltercolumnbuilder.md +++ b/knex.knex-1.mysqlaltercolumnbuilder.md @@ -0,0 +1,275 @@ +--- +id: "knex.knex-1.mysqlaltercolumnbuilder" +title: "Interface: MySqlAlterColumnBuilder" +sidebar_label: "MySqlAlterColumnBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: MySqlAlterColumnBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySqlAlterColumnBuilder + +## Hierarchy + +* [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + + ↳ MySqlAlterColumnBuilder + +## Methods + +### after + +▸ after(`columnName`: string): [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Overrides: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1841 + +___ + +### alter + +▸ alter(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1814 + +___ + +### comment + +▸ comment(`value`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1813 + +___ + +### defaultTo + +▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1809 + +___ + +### first + +▸ first(): [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Returns: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Overrides: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1840 + +___ + +### index + +▸ index(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1803 + +___ + +### notNullable + +▸ notNullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1811 + +___ + +### nullable + +▸ nullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1812 + +___ + +### onDelete + +▸ onDelete(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1807 + +___ + +### onUpdate + +▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1808 + +___ + +### primary + +▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1804 + +___ + +### queryContext + +▸ queryContext(`context`: any): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1815 + +___ + +### references + +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1806 + +___ + +### unique + +▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1805 + +___ + +### unsigned + +▸ unsigned(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1810 + +___ + +### withKeyName + +▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`keyName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [AlterColumnBuilder](knex.knex-1.altercolumnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1816 diff --git a/knex.knex-1.mysqlconnectionconfig.md b/knex.knex-1.mysqlconnectionconfig.md index 95fd728..070b6ae 100644 --- a/knex.knex-1.mysqlconnectionconfig.md +++ b/knex.knex-1.mysqlconnectionconfig.md @@ -0,0 +1,226 @@ +--- +id: "knex.knex-1.mysqlconnectionconfig" +title: "Interface: MySqlConnectionConfig" +sidebar_label: "MySqlConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: MySqlConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).MySqlConnectionConfig + +## Hierarchy + +* MySqlConnectionConfig + + ↳ [MySql2ConnectionConfig](knex.knex-1.mysql2connectionconfig.md) + +## Properties + +### bigNumberStrings + +• `Optional` bigNumberStrings: boolean + +Defined in: node_modules/knex/types/index.d.ts:2000 + +___ + +### charset + +• `Optional` charset: string + +Defined in: node_modules/knex/types/index.d.ts:1992 + +___ + +### connectTimeout + +• `Optional` connectTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:1994 + +___ + +### database + +• `Optional` database: string + +Defined in: node_modules/knex/types/index.d.ts:1991 + +___ + +### dateStrings + +• `Optional` dateStrings: boolean + +Defined in: node_modules/knex/types/index.d.ts:2001 + +___ + +### debug + +• `Optional` debug: boolean + +Defined in: node_modules/knex/types/index.d.ts:2002 + +___ + +### decimalNumbers + +• `Optional` decimalNumbers: boolean + +Defined in: node_modules/knex/types/index.d.ts:2007 + +___ + +### flags + +• `Optional` flags: string + +Defined in: node_modules/knex/types/index.d.ts:2005 + +___ + +### host + +• `Optional` host: string + +Defined in: node_modules/knex/types/index.d.ts:1985 + +___ + +### insecureAuth + +• `Optional` insecureAuth: boolean + +Defined in: node_modules/knex/types/index.d.ts:1996 + +___ + +### localAddress + +• `Optional` localAddress: string + +Defined in: node_modules/knex/types/index.d.ts:1987 + +___ + +### multipleStatements + +• `Optional` multipleStatements: boolean + +Defined in: node_modules/knex/types/index.d.ts:2004 + +___ + +### password + +• `Optional` password: string + +Defined in: node_modules/knex/types/index.d.ts:1990 + +___ + +### port + +• `Optional` port: number + +Defined in: node_modules/knex/types/index.d.ts:1986 + +___ + +### queryFormat + +• `Optional` queryFormat: (`query`: string, `values`: any) => string + +#### Type declaration: + +▸ (`query`: string, `values`: any): string + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`query` \| string \| +`values` \| any \| + +Returns: string + +Defined in: node_modules/knex/types/index.d.ts:1998 + +Defined in: node_modules/knex/types/index.d.ts:1998 + +___ + +### socketPath + +• `Optional` socketPath: string + +Defined in: node_modules/knex/types/index.d.ts:1988 + +___ + +### ssl + +• `Optional` ssl: string \\\| [MariaSslConfiguration](knex.knex-1.mariasslconfiguration.md) + +Defined in: node_modules/knex/types/index.d.ts:2006 + +___ + +### stringifyObjects + +• `Optional` stringifyObjects: boolean + +Defined in: node_modules/knex/types/index.d.ts:1995 + +___ + +### supportBigNumbers + +• `Optional` supportBigNumbers: boolean + +Defined in: node_modules/knex/types/index.d.ts:1999 + +___ + +### timezone + +• `Optional` timezone: string + +Defined in: node_modules/knex/types/index.d.ts:1993 + +___ + +### trace + +• `Optional` trace: boolean + +Defined in: node_modules/knex/types/index.d.ts:2003 + +___ + +### typeCast + +• `Optional` typeCast: any + +Defined in: node_modules/knex/types/index.d.ts:1997 + +___ + +### user + +• `Optional` user: string + +Defined in: node_modules/knex/types/index.d.ts:1989 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:2008 diff --git a/knex.knex-1.onconflictquerybuilder.md b/knex.knex-1.onconflictquerybuilder.md index 2139433..37db0a3 100644 --- a/knex.knex-1.onconflictquerybuilder.md +++ b/knex.knex-1.onconflictquerybuilder.md @@ -0,0 +1,44 @@ +--- +id: "knex.knex-1.onconflictquerybuilder" +title: "Interface: OnConflictQueryBuilder<TRecord, TResult>" +sidebar_label: "OnConflictQueryBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: OnConflictQueryBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OnConflictQueryBuilder + +## Type parameters + +Name \| +:------ \| +`TRecord` \| +`TResult` \| + +## Methods + +### ignore + +▸ ignore(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:456 + +___ + +### merge + +▸ merge(`data?`: Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data?` \| Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<TRecord\\>, {}\\>\\>\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:457 diff --git a/knex.knex-1.oracledbconnectionconfig.md b/knex.knex-1.oracledbconnectionconfig.md index 87c52c1..baf5055 100644 --- a/knex.knex-1.oracledbconnectionconfig.md +++ b/knex.knex-1.oracledbconnectionconfig.md @@ -0,0 +1,93 @@ +--- +id: "knex.knex-1.oracledbconnectionconfig" +title: "Interface: OracleDbConnectionConfig" +sidebar_label: "OracleDbConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: OracleDbConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OracleDbConnectionConfig + +## Properties + +### connectString + +• `Optional` connectString: string + +Defined in: node_modules/knex/types/index.d.ts:2039 + +___ + +### database + +• `Optional` database: string + +Defined in: node_modules/knex/types/index.d.ts:2034 + +___ + +### debug + +• `Optional` debug: boolean + +Defined in: node_modules/knex/types/index.d.ts:2037 + +___ + +### domain + +• `Optional` domain: string + +Defined in: node_modules/knex/types/index.d.ts:2035 + +___ + +### host + +• host: string + +Defined in: node_modules/knex/types/index.d.ts:2031 + +___ + +### instanceName + +• `Optional` instanceName: string + +Defined in: node_modules/knex/types/index.d.ts:2036 + +___ + +### password + +• `Optional` password: string + +Defined in: node_modules/knex/types/index.d.ts:2033 + +___ + +### requestTimeout + +• `Optional` requestTimeout: number + +Defined in: node_modules/knex/types/index.d.ts:2038 + +___ + +### user + +• user: string + +Defined in: node_modules/knex/types/index.d.ts:2032 + +## Methods + +### expirationChecker + +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:2040 diff --git a/knex.knex-1.orderby.md b/knex.knex-1.orderby.md index 526fa27..8d863f1 100644 --- a/knex.knex-1.orderby.md +++ b/knex.knex-1.orderby.md @@ -0,0 +1,70 @@ +--- +id: "knex.knex-1.orderby" +title: "Interface: OrderBy<TRecord, TResult>" +sidebar_label: "OrderBy" +custom_edit_url: null +hide_title: true +--- + +# Interface: OrderBy<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).OrderBy + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Callable + +▸ OrderBy(`columnName`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| keyof TRecord, `order?`: asc \\\| desc): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| keyof TRecord \| +`order?` \| asc \\\| desc \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1369 + +▸ OrderBy(`columnName`: string \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>, `order?`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \| +`order?` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1373 + +▸ OrderBy(`columnDefs`: (keyof TRecord \\\| Readonly<{ `column`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| keyof TRecord ; `order?`: asc \\\| desc }\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnDefs` \| (keyof TRecord \\\| Readonly<{ `column`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| keyof TRecord ; `order?`: asc \\\| desc }\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1374 + +▸ OrderBy(`columnDefs`: (string \\\| Readonly<{ `column`: string \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> ; `order?`: string }\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnDefs` \| (string \\\| Readonly<{ `column`: string \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> ; `order?`: string }\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1382 diff --git a/knex.knex-1.pgconnectionconfig.md b/knex.knex-1.pgconnectionconfig.md index 7f7bd3c..719af99 100644 --- a/knex.knex-1.pgconnectionconfig.md +++ b/knex.knex-1.pgconnectionconfig.md @@ -0,0 +1,115 @@ +--- +id: "knex.knex-1.pgconnectionconfig" +title: "Interface: PgConnectionConfig" +sidebar_label: "PgConnectionConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: PgConnectionConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PgConnectionConfig + +## Properties + +### application\\_name + +• `Optional` application\\_name: string + +Defined in: node_modules/knex/types/index.d.ts:2057 + +___ + +### connectionString + +• `Optional` connectionString: string + +Defined in: node_modules/knex/types/index.d.ts:2050 + +___ + +### connectionTimeoutMillis + +• `Optional` connectionTimeoutMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2054 + +___ + +### database + +• `Optional` database: string + +Defined in: node_modules/knex/types/index.d.ts:2046 + +___ + +### host + +• `Optional` host: string + +Defined in: node_modules/knex/types/index.d.ts:2049 + +___ + +### keepAlive + +• `Optional` keepAlive: boolean + +Defined in: node_modules/knex/types/index.d.ts:2051 + +___ + +### keepAliveInitialDelayMillis + +• `Optional` keepAliveInitialDelayMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2055 + +___ + +### password + +• `Optional` password: string + +Defined in: node_modules/knex/types/index.d.ts:2047 + +___ + +### port + +• `Optional` port: number + +Defined in: node_modules/knex/types/index.d.ts:2048 + +___ + +### ssl + +• `Optional` ssl: boolean \\\| ConnectionOptions + +Defined in: node_modules/knex/types/index.d.ts:2056 + +___ + +### statement\\_timeout + +• `Optional` statement\\_timeout: number \\\| false + +Defined in: node_modules/knex/types/index.d.ts:2053 + +___ + +### stream + +• `Optional` stream: Duplex + +Defined in: node_modules/knex/types/index.d.ts:2052 + +___ + +### user + +• `Optional` user: string + +Defined in: node_modules/knex/types/index.d.ts:2045 diff --git a/knex.knex-1.poolconfig.md b/knex.knex-1.poolconfig.md index a3314ce..75b32f2 100644 --- a/knex.knex-1.poolconfig.md +++ b/knex.knex-1.poolconfig.md @@ -0,0 +1,146 @@ +--- +id: "knex.knex-1.poolconfig" +title: "Interface: PoolConfig" +sidebar_label: "PoolConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: PoolConfig + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PoolConfig + +## Properties + +### acquireTimeoutMillis + +• `Optional` acquireTimeoutMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2095 + +___ + +### afterCreate + +• `Optional` afterCreate: Function + +Defined in: node_modules/knex/types/index.d.ts:2080 + +___ + +### createRetryIntervalMillis + +• `Optional` createRetryIntervalMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2092 + +___ + +### createTimeoutMillis + +• `Optional` createTimeoutMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2093 + +___ + +### destroyTimeoutMillis + +• `Optional` destroyTimeoutMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2094 + +___ + +### idleTimeoutMillis + +• `Optional` idleTimeoutMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2084 + +___ + +### log + +• `Optional` log: (`message`: string, `logLevel`: string) => void + +#### Type declaration: + +▸ (`message`: string, `logLevel`: string): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`message` \| string \| +`logLevel` \| string \| + +Returns: void + +Defined in: node_modules/knex/types/index.d.ts:2088 + +Defined in: node_modules/knex/types/index.d.ts:2088 + +___ + +### max + +• `Optional` max: number + +Defined in: node_modules/knex/types/index.d.ts:2082 + +___ + +### min + +• `Optional` min: number + +Defined in: node_modules/knex/types/index.d.ts:2081 + +___ + +### name + +• `Optional` name: string + +Defined in: node_modules/knex/types/index.d.ts:2079 + +___ + +### priorityRange + +• `Optional` priorityRange: number + +Defined in: node_modules/knex/types/index.d.ts:2087 + +___ + +### propagateCreateError + +• `Optional` propagateCreateError: boolean + +Defined in: node_modules/knex/types/index.d.ts:2091 + +___ + +### reapIntervalMillis + +• `Optional` reapIntervalMillis: number + +Defined in: node_modules/knex/types/index.d.ts:2085 + +___ + +### refreshIdle + +• `Optional` refreshIdle: boolean + +Defined in: node_modules/knex/types/index.d.ts:2083 + +___ + +### returnToHead + +• `Optional` returnToHead: boolean + +Defined in: node_modules/knex/types/index.d.ts:2086 diff --git a/knex.knex-1.postgresqlcolumnbuilder.md b/knex.knex-1.postgresqlcolumnbuilder.md index 7916828..dd9612a 100644 --- a/knex.knex-1.postgresqlcolumnbuilder.md +++ b/knex.knex-1.postgresqlcolumnbuilder.md @@ -0,0 +1,276 @@ +--- +id: "knex.knex-1.postgresqlcolumnbuilder" +title: "Interface: PostgreSqlColumnBuilder" +sidebar_label: "PostgreSqlColumnBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: PostgreSqlColumnBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).PostgreSqlColumnBuilder + +## Hierarchy + +* [ColumnBuilder](knex.knex-1.columnbuilder.md) + + ↳ PostgreSqlColumnBuilder + +## Methods + +### after + +▸ after(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1817 + +___ + +### alter + +▸ alter(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1814 + +___ + +### comment + +▸ comment(`value`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1813 + +___ + +### defaultTo + +▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1809 + +___ + +### first + +▸ first(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1818 + +___ + +### index + +▸ index(`indexName?`: string, `indexType?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| +`indexType?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Overrides: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1830 + +___ + +### notNullable + +▸ notNullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1811 + +___ + +### nullable + +▸ nullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1812 + +___ + +### onDelete + +▸ onDelete(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1807 + +___ + +### onUpdate + +▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1808 + +___ + +### primary + +▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1804 + +___ + +### queryContext + +▸ queryContext(`context`: any): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1815 + +___ + +### references + +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1806 + +___ + +### unique + +▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1805 + +___ + +### unsigned + +▸ unsigned(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1810 + +___ + +### withKeyName + +▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`keyName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1816 diff --git a/knex.knex-1.queryinterface.md b/knex.knex-1.queryinterface.md index cf41301..b275b08 100644 --- a/knex.knex-1.queryinterface.md +++ b/knex.knex-1.queryinterface.md @@ -0,0 +1,1547 @@ +--- +id: "knex.knex-1.queryinterface" +title: "Interface: QueryInterface<TRecord, TResult>" +sidebar_label: "QueryInterface" +custom_edit_url: null +hide_title: true +--- + +# Interface: QueryInterface<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).QueryInterface + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| any \| + +## Hierarchy + +* QueryInterface + + ↳ [Knex](knex.knex-2.md) + + ↳ [QueryBuilder](../classes/knex.knex-1.querybuilder.md) + +## Properties + +### andHaving + +• andHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:544 + +___ + +### andWhere + +• andWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:498 + +___ + +### andWhereBetween + +• andWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:522 + +___ + +### andWhereNot + +• andWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:501 + +___ + +### andWhereNotBetween + +• andWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:525 + +___ + +### andWhereRaw + +• andWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:505 + +___ + +### as + +• as: [As](knex.knex-1.as.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:467 + +___ + +### avg + +• avg: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:587 + +___ + +### avgDistinct + +• avgDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:588 + +___ + +### column + +• column: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:469 + +___ + +### columns + +• columns: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:468 + +___ + +### count + +• count: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Defined in: node_modules/knex/types/index.d.ts:581 + +___ + +### countDistinct + +• countDistinct: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Defined in: node_modules/knex/types/index.d.ts:582 + +___ + +### crossJoin + +• crossJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:487 + +___ + +### distinct + +• distinct: [Distinct](knex.knex-1.distinct.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:474 + +___ + +### distinctOn + +• distinctOn: [DistinctOn](knex.knex-1.distincton.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:475 + +___ + +### first + +• first: [Select](knex.knex-1.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:609 + +___ + +### from + +• from: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:471 + +___ + +### fullOuterJoin + +• fullOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:486 + +___ + +### groupBy + +• groupBy: [GroupBy](knex.knex-1.groupby.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:528 + +___ + +### groupByRaw + +• groupByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:529 + +___ + +### having + +• having: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:543 + +___ + +### havingBetween + +• havingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:552 + +___ + +### havingIn + +• havingIn: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:548 + +___ + +### havingNotBetween + +• havingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:550 + +___ + +### havingRaw + +• havingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:545 + +___ + +### havingWrapped + +• havingWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:507 + +___ + +### hintComment + +• hintComment: [HintComment](knex.knex-1.hintcomment.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:470 + +___ + +### innerJoin + +• innerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:480 + +___ + +### intersect + +• intersect: [Intersect](knex.knex-1.intersect.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:536 + +___ + +### into + +• into: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:472 + +___ + +### join + +• join: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:478 + +___ + +### joinRaw + +• joinRaw: [JoinRaw](knex.knex-1.joinraw.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:479 + +___ + +### leftJoin + +• leftJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:481 + +___ + +### leftOuterJoin + +• leftOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:482 + +___ + +### max + +• max: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:584 + +___ + +### min + +• min: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:583 + +___ + +### orHaving + +• orHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:546 + +___ + +### orHavingBetween + +• orHavingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:551 + +___ + +### orHavingNotBetween + +• orHavingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:549 + +___ + +### orHavingRaw + +• orHavingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:547 + +___ + +### orWhere + +• orWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:499 + +___ + +### orWhereBetween + +• orWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:521 + +___ + +### orWhereExists + +• orWhereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:509 + +___ + +### orWhereIn + +• orWhereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:513 + +___ + +### orWhereNot + +• orWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:502 + +___ + +### orWhereNotBetween + +• orWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:524 + +___ + +### orWhereNotExists + +• orWhereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:511 + +___ + +### orWhereNotIn + +• orWhereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:515 + +___ + +### orWhereNotNull + +• orWhereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:519 + +___ + +### orWhereNull + +• orWhereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:517 + +___ + +### orWhereRaw + +• orWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:504 + +___ + +### orderBy + +• orderBy: [OrderBy](knex.knex-1.orderby.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:532 + +___ + +### orderByRaw + +• orderByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:533 + +___ + +### outerJoin + +• outerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:485 + +___ + +### rightJoin + +• rightJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:483 + +___ + +### rightOuterJoin + +• rightOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:484 + +___ + +### select + +• select: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:466 + +___ + +### sum + +• sum: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:585 + +___ + +### sumDistinct + +• sumDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Defined in: node_modules/knex/types/index.d.ts:586 + +___ + +### table + +• table: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:473 + +___ + +### union + +• union: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:539 + +___ + +### unionAll + +• unionAll: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:540 + +___ + +### where + +• where: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:497 + +___ + +### whereBetween + +• whereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:520 + +___ + +### whereExists + +• whereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:508 + +___ + +### whereIn + +• whereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:512 + +___ + +### whereNot + +• whereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:500 + +___ + +### whereNotBetween + +• whereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:523 + +___ + +### whereNotExists + +• whereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:510 + +___ + +### whereNotIn + +• whereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:514 + +___ + +### whereNotNull + +• whereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:518 + +___ + +### whereNull + +• whereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:516 + +___ + +### whereRaw + +• whereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:503 + +___ + +### whereWrapped + +• whereWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:506 + +___ + +### with + +• with: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:490 + +___ + +### withRaw + +• withRaw: [WithRaw](knex.knex-1.withraw.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:492 + +___ + +### withRecursive + +• withRecursive: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:491 + +___ + +### withSchema + +• withSchema: [WithSchema](knex.knex-1.withschema.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:493 + +___ + +### withWrapped + +• withWrapped: [WithWrapped](knex.knex-1.withwrapped.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:494 + +## Methods + +### clear + +▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:574 + +___ + +### clearCounters + +▸ clearCounters(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:573 + +___ + +### clearGroup + +▸ clearGroup(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:570 + +___ + +### clearHaving + +▸ clearHaving(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:572 + +___ + +### clearOrder + +▸ clearOrder(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:571 + +___ + +### clearSelect + +▸ clearSelect(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:555 + +___ + +### clearWhere + +▸ clearWhere(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:569 + +___ + +### decrement + +▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Defined in: node_modules/knex/types/index.d.ts:599 + +▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Defined in: node_modules/knex/types/index.d.ts:603 + +___ + +### del + +▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:833 + +▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:837 + +▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +Defined in: node_modules/knex/types/index.d.ts:848 + +▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:859 + +▸ del<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:863 + +___ + +### delete + +▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:865 + +▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:869 + +▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:880 + +▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:891 + +▸ delete<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:895 + +___ + +### increment + +▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Defined in: node_modules/knex/types/index.d.ts:590 + +▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Defined in: node_modules/knex/types/index.d.ts:594 + +___ + +### insert + +▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| * \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:616 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:623 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:637 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:651 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:665 + +▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:679 + +___ + +### limit + +▸ limit(`limit`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`limit` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:578 + +___ + +### modify + +▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord2` \| object \| any \| +`TResult2` \| object \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| +`...args` \| any[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:685 + +___ + +### offset + +▸ offset(`offset`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`offset` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:577 + +___ + +### onConflict + +▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:813 + +▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:823 + +___ + +### pluck + +▸ pluck<K\\>(`column`: K): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| K \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +Defined in: node_modules/knex/types/index.d.ts:611 + +▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TResult2` \| object \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:614 + +___ + +### returning + +▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:786 + +▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:787 + +▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:798 + +▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:808 + +___ + +### truncate + +▸ truncate(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Defined in: node_modules/knex/types/index.d.ts:897 + +___ + +### update + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| K2 \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:689 + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| readonly K2[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:703 + +▸ update<K\\>(`columnName`: K, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Defined in: node_modules/knex/types/index.d.ts:717 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:721 + +▸ update(`data`: [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:727 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:732 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:744 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| string \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \\\| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:756 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:768 + +▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:780 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:784 diff --git a/knex.knex-1.raw.md b/knex.knex-1.raw.md index b80493f..3858485 100644 --- a/knex.knex-1.raw.md +++ b/knex.knex-1.raw.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.raw" +id: "knex.knex-1.raw" title: "Interface: Raw<TResult>" sidebar_label: "Raw" +custom_edit_url: null hide_title: true --- @@ -12,18 +13,18 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| any \| ## Hierarchy * EventEmitter -* [ChainableInterface](knex.knex.chainableinterface.md)<ResolveResult<TResult\\>\\> +* [ChainableInterface](knex.knex-1.chainableinterface.md)<ResolveResult<TResult\\>\\> ↳ Raw - ↳↳ [Ref](knex.knex.ref.md) + ↳↳ [Ref](knex.knex-1.ref.md) ## Properties @@ -31,108 +32,110 @@ Name \| Default \| • `Readonly` [Symbol.toStringTag]: string -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md).[[Symbol.toStringTag]](knex.knex.chainableinterface.md#[symbol.tostringtag]) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md).[[Symbol.toStringTag]](knex.knex-1.chainableinterface.md#[symbol.tostringtag]) -Defined in: node_modules/knex/types/index.d.ts:1639 +Defined in: node_modules/knex/types/index.d.ts:1645 ## Methods ### addListener -▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:57 +Defined in: node_modules/@types/node/events.d.ts:62 ___ ### asCallback -▸ asCallback(`callback`: Function): Promise<Resolve<TResult\\>\\> +▸ asCallback(`callback`: Function): Promise<Resolve<TResult\\>\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| Function \| -Returns: Promise<Resolve<TResult\\>\\> +Returns: Promise<Resolve<TResult\\>\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1657 +Defined in: node_modules/knex/types/index.d.ts:1663 ___ ### catch -▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> +▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<Resolve<TResult\\> \\\| TResult\\> Attaches a callback for only the rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| -Returns: Promise<Resolve<TResult\\> \\\| TResult\\> +Returns: Promise<Resolve<TResult\\> \\\| TResult\\> A Promise for the completion of the callback. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 ___ ### connection -▸ connection(`connection`: any): [Raw](knex.knex.raw.md)<TResult\\> +▸ connection(`connection`: any): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1644 +Defined in: node_modules/knex/types/index.d.ts:1650 ___ ### debug -▸ debug(`enabled`: boolean): [Raw](knex.knex.raw.md)<TResult\\> +▸ debug(`enabled`: boolean): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `enabled` \| boolean \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1645 +Defined in: node_modules/knex/types/index.d.ts:1651 ___ @@ -143,13 +146,15 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `...args` \| any[] \| Returns: boolean -Defined in: node_modules/@types/node/events.d.ts:67 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:72 ___ @@ -159,13 +164,15 @@ ___ Returns: (string \\\| symbol)[] -Defined in: node_modules/@types/node/events.d.ts:72 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:77 ___ ### finally -▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> +▸ finally(`onfinally?`: null \\\| () => void): Promise<Resolve<TResult\\>\\> Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback. @@ -173,14 +180,14 @@ resolved value cannot be modified from the callback. #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| -Returns: Promise<Resolve<TResult\\>\\> +Returns: Promise<Resolve<TResult\\>\\> A Promise for the completion of the callback. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 @@ -192,7 +199,9 @@ ___ Returns: number -Defined in: node_modules/@types/node/events.d.ts:64 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:69 ___ @@ -203,12 +212,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: number -Defined in: node_modules/@types/node/events.d.ts:68 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:73 ___ @@ -219,81 +230,89 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Defined in: node_modules/@types/node/events.d.ts:65 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:70 ___ ### off -▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:61 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:66 ___ ### on -▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> + +Inherited from: void -Defined in: node_modules/@types/node/events.d.ts:58 +Defined in: node_modules/@types/node/events.d.ts:63 ___ ### once -▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:59 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:64 ___ ### options -▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [Raw](knex.knex.raw.md)<TResult\\> +▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1643 +Defined in: node_modules/knex/types/index.d.ts:1649 ___ @@ -304,77 +323,81 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| WritableStream<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `writable` \| T \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1653 +Defined in: node_modules/knex/types/index.d.ts:1659 ___ ### prependListener -▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:70 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:75 ___ ### prependOnceListener -▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:71 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:76 ___ ### queryContext -▸ queryContext(`context`: any): [Raw](knex.knex.raw.md)<TResult\\> +▸ queryContext(`context`: any): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `context` \| any \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1502 +Defined in: node_modules/knex/types/index.d.ts:1508 ▸ queryContext(): any Returns: any -Defined in: node_modules/knex/types/index.d.ts:1503 +Defined in: node_modules/knex/types/index.d.ts:1509 ___ @@ -385,108 +408,116 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Defined in: node_modules/@types/node/events.d.ts:66 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:71 ___ ### removeAllListeners -▸ removeAllListeners(`event?`: string \\\| symbol): [Raw](knex.knex.raw.md)<TResult\\> +▸ removeAllListeners(`event?`: string \\\| symbol): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event?` \| string \\\| symbol \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:62 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:67 ___ ### removeListener -▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex.raw.md)<TResult\\> +▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:60 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:65 ___ ### setMaxListeners -▸ setMaxListeners(`n`: number): [Raw](knex.knex.raw.md)<TResult\\> +▸ setMaxListeners(`n`: number): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `n` \| number \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/@types/node/events.d.ts:63 +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:68 ___ ### stream -▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1647 +Defined in: node_modules/knex/types/index.d.ts:1653 -▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1648 +Defined in: node_modules/knex/types/index.d.ts:1654 ▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1652 +Defined in: node_modules/knex/types/index.d.ts:1658 ___ @@ -499,14 +530,14 @@ Attaches callbacks for the resolution and/or rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| -`TResult1` \| Resolve<TResult\\\\> \| +:------ \| :------ \| +`TResult1` \| Resolve<TResult\\> \| `TResult2` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfulfilled?` \| null \\\| (`value`: Resolve<TResult\\>) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| `onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| @@ -514,26 +545,27 @@ Name \| Type \| Description \| A Promise for the completion of which ever callback is executed. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 ___ ### timeout -▸ timeout(`ms`: number, `options?`: { `cancel?`: undefined \\\| boolean }): [Raw](knex.knex.raw.md)<TResult\\> +▸ timeout(`ms`: number, `options?`: { `cancel?`: boolean }): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ms` \| number \| -`options?` \| { `cancel?`: undefined \\\| boolean } \| +`options?` \| object \| +`options.cancel?` \| boolean \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1499 +Defined in: node_modules/knex/types/index.d.ts:1505 ___ @@ -543,57 +575,57 @@ ___ Returns: string -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1642 +Defined in: node_modules/knex/types/index.d.ts:1648 ___ ### toSQL -▸ toSQL(): [Sql](knex.knex.sql.md) +▸ toSQL(): [Sql](knex.knex-1.sql.md) -Returns: [Sql](knex.knex.sql.md) +Returns: [Sql](knex.knex-1.sql.md) -Defined in: node_modules/knex/types/index.d.ts:1501 +Defined in: node_modules/knex/types/index.d.ts:1507 ___ ### transacting -▸ transacting(`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>): [Raw](knex.knex.raw.md)<TResult\\> +▸ transacting(`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>): [Raw](knex.knex-1.raw.md)<TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`trx` \| [Transaction](knex.knex-1.transaction.md)<any, any\\> \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1646 +Defined in: node_modules/knex/types/index.d.ts:1652 ___ ### wrap -▸ wrap<TResult2\\>(`before`: string, `after`: string): [Raw](knex.knex.raw.md)<TResult\\> +▸ wrap<TResult2\\>(`before`: string, `after`: string): [Raw](knex.knex-1.raw.md)<TResult\\> #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult2` \| TResult \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `before` \| string \| `after` \| string \| -Returns: [Raw](knex.knex.raw.md)<TResult\\> +Returns: [Raw](knex.knex-1.raw.md)<TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1500 +Defined in: node_modules/knex/types/index.d.ts:1506 diff --git a/knex.knex-1.rawbuilder.md b/knex.knex-1.rawbuilder.md index 346875e..7bcd996 100644 --- a/knex.knex-1.rawbuilder.md +++ b/knex.knex-1.rawbuilder.md @@ -0,0 +1,76 @@ +--- +id: "knex.knex-1.rawbuilder" +title: "Interface: RawBuilder<TRecord, TResult>" +sidebar_label: "RawBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: RawBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RawBuilder + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| any \| + +## Callable + +▸ RawBuilder<TResult2\\>(`value`: [Value](../modules/knex.knex-1.md#value)): [Raw](knex.knex-1.raw.md)<TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [Raw](knex.knex-1.raw.md)<TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1512 + +▸ RawBuilder<TResult2\\>(`sql`: string, ...`bindings`: readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [Raw](knex.knex-1.raw.md)<TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`...bindings` \| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [Raw](knex.knex-1.raw.md)<TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1513 + +▸ RawBuilder<TResult2\\>(`sql`: string, `bindings`: [ValueDict](knex.knex-1.valuedict.md) \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [Raw](knex.knex-1.raw.md)<TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`bindings` \| [ValueDict](knex.knex-1.valuedict.md) \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [Raw](knex.knex-1.raw.md)<TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1514 diff --git a/knex.knex-1.rawquerybuilder.md b/knex.knex-1.rawquerybuilder.md index 4618bc8..fc22b2e 100644 --- a/knex.knex-1.rawquerybuilder.md +++ b/knex.knex-1.rawquerybuilder.md @@ -0,0 +1,65 @@ +--- +id: "knex.knex-1.rawquerybuilder" +title: "Interface: RawQueryBuilder<TRecord, TResult>" +sidebar_label: "RawQueryBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: RawQueryBuilder<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RawQueryBuilder + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* RawQueryBuilder + + ↳ [WhereRaw](knex.knex-1.whereraw.md) + + ↳ [GroupBy](knex.knex-1.groupby.md) + +## Callable + +▸ RawQueryBuilder<TResult2\\>(`sql`: string, `bindings?`: [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`bindings?` \| [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1489 + +▸ RawQueryBuilder<TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<TResult2\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1493 diff --git a/knex.knex-1.ref.md b/knex.knex-1.ref.md index 4f4ace2..4befd39 100644 --- a/knex.knex-1.ref.md +++ b/knex.knex-1.ref.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.ref" +id: "knex.knex-1.ref" title: "Interface: Ref<TSrc, TMapping>" sidebar_label: "Ref" +custom_edit_url: null hide_title: true --- @@ -12,163 +13,163 @@ hide_title: true ## Type parameters Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `TSrc` \| string \| -`TMapping` \| {} \| +`TMapping` \| object \| ## Hierarchy -* [Raw](knex.knex.raw.md)<string\\> +* [Raw](knex.knex-1.raw.md)<string\\> ↳ Ref ## Properties -### [Symbol.toStringTag] +### [RefMemberTag] -• `Readonly` [Symbol.toStringTag]: string +• [RefMemberTag]: object -Inherited from: [Raw](knex.knex.raw.md).[[Symbol.toStringTag]](knex.knex.raw.md#[symbol.tostringtag]) +#### Type declaration: -Defined in: node_modules/knex/types/index.d.ts:1639 +Name \| Type \| +:------ \| :------ \| +`mapping` \| TMapping \| +`src` \| TSrc \| + +Defined in: node_modules/knex/types/index.d.ts:1532 ___ -### \\_\\_@RefMemberTag@52085 +### [Symbol.toStringTag] -• \\_\\_@RefMemberTag@52085: { `mapping`: TMapping ; `src`: TSrc } +• `Readonly` [Symbol.toStringTag]: string -#### Type declaration: +Inherited from: [Raw](knex.knex-1.raw.md).[[Symbol.toStringTag]](knex.knex-1.raw.md#[symbol.tostringtag]) -Name \| Type \| ------- \| ------ \| -`mapping` \| TMapping \| -`src` \| TSrc \| - -Defined in: node_modules/knex/types/index.d.ts:1526 +Defined in: node_modules/knex/types/index.d.ts:1645 ## Methods ### addListener -▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:57 +Defined in: node_modules/@types/node/events.d.ts:62 ___ ### as -▸ as<TAlias\\>(`alias`: TAlias): [Ref](knex.knex.ref.md)<TSrc, { [K in string]: TSrc}\\> +▸ as<TAlias\\>(`alias`: TAlias): [Ref](knex.knex-1.ref.md)<TSrc, { [K in string]: TSrc}\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `TAlias` \| string \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias` \| TAlias \| -Returns: [Ref](knex.knex.ref.md)<TSrc, { [K in string]: TSrc}\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, { [K in string]: TSrc}\\> -Defined in: node_modules/knex/types/index.d.ts:1531 +Defined in: node_modules/knex/types/index.d.ts:1537 ___ ### asCallback -▸ asCallback(`callback`: Function): Promise<string\\> +▸ asCallback(`callback`: Function): Promise<string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| Function \| -Returns: Promise<string\\> +Returns: Promise<string\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1657 +Defined in: node_modules/knex/types/index.d.ts:1663 ___ ### catch -▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<string \\\| TResult\\> +▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<string \\\| TResult\\> Attaches a callback for only the rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| -Returns: Promise<string \\\| TResult\\> +Returns: Promise<string \\\| TResult\\> A Promise for the completion of the callback. -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 ___ ### connection -▸ connection(`connection`: any): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ connection(`connection`: any): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1644 +Defined in: node_modules/knex/types/index.d.ts:1650 ___ ### debug -▸ debug(`enabled`: boolean): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ debug(`enabled`: boolean): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `enabled` \| boolean \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1645 +Defined in: node_modules/knex/types/index.d.ts:1651 ___ @@ -179,15 +180,15 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `...args` \| any[] \| Returns: boolean -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:67 +Defined in: node_modules/@types/node/events.d.ts:72 ___ @@ -197,15 +198,15 @@ ___ Returns: (string \\\| symbol)[] -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:72 +Defined in: node_modules/@types/node/events.d.ts:77 ___ ### finally -▸ finally(`onfinally?`: null \\\| () => void): Promise<string\\> +▸ finally(`onfinally?`: null \\\| () => void): Promise<string\\> Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback. @@ -213,14 +214,14 @@ resolved value cannot be modified from the callback. #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| -Returns: Promise<string\\> +Returns: Promise<string\\> A Promise for the completion of the callback. -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 @@ -232,9 +233,9 @@ ___ Returns: number -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:64 +Defined in: node_modules/@types/node/events.d.ts:69 ___ @@ -245,14 +246,14 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: number -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:68 +Defined in: node_modules/@types/node/events.d.ts:73 ___ @@ -263,89 +264,89 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:65 +Defined in: node_modules/@types/node/events.d.ts:70 ___ ### off -▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:61 +Defined in: node_modules/@types/node/events.d.ts:66 ___ ### on -▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:58 +Defined in: node_modules/@types/node/events.d.ts:63 ___ ### once -▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:59 +Defined in: node_modules/@types/node/events.d.ts:64 ___ ### options -▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1643 +Defined in: node_modules/knex/types/index.d.ts:1649 ___ @@ -356,85 +357,85 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| WritableStream<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `writable` \| T \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1653 +Defined in: node_modules/knex/types/index.d.ts:1659 ___ ### prependListener -▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:70 +Defined in: node_modules/@types/node/events.d.ts:75 ___ ### prependOnceListener -▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:71 +Defined in: node_modules/@types/node/events.d.ts:76 ___ ### queryContext -▸ queryContext(`context`: any): [Raw](knex.knex.raw.md)<string\\> +▸ queryContext(`context`: any): [Raw](knex.knex-1.raw.md)<string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `context` \| any \| -Returns: [Raw](knex.knex.raw.md)<string\\> +Returns: [Raw](knex.knex-1.raw.md)<string\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1502 +Defined in: node_modules/knex/types/index.d.ts:1508 ▸ queryContext(): any Returns: any -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1503 +Defined in: node_modules/knex/types/index.d.ts:1509 ___ @@ -445,116 +446,116 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| Returns: Function[] -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:66 +Defined in: node_modules/@types/node/events.d.ts:71 ___ ### removeAllListeners -▸ removeAllListeners(`event?`: string \\\| symbol): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ removeAllListeners(`event?`: string \\\| symbol): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event?` \| string \\\| symbol \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:62 +Defined in: node_modules/@types/node/events.d.ts:67 ___ ### removeListener -▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `event` \| string \\\| symbol \| `listener` \| (...`args`: any[]) => void \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:60 +Defined in: node_modules/@types/node/events.d.ts:65 ___ ### setMaxListeners -▸ setMaxListeners(`n`: number): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ setMaxListeners(`n`: number): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `n` \| number \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/@types/node/events.d.ts:63 +Defined in: node_modules/@types/node/events.d.ts:68 ___ ### stream -▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1647 +Defined in: node_modules/knex/types/index.d.ts:1653 -▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1648 +Defined in: node_modules/knex/types/index.d.ts:1654 ▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1652 +Defined in: node_modules/knex/types/index.d.ts:1658 ___ @@ -567,14 +568,14 @@ Attaches callbacks for the resolution and/or rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult1` \| string \| `TResult2` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfulfilled?` \| null \\\| (`value`: string) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| `onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| @@ -582,28 +583,29 @@ Name \| Type \| Description \| A Promise for the completion of which ever callback is executed. -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 ___ ### timeout -▸ timeout(`ms`: number, `options?`: { `cancel?`: undefined \\\| boolean }): [Raw](knex.knex.raw.md)<string\\> +▸ timeout(`ms`: number, `options?`: { `cancel?`: boolean }): [Raw](knex.knex-1.raw.md)<string\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `ms` \| number \| -`options?` \| { `cancel?`: undefined \\\| boolean } \| +`options?` \| object \| +`options.cancel?` \| boolean \| -Returns: [Raw](knex.knex.raw.md)<string\\> +Returns: [Raw](knex.knex-1.raw.md)<string\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1499 +Defined in: node_modules/knex/types/index.d.ts:1505 ___ @@ -613,77 +615,77 @@ ___ Returns: string -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1642 +Defined in: node_modules/knex/types/index.d.ts:1648 ___ ### toSQL -▸ toSQL(): [Sql](knex.knex.sql.md) +▸ toSQL(): [Sql](knex.knex-1.sql.md) -Returns: [Sql](knex.knex.sql.md) +Returns: [Sql](knex.knex-1.sql.md) -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1501 +Defined in: node_modules/knex/types/index.d.ts:1507 ___ ### transacting -▸ transacting(`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ transacting(`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`trx` \| [Transaction](knex.knex-1.transaction.md)<any, any\\> \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1646 +Defined in: node_modules/knex/types/index.d.ts:1652 ___ ### withSchema -▸ withSchema(`schema`: string): [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +▸ withSchema(`schema`: string): [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schema` \| string \| -Returns: [Ref](knex.knex.ref.md)<TSrc, TMapping\\> +Returns: [Ref](knex.knex-1.ref.md)<TSrc, TMapping\\> -Defined in: node_modules/knex/types/index.d.ts:1530 +Defined in: node_modules/knex/types/index.d.ts:1536 ___ ### wrap -▸ wrap<TResult2\\>(`before`: string, `after`: string): [Raw](knex.knex.raw.md)<string\\> +▸ wrap<TResult2\\>(`before`: string, `after`: string): [Raw](knex.knex-1.raw.md)<string\\> #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult2` \| string \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `before` \| string \| `after` \| string \| -Returns: [Raw](knex.knex.raw.md)<string\\> +Returns: [Raw](knex.knex-1.raw.md)<string\\> -Inherited from: [Raw](knex.knex.raw.md) +Inherited from: [Raw](knex.knex-1.raw.md) -Defined in: node_modules/knex/types/index.d.ts:1500 +Defined in: node_modules/knex/types/index.d.ts:1506 diff --git a/knex.knex-1.refbuilder.md b/knex.knex-1.refbuilder.md index 71b18c6..c815f4a 100644 --- a/knex.knex-1.refbuilder.md +++ b/knex.knex-1.refbuilder.md @@ -0,0 +1,31 @@ +--- +id: "knex.knex-1.refbuilder" +title: "Interface: RefBuilder" +sidebar_label: "RefBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: RefBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).RefBuilder + +## Callable + +▸ RefBuilder<TSrc\\>(`src`: TSrc): [Ref](knex.knex-1.ref.md)<TSrc, { [K in string]: TSrc}\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TSrc` \| string \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`src` \| TSrc \| + +Returns: [Ref](knex.knex-1.ref.md)<TSrc, { [K in string]: TSrc}\\> + +Defined in: node_modules/knex/types/index.d.ts:1540 diff --git a/knex.knex-1.referencingcolumnbuilder.md b/knex.knex-1.referencingcolumnbuilder.md index 98f95ae..7d010a6 100644 --- a/knex.knex-1.referencingcolumnbuilder.md +++ b/knex.knex-1.referencingcolumnbuilder.md @@ -0,0 +1,291 @@ +--- +id: "knex.knex-1.referencingcolumnbuilder" +title: "Interface: ReferencingColumnBuilder" +sidebar_label: "ReferencingColumnBuilder" +custom_edit_url: null +hide_title: true +--- + +# Interface: ReferencingColumnBuilder + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).ReferencingColumnBuilder + +## Hierarchy + +* [ColumnBuilder](knex.knex-1.columnbuilder.md) + + ↳ ReferencingColumnBuilder + +## Methods + +### after + +▸ after(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1817 + +___ + +### alter + +▸ alter(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1814 + +___ + +### comment + +▸ comment(`value`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1813 + +___ + +### defaultTo + +▸ defaultTo(`value`: [Value](../modules/knex.knex-1.md#value)): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1809 + +___ + +### first + +▸ first(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1818 + +___ + +### inTable + +▸ inTable(`tableName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1834 + +___ + +### index + +▸ index(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1803 + +___ + +### notNullable + +▸ notNullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1811 + +___ + +### nullable + +▸ nullable(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1812 + +___ + +### onDelete + +▸ onDelete(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1807 + +___ + +### onUpdate + +▸ onUpdate(`command`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`command` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1808 + +___ + +### primary + +▸ primary(`constraintName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`constraintName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1804 + +___ + +### queryContext + +▸ queryContext(`context`: any): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`context` \| any \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1815 + +___ + +### references + +▸ references(`columnName`: string): [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [ReferencingColumnBuilder](knex.knex-1.referencingcolumnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1806 + +___ + +### unique + +▸ unique(`indexName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`indexName?` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1805 + +___ + +### unsigned + +▸ unsigned(): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1810 + +___ + +### withKeyName + +▸ withKeyName(`keyName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`keyName` \| string \| + +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Inherited from: [ColumnBuilder](knex.knex-1.columnbuilder.md) + +Defined in: node_modules/knex/types/index.d.ts:1816 diff --git a/knex.knex-1.schemabuilder.md b/knex.knex-1.schemabuilder.md index eff85aa..75e86c5 100644 --- a/knex.knex-1.schemabuilder.md +++ b/knex.knex-1.schemabuilder.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.schemabuilder" +id: "knex.knex-1.schemabuilder" title: "Interface: SchemaBuilder" sidebar_label: "SchemaBuilder" +custom_edit_url: null hide_title: true --- @@ -11,7 +12,7 @@ hide_title: true ## Hierarchy -* [ChainableInterface](knex.knex.chainableinterface.md)<void\\> +* [ChainableInterface](knex.knex-1.chainableinterface.md)<void\\> ↳ SchemaBuilder @@ -21,244 +22,244 @@ hide_title: true • `Readonly` [Symbol.toStringTag]: string -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md).[[Symbol.toStringTag]](knex.knex.chainableinterface.md#[symbol.tostringtag]) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md).[[Symbol.toStringTag]](knex.knex-1.chainableinterface.md#[symbol.tostringtag]) -Defined in: node_modules/knex/types/index.d.ts:1639 +Defined in: node_modules/knex/types/index.d.ts:1645 ## Methods ### alterTable -▸ alterTable(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ alterTable(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any \| +`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1693 +Defined in: node_modules/knex/types/index.d.ts:1699 ___ ### asCallback -▸ asCallback(`callback`: Function): Promise<void\\> +▸ asCallback(`callback`: Function): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| Function \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1657 +Defined in: node_modules/knex/types/index.d.ts:1663 ___ ### catch -▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<void \\\| TResult\\> +▸ catch<TResult\\>(`onrejected?`: null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\>): Promise<void \\\| TResult\\> Attaches a callback for only the rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onrejected?` \| null \\\| (`reason`: any) => TResult \\\| PromiseLike<TResult\\> \| The callback to execute when the Promise is rejected. \| -Returns: Promise<void \\\| TResult\\> +Returns: Promise<void \\\| TResult\\> A Promise for the completion of the callback. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1448 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1460 ___ ### connection -▸ connection(`connection`: any): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ connection(`connection`: any): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `connection` \| any \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1644 +Defined in: node_modules/knex/types/index.d.ts:1650 ___ ### createSchema -▸ createSchema(`schemaName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ createSchema(`schemaName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schemaName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1691 +Defined in: node_modules/knex/types/index.d.ts:1697 ___ ### createSchemaIfNotExists -▸ createSchemaIfNotExists(`schemaName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ createSchemaIfNotExists(`schemaName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schemaName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1692 +Defined in: node_modules/knex/types/index.d.ts:1698 ___ ### createTable -▸ createTable(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ createTable(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any \| +`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1683 +Defined in: node_modules/knex/types/index.d.ts:1689 ___ ### createTableIfNotExists -▸ createTableIfNotExists(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ createTableIfNotExists(`tableName`: string, `callback`: (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex.createtablebuilder.md)) => any \| +`callback` \| (`tableBuilder`: [CreateTableBuilder](knex.knex-1.createtablebuilder.md)) => any \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1687 +Defined in: node_modules/knex/types/index.d.ts:1693 ___ ### debug -▸ debug(`enabled`: boolean): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ debug(`enabled`: boolean): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `enabled` \| boolean \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1645 +Defined in: node_modules/knex/types/index.d.ts:1651 ___ ### dropSchema -▸ dropSchema(`schemaName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ dropSchema(`schemaName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schemaName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1706 +Defined in: node_modules/knex/types/index.d.ts:1712 ___ ### dropSchemaIfExists -▸ dropSchemaIfExists(`schemaName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ dropSchemaIfExists(`schemaName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schemaName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1707 +Defined in: node_modules/knex/types/index.d.ts:1713 ___ ### dropTable -▸ dropTable(`tableName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ dropTable(`tableName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1698 +Defined in: node_modules/knex/types/index.d.ts:1704 ___ ### dropTableIfExists -▸ dropTableIfExists(`tableName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ dropTableIfExists(`tableName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1705 +Defined in: node_modules/knex/types/index.d.ts:1711 ___ ### finally -▸ finally(`onfinally?`: null \\\| () => void): Promise<void\\> +▸ finally(`onfinally?`: null \\\| () => void): Promise<void\\> Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback. @@ -266,14 +267,14 @@ resolved value cannot be modified from the callback. #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfinally?` \| null \\\| () => void \| The callback to execute when the Promise is settled (fulfilled or rejected). \| -Returns: Promise<void\\> +Returns: Promise<void\\> A Promise for the completion of the callback. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) Defined in: docs/node_modules/typescript/lib/lib.es2018.promise.d.ts:31 @@ -281,52 +282,52 @@ ___ ### hasColumn -▸ hasColumn(`tableName`: string, `columnName`: string): Promise<boolean\\> +▸ hasColumn(`tableName`: string, `columnName`: string): Promise<boolean\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| `columnName` \| string \| -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: node_modules/knex/types/index.d.ts:1700 +Defined in: node_modules/knex/types/index.d.ts:1706 ___ ### hasTable -▸ hasTable(`tableName`: string): Promise<boolean\\> +▸ hasTable(`tableName`: string): Promise<boolean\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -Returns: Promise<boolean\\> +Returns: Promise<boolean\\> -Defined in: node_modules/knex/types/index.d.ts:1699 +Defined in: node_modules/knex/types/index.d.ts:1705 ___ ### options -▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ options(`options`: Readonly<{ [key: string]: any; }\\>): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1643 +Defined in: node_modules/knex/types/index.d.ts:1649 ___ @@ -337,134 +338,134 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| WritableStream<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `writable` \| T \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1653 +Defined in: node_modules/knex/types/index.d.ts:1659 ___ ### queryContext -▸ queryContext(`context`: any): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ queryContext(`context`: any): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `context` \| any \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1710 +Defined in: node_modules/knex/types/index.d.ts:1716 ___ ### raw -▸ raw(`statement`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ raw(`statement`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `statement` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1708 +Defined in: node_modules/knex/types/index.d.ts:1714 ___ ### renameTable -▸ renameTable(`oldTableName`: string, `newTableName`: string): Promise<void\\> +▸ renameTable(`oldTableName`: string, `newTableName`: string): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `oldTableName` \| string \| `newTableName` \| string \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: node_modules/knex/types/index.d.ts:1697 +Defined in: node_modules/knex/types/index.d.ts:1703 ___ ### stream -▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1647 +Defined in: node_modules/knex/types/index.d.ts:1653 -▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> +▸ stream(`options`: Readonly<{ [key: string]: any; }\\>, `handler`: (`readable`: PassThrough) => any): Promise<any\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| Readonly<{ [key: string]: any; }\\> \| `handler` \| (`readable`: PassThrough) => any \| -Returns: Promise<any\\> +Returns: Promise<any\\> -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1648 +Defined in: node_modules/knex/types/index.d.ts:1654 ▸ stream(`options?`: Readonly<{ [key: string]: any; }\\>): PassThrough #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options?` \| Readonly<{ [key: string]: any; }\\> \| Returns: PassThrough -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1652 +Defined in: node_modules/knex/types/index.d.ts:1658 ___ ### table -▸ table(`tableName`: string, `callback`: (`tableBuilder`: [AlterTableBuilder](knex.knex.altertablebuilder.md)) => any): Promise<void\\> +▸ table(`tableName`: string, `callback`: (`tableBuilder`: [AlterTableBuilder](knex.knex-1.altertablebuilder.md)) => any): Promise<void\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `tableName` \| string \| -`callback` \| (`tableBuilder`: [AlterTableBuilder](knex.knex.altertablebuilder.md)) => any \| +`callback` \| (`tableBuilder`: [AlterTableBuilder](knex.knex-1.altertablebuilder.md)) => any \| -Returns: Promise<void\\> +Returns: Promise<void\\> -Defined in: node_modules/knex/types/index.d.ts:1701 +Defined in: node_modules/knex/types/index.d.ts:1707 ___ @@ -477,14 +478,14 @@ Attaches callbacks for the resolution and/or rejection of the Promise. #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TResult1` \| void \| `TResult2` \| never \| #### Parameters: Name \| Type \| Description \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `onfulfilled?` \| null \\\| (`value`: void) => TResult1 \\\| PromiseLike<TResult1\\> \| The callback to execute when the Promise is resolved. \| `onrejected?` \| null \\\| (`reason`: any) => TResult2 \\\| PromiseLike<TResult2\\> \| The callback to execute when the Promise is rejected. \| @@ -492,9 +493,9 @@ Name \| Type \| Description \| A Promise for the completion of which ever callback is executed. -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1441 +Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1453 ___ @@ -504,19 +505,19 @@ ___ Returns: string -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1642 +Defined in: node_modules/knex/types/index.d.ts:1648 ___ ### toSQL -▸ toSQL(): [Sql](knex.knex.sql.md) +▸ toSQL(): [Sql](knex.knex-1.sql.md) -Returns: [Sql](knex.knex.sql.md) +Returns: [Sql](knex.knex-1.sql.md) -Defined in: node_modules/knex/types/index.d.ts:1712 +Defined in: node_modules/knex/types/index.d.ts:1718 ___ @@ -526,38 +527,38 @@ ___ Returns: string -Defined in: node_modules/knex/types/index.d.ts:1711 +Defined in: node_modules/knex/types/index.d.ts:1717 ___ ### transacting -▸ transacting(`trx`: [Transaction](knex.knex.transaction.md)<any, any\\>): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ transacting(`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`trx` \| [Transaction](knex.knex.transaction.md)<any, any\\> \| +:------ \| :------ \| +`trx` \| [Transaction](knex.knex-1.transaction.md)<any, any\\> \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Inherited from: [ChainableInterface](knex.knex.chainableinterface.md) +Inherited from: [ChainableInterface](knex.knex-1.chainableinterface.md) -Defined in: node_modules/knex/types/index.d.ts:1646 +Defined in: node_modules/knex/types/index.d.ts:1652 ___ ### withSchema -▸ withSchema(`schemaName`: string): [SchemaBuilder](knex.knex.schemabuilder.md) +▸ withSchema(`schemaName`: string): [SchemaBuilder](knex.knex-1.schemabuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schemaName` \| string \| -Returns: [SchemaBuilder](knex.knex.schemabuilder.md) +Returns: [SchemaBuilder](knex.knex-1.schemabuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1709 +Defined in: node_modules/knex/types/index.d.ts:1715 diff --git a/knex.knex-1.seederconfig.md b/knex.knex-1.seederconfig.md index 17d44ee..3d91664 100644 --- a/knex.knex-1.seederconfig.md +++ b/knex.knex-1.seederconfig.md @@ -0,0 +1,89 @@ +--- +id: "knex.knex-1.seederconfig" +title: "Interface: SeederConfig<V>" +sidebar_label: "SeederConfig" +custom_edit_url: null +hide_title: true +--- + +# Interface: SeederConfig<V\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).SeederConfig + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`V` \| object \| any \| + +## Properties + +### directory + +• `Optional` directory: string \\\| readonly string[] + +Defined in: node_modules/knex/types/index.d.ts:2148 + +___ + +### extension + +• `Optional` extension: string + +Defined in: node_modules/knex/types/index.d.ts:2147 + +___ + +### loadExtensions + +• `Optional` loadExtensions: readonly string[] + +Defined in: node_modules/knex/types/index.d.ts:2149 + +___ + +### recursive + +• `Optional` recursive: boolean + +Defined in: node_modules/knex/types/index.d.ts:2152 + +___ + +### sortDirsSeparately + +• `Optional` sortDirsSeparately: boolean + +Defined in: node_modules/knex/types/index.d.ts:2153 + +___ + +### specific + +• `Optional` specific: string + +Defined in: node_modules/knex/types/index.d.ts:2150 + +___ + +### stub + +• `Optional` stub: string + +Defined in: node_modules/knex/types/index.d.ts:2154 + +___ + +### timestampFilenamePrefix + +• `Optional` timestampFilenamePrefix: boolean + +Defined in: node_modules/knex/types/index.d.ts:2151 + +___ + +### variables + +• `Optional` variables: V + +Defined in: node_modules/knex/types/index.d.ts:2155 diff --git a/knex.knex-1.select.md b/knex.knex-1.select.md index 1bdf330..91353a3 100644 --- a/knex.knex-1.select.md +++ b/knex.knex-1.select.md @@ -0,0 +1,236 @@ +--- +id: "knex.knex-1.select" +title: "Interface: Select<TRecord, TResult>" +sidebar_label: "Select" +custom_edit_url: null +hide_title: true +--- + +# Interface: Select<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Select + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| unknown[] \| + +## Hierarchy + +* [AliasQueryBuilder](knex.knex-1.aliasquerybuilder.md)<TRecord, TResult\\> + +* [ColumnNameQueryBuilder](knex.knex-1.columnnamequerybuilder.md)<TRecord, TResult\\> + + ↳ Select + +## Callable + +▸ Select(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:970 + +▸ Select<TResult2, TInnerRecord, TInnerResult\\>(...`subQueryBuilders`: readonly [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TInnerRecord, TInnerResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| ArrayIfAlready<TResult, any\\> \| +`TInnerRecord` \| any \| +`TInnerResult` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...subQueryBuilders` \| readonly [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TInnerRecord, TInnerResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:971 + +▸ Select<TResult2, TInnerRecord, TInnerResult\\>(`subQueryBuilders`: readonly [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TInnerRecord, TInnerResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| ArrayIfAlready<TResult, any\\> \| +`TInnerRecord` \| any \| +`TInnerResult` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`subQueryBuilders` \| readonly [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TInnerRecord, TInnerResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:975 + +▸ Select<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:918 + +▸ Select<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| [InferrableColumnDescriptor](../modules/knex.knex-1.md#inferrablecolumndescriptor)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:929 + +▸ Select<AliasUT, TResult2\\>(...`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:941 + +▸ Select<AliasUT, TResult2\\>(`aliases`: AliasUT): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`AliasUT` \| (string \\\| Dict<any\\>)[] \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, IncompatibleToAlt<ArrayMember<AliasUT\\>, string, never\\>\\>, UnionToIntersection<IncompatibleToAlt<AliasUT extends I[] ? I extends [Ref](knex.knex-1.ref.md)<any, TMapping\\> ? TMapping : I : never, Dict<any\\>, {}\\>\\>\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| AliasUT \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:953 + +▸ Select(`columnName`: **): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, ArrayIfAlready<TResult, DeferredKeySelection<TRecord, string, false, {}, false, {}, never\\>\\>\\> + +Defined in: node_modules/knex/types/index.d.ts:1434 + +▸ Select<ColNameUT, TResult2\\>(...`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1440 + +▸ Select<ColNameUT, TResult2\\>(`columnNames`: readonly ColNameUT[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`ColNameUT` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, ColNameUT & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly ColNameUT[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1451 + +▸ Select<TResult2\\>(...`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1462 + +▸ Select<TResult2\\>(`columnNames`: readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>\\>, keyof TRecord & string\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly [ColumnDescriptor](../modules/knex.knex-1.md#columndescriptor)<TRecord, TResult\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1474 diff --git a/knex.knex-1.socketconnectionconfig.md b/knex.knex-1.socketconnectionconfig.md index 205d869..7d4f3b2 100644 --- a/knex.knex-1.socketconnectionconfig.md +++ b/knex.knex-1.socketconnectionconfig.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.socketconnectionconfig" +id: "knex.knex-1.socketconnectionconfig" title: "Interface: SocketConnectionConfig" sidebar_label: "SocketConnectionConfig" +custom_edit_url: null hide_title: true --- @@ -9,25 +10,21 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).SocketConnectionConfig -## Hierarchy - -* SocketConnectionConfig - ## Properties ### database • database: string -Defined in: node_modules/knex/types/index.d.ts:2067 +Defined in: node_modules/knex/types/index.d.ts:2073 ___ ### debug -• `Optional` debug: undefined \\\| boolean +• `Optional` debug: boolean -Defined in: node_modules/knex/types/index.d.ts:2068 +Defined in: node_modules/knex/types/index.d.ts:2074 ___ @@ -35,7 +32,7 @@ ___ • password: string -Defined in: node_modules/knex/types/index.d.ts:2066 +Defined in: node_modules/knex/types/index.d.ts:2072 ___ @@ -43,7 +40,7 @@ ___ • socketPath: string -Defined in: node_modules/knex/types/index.d.ts:2064 +Defined in: node_modules/knex/types/index.d.ts:2070 ___ @@ -51,10 +48,14 @@ ___ • user: string -Defined in: node_modules/knex/types/index.d.ts:2065 +Defined in: node_modules/knex/types/index.d.ts:2071 ## Methods ### expirationChecker -• `Optional` expirationChecker: +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:2075 diff --git a/knex.knex-1.sql.md b/knex.knex-1.sql.md index b57d0f9..14a4eef 100644 --- a/knex.knex-1.sql.md +++ b/knex.knex-1.sql.md @@ -0,0 +1,53 @@ +--- +id: "knex.knex-1.sql" +title: "Interface: Sql" +sidebar_label: "Sql" +custom_edit_url: null +hide_title: true +--- + +# Interface: Sql + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Sql + +## Properties + +### bindings + +• bindings: readonly [Value](../modules/knex.knex-1.md#value)[] + +Defined in: node_modules/knex/types/index.d.ts:1625 + +___ + +### method + +• method: string + +Defined in: node_modules/knex/types/index.d.ts:1623 + +___ + +### options + +• options: any + +Defined in: node_modules/knex/types/index.d.ts:1624 + +___ + +### sql + +• sql: string + +Defined in: node_modules/knex/types/index.d.ts:1626 + +## Methods + +### toNative + +▸ toNative(): [SqlNative](knex.knex-1.sqlnative.md) + +Returns: [SqlNative](knex.knex-1.sqlnative.md) + +Defined in: node_modules/knex/types/index.d.ts:1627 diff --git a/knex.knex-1.sqlite3connectionconfig.md b/knex.knex-1.sqlite3connectionconfig.md index 9c21cd1..84c3416 100644 --- a/knex.knex-1.sqlite3connectionconfig.md +++ b/knex.knex-1.sqlite3connectionconfig.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.sqlite3connectionconfig" +id: "knex.knex-1.sqlite3connectionconfig" title: "Interface: Sqlite3ConnectionConfig" sidebar_label: "Sqlite3ConnectionConfig" +custom_edit_url: null hide_title: true --- @@ -11,17 +12,13 @@ hide_title: true Used with SQLite3 adapter -## Hierarchy - -* Sqlite3ConnectionConfig - ## Properties ### debug -• `Optional` debug: undefined \\\| boolean +• `Optional` debug: boolean -Defined in: node_modules/knex/types/index.d.ts:2059 +Defined in: node_modules/knex/types/index.d.ts:2065 ___ @@ -29,10 +26,14 @@ ___ • filename: string -Defined in: node_modules/knex/types/index.d.ts:2058 +Defined in: node_modules/knex/types/index.d.ts:2064 ## Methods ### expirationChecker -• `Optional` expirationChecker: +▸ `Optional`expirationChecker(): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:2066 diff --git a/knex.knex-1.sqlnative.md b/knex.knex-1.sqlnative.md index 65027dd..c350b00 100644 --- a/knex.knex-1.sqlnative.md +++ b/knex.knex-1.sqlnative.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.sqlnative" +id: "knex.knex-1.sqlnative" title: "Interface: SqlNative" sidebar_label: "SqlNative" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).SqlNative -## Hierarchy - -* SqlNative - ## Properties ### bindings • bindings: readonly [Value](../modules/knex.knex-1.md#value)[] -Defined in: node_modules/knex/types/index.d.ts:1625 +Defined in: node_modules/knex/types/index.d.ts:1631 ___ @@ -27,4 +24,4 @@ ___ • sql: string -Defined in: node_modules/knex/types/index.d.ts:1626 +Defined in: node_modules/knex/types/index.d.ts:1632 diff --git a/knex.knex-1.stringtagsupport.md b/knex.knex-1.stringtagsupport.md index bdb2938..463f4bf 100644 --- a/knex.knex-1.stringtagsupport.md +++ b/knex.knex-1.stringtagsupport.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.stringtagsupport" +id: "knex.knex-1.stringtagsupport" title: "Interface: StringTagSupport" sidebar_label: "StringTagSupport" +custom_edit_url: null hide_title: true --- @@ -13,7 +14,7 @@ hide_title: true * StringTagSupport - ↳ [ChainableInterface](knex.knex.chainableinterface.md) + ↳ [ChainableInterface](knex.knex-1.chainableinterface.md) ## Properties @@ -21,4 +22,4 @@ hide_title: true • `Readonly` [Symbol.toStringTag]: string -Defined in: node_modules/knex/types/index.d.ts:1639 +Defined in: node_modules/knex/types/index.d.ts:1645 diff --git a/knex.knex-1.table.md b/knex.knex-1.table.md index 7102f40..4b4fec8 100644 --- a/knex.knex-1.table.md +++ b/knex.knex-1.table.md @@ -0,0 +1,101 @@ +--- +id: "knex.knex-1.table" +title: "Interface: Table<TRecord, TResult>" +sidebar_label: "Table" +custom_edit_url: null +hide_title: true +--- + +# Interface: Table<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Table + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| object \| any \| + +## Callable + +▸ Table<TTable, TRecord2, TResult2\\>(`tableName`: TTable, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TTable` \| never \| - \| +`TRecord2` \| - \| [TableType](../modules/knex.knex-1.md#tabletype)<TTable\\> \| +`TResult2` \| - \| ReplaceBase<TResult, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, base\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:987 + +▸ Table<TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md), `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| unknown \| +`TResult2` \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:995 + +▸ Table<TRecord2, TResult2\\>(`callback`: Function, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| unknown \| +`TResult2` \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| Function \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1002 + +▸ Table<TRecord2, TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<any\\>, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| unknown \| +`TResult2` \| ReplaceBase<TResult, TRecord2\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1009 diff --git a/knex.knex-1.tablebuilder.md b/knex.knex-1.tablebuilder.md index 4be4332..15751ce 100644 --- a/knex.knex-1.tablebuilder.md +++ b/knex.knex-1.tablebuilder.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.tablebuilder" +id: "knex.knex-1.tablebuilder" title: "Interface: TableBuilder" sidebar_label: "TableBuilder" +custom_edit_url: null hide_title: true --- @@ -13,632 +14,632 @@ hide_title: true * TableBuilder - ↳ [CreateTableBuilder](knex.knex.createtablebuilder.md) + ↳ [CreateTableBuilder](knex.knex-1.createtablebuilder.md) - ↳ [AlterTableBuilder](knex.knex.altertablebuilder.md) + ↳ [AlterTableBuilder](knex.knex-1.altertablebuilder.md) ## Methods ### bigIncrements -▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ bigIncrements(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName?` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1717 +Defined in: node_modules/knex/types/index.d.ts:1723 ___ ### bigInteger -▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ bigInteger(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1722 +Defined in: node_modules/knex/types/index.d.ts:1728 ___ ### binary -▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ binary(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `length?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1751 +Defined in: node_modules/knex/types/index.d.ts:1757 ___ ### boolean -▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ boolean(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1740 +Defined in: node_modules/knex/types/index.d.ts:1746 ___ ### comment -▸ comment(`val`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ comment(`val`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `val` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1765 +Defined in: node_modules/knex/types/index.d.ts:1771 ___ ### date -▸ date(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ date(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1741 +Defined in: node_modules/knex/types/index.d.ts:1747 ___ ### dateTime -▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ dateTime(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1742 +Defined in: node_modules/knex/types/index.d.ts:1748 ___ ### decimal -▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ decimal(`columnName`: string, `precision?`: null \\\| number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `precision?` \| null \\\| number \| `scale?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1735 +Defined in: node_modules/knex/types/index.d.ts:1741 ___ ### double -▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ double(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `precision?` \| number \| `scale?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1730 +Defined in: node_modules/knex/types/index.d.ts:1736 ___ ### dropColumn -▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropColumn(`columnName`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1718 +Defined in: node_modules/knex/types/index.d.ts:1724 ___ ### dropColumns -▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropColumns(...`columnNames`: string[]): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `...columnNames` \| string[] \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1719 +Defined in: node_modules/knex/types/index.d.ts:1725 ___ ### dropForeign -▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropForeign(`columnNames`: readonly string[], `foreignKeyName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnNames` \| readonly string[] \| `foreignKeyName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1779 +Defined in: node_modules/knex/types/index.d.ts:1785 ___ ### dropIndex -▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropIndex(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| `indexName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1782 +Defined in: node_modules/knex/types/index.d.ts:1788 ___ ### dropPrimary -▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropPrimary(`constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `constraintName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1781 +Defined in: node_modules/knex/types/index.d.ts:1787 ___ ### dropTimestamps -▸ dropTimestamps(): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ dropTimestamps(): [ColumnBuilder](knex.knex-1.columnbuilder.md) -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1783 +Defined in: node_modules/knex/types/index.d.ts:1789 ___ ### dropUnique -▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ dropUnique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| `indexName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1780 +Defined in: node_modules/knex/types/index.d.ts:1786 ___ ### enu -▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ enu(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1757 +Defined in: node_modules/knex/types/index.d.ts:1763 ___ ### enum -▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex.enumoptions.md)): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ enum(`columnName`: string, `values`: readonly [Value](../modules/knex.knex-1.md#value)[], `options?`: [EnumOptions](knex.knex-1.enumoptions.md)): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `values` \| readonly [Value](../modules/knex.knex-1.md#value)[] \| -`options?` \| [EnumOptions](knex.knex.enumoptions.md) \| +`options?` \| [EnumOptions](knex.knex-1.enumoptions.md) \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1752 +Defined in: node_modules/knex/types/index.d.ts:1758 ___ ### float -▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ float(`columnName`: string, `precision?`: number, `scale?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `precision?` \| number \| `scale?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1725 +Defined in: node_modules/knex/types/index.d.ts:1731 ___ ### foreign -▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) +▸ foreign(`column`: string, `foreignKeyName?`: string): [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `column` \| string \| `foreignKeyName?` \| string \| -Returns: [ForeignConstraintBuilder](knex.knex.foreignconstraintbuilder.md) +Returns: [ForeignConstraintBuilder](knex.knex-1.foreignconstraintbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1774 +Defined in: node_modules/knex/types/index.d.ts:1780 -▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) +▸ foreign(`columns`: readonly string[], `foreignKeyName?`: string): [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columns` \| readonly string[] \| `foreignKeyName?` \| string \| -Returns: [MultikeyForeignConstraintBuilder](knex.knex.multikeyforeignconstraintbuilder.md) +Returns: [MultikeyForeignConstraintBuilder](knex.knex-1.multikeyforeignconstraintbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1775 +Defined in: node_modules/knex/types/index.d.ts:1781 ___ ### increments -▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ increments(`columnName?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName?` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1716 +Defined in: node_modules/knex/types/index.d.ts:1722 ___ ### index -▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ index(`columnNames`: string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string, `indexType?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| +:------ \| :------ \| +`columnNames` \| string \\\| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| `indexName?` \| string \| `indexType?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1768 +Defined in: node_modules/knex/types/index.d.ts:1774 ___ ### integer -▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ integer(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `length?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1721 +Defined in: node_modules/knex/types/index.d.ts:1727 ___ ### json -▸ json(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ json(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1762 +Defined in: node_modules/knex/types/index.d.ts:1768 ___ ### jsonb -▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ jsonb(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1763 +Defined in: node_modules/knex/types/index.d.ts:1769 ___ ### primary -▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ primary(`columnNames`: readonly string[], `constraintName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnNames` \| readonly string[] \| `constraintName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1767 +Defined in: node_modules/knex/types/index.d.ts:1773 ___ ### queryContext -▸ queryContext(`context`: any): [TableBuilder](knex.knex.tablebuilder.md) +▸ queryContext(`context`: any): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `context` \| any \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1784 +Defined in: node_modules/knex/types/index.d.ts:1790 ___ ### renameColumn -▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ renameColumn(`from`: string, `to`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `from` \| string \| `to` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1720 +Defined in: node_modules/knex/types/index.d.ts:1726 ___ ### specificType -▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ specificType(`columnName`: string, `type`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `type` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1766 +Defined in: node_modules/knex/types/index.d.ts:1772 ___ ### string -▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ string(`columnName`: string, `length?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `length?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1724 +Defined in: node_modules/knex/types/index.d.ts:1730 ___ ### text -▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ text(`columnName`: string, `textType?`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `textType?` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1723 +Defined in: node_modules/knex/types/index.d.ts:1729 ___ ### time -▸ time(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ time(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1743 +Defined in: node_modules/knex/types/index.d.ts:1749 ___ ### timestamp -▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\>): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ timestamp(`columnName`: string, `options?`: Readonly<{ `precision?`: number ; `useTz?`: boolean }\\>): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -`options?` \| Readonly<{ `precision?`: undefined \\\| number ; `useTz?`: undefined \\\| boolean }\\> \| +`options?` \| Readonly<{ `precision?`: number ; `useTz?`: boolean }\\> \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1744 +Defined in: node_modules/knex/types/index.d.ts:1750 -▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ timestamp(`columnName`: string, `withoutTz?`: boolean, `precision?`: number): [ColumnBuilder](knex.knex-1.columnbuilder.md) `deprecated` #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| `withoutTz?` \| boolean \| `precision?` \| number \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1746 +Defined in: node_modules/knex/types/index.d.ts:1752 ___ ### timestamps -▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ timestamps(`useTimestampType?`: boolean, `makeDefaultNow?`: boolean): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `useTimestampType?` \| boolean \| `makeDefaultNow?` \| boolean \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1747 +Defined in: node_modules/knex/types/index.d.ts:1753 ___ ### unique -▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex.tablebuilder.md) +▸ unique(`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[], `indexName?`: string): [TableBuilder](knex.knex-1.tablebuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| -`columnNames` \| readonly (string \\\| [Raw](knex.knex.raw.md)<any\\>)[] \| +:------ \| :------ \| +`columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\>)[] \| `indexName?` \| string \| -Returns: [TableBuilder](knex.knex.tablebuilder.md) +Returns: [TableBuilder](knex.knex-1.tablebuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1773 +Defined in: node_modules/knex/types/index.d.ts:1779 ___ ### uuid -▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex.columnbuilder.md) +▸ uuid(`columnName`: string): [ColumnBuilder](knex.knex-1.columnbuilder.md) #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [ColumnBuilder](knex.knex.columnbuilder.md) +Returns: [ColumnBuilder](knex.knex-1.columnbuilder.md) -Defined in: node_modules/knex/types/index.d.ts:1764 +Defined in: node_modules/knex/types/index.d.ts:1770 diff --git a/knex.knex-1.transaction.md b/knex.knex-1.transaction.md index ce33233..0ba78a4 100644 --- a/knex.knex-1.transaction.md +++ b/knex.knex-1.transaction.md @@ -0,0 +1,2482 @@ +--- +id: "knex.knex-1.transaction" +title: "Interface: Transaction<TRecord, TResult>" +sidebar_label: "Transaction" +custom_edit_url: null +hide_title: true +--- + +# Interface: Transaction<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Transaction + +## Type parameters + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| any \| + +## Hierarchy + +* Knex<TRecord, TResult\\> + + ↳ Transaction + +## Callable + +▸ Transaction<TTable\\>(`tableName`: TTable, `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TTable` \| never \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| TTable \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, DeferredKeySelection<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<[TableType](../modules/knex.knex-1.md#tabletype)<TTable\\>, base\\>, never, false, {}, false, {}, never\\>[]\\> + +Defined in: node_modules/knex/types/index.d.ts:332 + +▸ Transaction<TRecord2, TResult2\\>(`tableName?`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md), `options?`: PgTableOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| DeferredKeySelection<TRecord2, never, false, {}, false, {}, never\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName?` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \\\| [AliasDict](knex.knex-1.aliasdict.md) \| +`options?` \| PgTableOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:336 + +## Properties + +### VERSION + +• VERSION: string + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:341 + +___ + +### \\_\\_knex\\_\\_ + +• \\_\\_knex\\_\\_: string + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:342 + +___ + +### andHaving + +• andHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:544 + +___ + +### andWhere + +• andWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:498 + +___ + +### andWhereBetween + +• andWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:522 + +___ + +### andWhereNot + +• andWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:501 + +___ + +### andWhereNotBetween + +• andWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:525 + +___ + +### andWhereRaw + +• andWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:505 + +___ + +### as + +• as: [As](knex.knex-1.as.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:467 + +___ + +### avg + +• avg: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:587 + +___ + +### avgDistinct + +• avgDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:588 + +___ + +### client + +• client: any + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:375 + +___ + +### column + +• column: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:469 + +___ + +### columns + +• columns: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:468 + +___ + +### count + +• count: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:581 + +___ + +### countDistinct + +• countDistinct: [AsymmetricAggregation](knex.knex-1.asymmetricaggregation.md)<TRecord, TResult, string \\\| number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:582 + +___ + +### crossJoin + +• crossJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:487 + +___ + +### distinct + +• distinct: [Distinct](knex.knex-1.distinct.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:474 + +___ + +### distinctOn + +• distinctOn: [DistinctOn](knex.knex-1.distincton.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:475 + +___ + +### executionPromise + +• executionPromise: Promise<TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1668 + +___ + +### first + +• first: [Select](knex.knex-1.select.md)<TRecord, AddUnionMember<UnwrapArrayMember<TResult\\>, undefined\\>\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:609 + +___ + +### fn + +• fn: [FunctionHelper](knex.knex-1.functionhelper.md) + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:378 + +___ + +### from + +• from: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:471 + +___ + +### fullOuterJoin + +• fullOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:486 + +___ + +### groupBy + +• groupBy: [GroupBy](knex.knex-1.groupby.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:528 + +___ + +### groupByRaw + +• groupByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:529 + +___ + +### having + +• having: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:543 + +___ + +### havingBetween + +• havingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:552 + +___ + +### havingIn + +• havingIn: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:548 + +___ + +### havingNotBetween + +• havingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:550 + +___ + +### havingRaw + +• havingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:545 + +___ + +### havingWrapped + +• havingWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:507 + +___ + +### hintComment + +• hintComment: [HintComment](knex.knex-1.hintcomment.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:470 + +___ + +### innerJoin + +• innerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:480 + +___ + +### intersect + +• intersect: [Intersect](knex.knex-1.intersect.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:536 + +___ + +### into + +• into: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:472 + +___ + +### isCompleted + +• isCompleted: () => boolean + +#### Type declaration: + +▸ (): boolean + +Returns: boolean + +Defined in: node_modules/knex/types/index.d.ts:1669 + +Defined in: node_modules/knex/types/index.d.ts:1669 + +___ + +### join + +• join: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:478 + +___ + +### joinRaw + +• joinRaw: [JoinRaw](knex.knex-1.joinraw.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:479 + +___ + +### leftJoin + +• leftJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:481 + +___ + +### leftOuterJoin + +• leftOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:482 + +___ + +### max + +• max: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:584 + +___ + +### migrate + +• migrate: [Migrator](knex.knex-1.migrator.md) + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:376 + +___ + +### min + +• min: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:583 + +___ + +### orHaving + +• orHaving: [Having](knex.knex-1.having.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:546 + +___ + +### orHavingBetween + +• orHavingBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:551 + +___ + +### orHavingNotBetween + +• orHavingNotBetween: [HavingRange](knex.knex-1.havingrange.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:549 + +___ + +### orHavingRaw + +• orHavingRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:547 + +___ + +### orWhere + +• orWhere: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:499 + +___ + +### orWhereBetween + +• orWhereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:521 + +___ + +### orWhereExists + +• orWhereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:509 + +___ + +### orWhereIn + +• orWhereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:513 + +___ + +### orWhereNot + +• orWhereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:502 + +___ + +### orWhereNotBetween + +• orWhereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:524 + +___ + +### orWhereNotExists + +• orWhereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:511 + +___ + +### orWhereNotIn + +• orWhereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:515 + +___ + +### orWhereNotNull + +• orWhereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:519 + +___ + +### orWhereNull + +• orWhereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:517 + +___ + +### orWhereRaw + +• orWhereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:504 + +___ + +### orderBy + +• orderBy: [OrderBy](knex.knex-1.orderby.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:532 + +___ + +### orderByRaw + +• orderByRaw: [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:533 + +___ + +### outerJoin + +• outerJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:485 + +___ + +### raw + +• raw: [RawBuilder](knex.knex-1.rawbuilder.md)<TRecord, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:344 + +___ + +### ref + +• ref: [RefBuilder](knex.knex-1.refbuilder.md) + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:379 + +___ + +### rightJoin + +• rightJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:483 + +___ + +### rightOuterJoin + +• rightOuterJoin: [Join](knex.knex-1.join.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:484 + +___ + +### schema + +• schema: [SchemaBuilder](knex.knex-1.schemabuilder.md) + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:369 + +___ + +### seed + +• seed: [Seeder](../classes/knex.knex-1.seeder.md) + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:377 + +___ + +### select + +• select: [Select](knex.knex-1.select.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:466 + +___ + +### sum + +• sum: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:585 + +___ + +### sumDistinct + +• sumDistinct: [TypePreservingAggregation](knex.knex-1.typepreservingaggregation.md)<TRecord, TResult, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:586 + +___ + +### table + +• table: [Table](knex.knex-1.table.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:473 + +___ + +### union + +• union: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:539 + +___ + +### unionAll + +• unionAll: [Union](knex.knex-1.union.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:540 + +___ + +### userParams + +• userParams: Record<string, any\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:380 + +___ + +### where + +• where: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:497 + +___ + +### whereBetween + +• whereBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:520 + +___ + +### whereExists + +• whereExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:508 + +___ + +### whereIn + +• whereIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:512 + +___ + +### whereNot + +• whereNot: [Where](knex.knex-1.where.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:500 + +___ + +### whereNotBetween + +• whereNotBetween: [WhereBetween](knex.knex-1.wherebetween.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:523 + +___ + +### whereNotExists + +• whereNotExists: [WhereExists](knex.knex-1.whereexists.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:510 + +___ + +### whereNotIn + +• whereNotIn: [WhereIn](knex.knex-1.wherein.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:514 + +___ + +### whereNotNull + +• whereNotNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:518 + +___ + +### whereNull + +• whereNull: [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:516 + +___ + +### whereRaw + +• whereRaw: [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:503 + +___ + +### whereWrapped + +• whereWrapped: [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:506 + +___ + +### with + +• with: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:490 + +___ + +### withRaw + +• withRaw: [WithRaw](knex.knex-1.withraw.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:492 + +___ + +### withRecursive + +• withRecursive: [With](knex.knex-1.with.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:491 + +___ + +### withSchema + +• withSchema: [WithSchema](knex.knex-1.withschema.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:493 + +___ + +### withWrapped + +• withWrapped: [WithWrapped](knex.knex-1.withwrapped.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:494 + +## Methods + +### addListener + +▸ addListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:62 + +___ + +### batchInsert + +▸ batchInsert<TRecord2, TResult2\\>(`tableName`: [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor), `data`: TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord2\\>[], `chunkSize?`: number): [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`tableName` \| [TableDescriptor](../modules/knex.knex-1.md#tabledescriptor) \| +`data` \| TRecord2 extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord2, insert\\>[] : readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord2\\>[] \| +`chunkSize?` \| number \| + +Returns: [BatchInsertBuilder](knex.knex-1.batchinsertbuilder.md)<TRecord2, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:361 + +___ + +### clear + +▸ clear(`statement`: [ClearStatements](../modules/knex.knex-1.md#clearstatements)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`statement` \| [ClearStatements](../modules/knex.knex-1.md#clearstatements) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:574 + +___ + +### clearCounters + +▸ clearCounters(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:573 + +___ + +### clearGroup + +▸ clearGroup(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:570 + +___ + +### clearHaving + +▸ clearHaving(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:572 + +___ + +### clearOrder + +▸ clearOrder(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:571 + +___ + +### clearSelect + +▸ clearSelect(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, true, any, any, any, any\\> ? DeferredKeySelection<TBase, never, false, {}, false, {}, never\\>[] : TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:555 + +___ + +### clearWhere + +▸ clearWhere(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:569 + +___ + +### commit + +▸ commit(`value?`: any): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`value?` \| any \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1680 + +___ + +### decrement + +▸ decrement(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:599 + +▸ decrement(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:603 + +___ + +### del + +▸ del(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:833 + +▸ del<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:837 + +▸ del<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:848 + +▸ del<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:859 + +▸ del<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:863 + +___ + +### delete + +▸ delete(`returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:865 + +▸ delete<TKey, TResult2\\>(`returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:869 + +▸ delete<TKey, TResult2\\>(`returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:880 + +▸ delete<TResult2\\>(`returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:891 + +▸ delete<TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:895 + +___ + +### destroy + +▸ destroy(`callback`: Function): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| Function \| + +Returns: void + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:358 + +▸ destroy(): Promise<void\\> + +Returns: Promise<void\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:359 + +___ + +### emit + +▸ emit(`event`: string \\\| symbol, ...`args`: any[]): boolean + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`...args` \| any[] \| + +Returns: boolean + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:72 + +___ + +### eventNames + +▸ eventNames(): (string \\\| symbol)[] + +Returns: (string \\\| symbol)[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:77 + +___ + +### getMaxListeners + +▸ getMaxListeners(): number + +Returns: number + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:69 + +___ + +### increment + +▸ increment(`columnName`: keyof TRecord, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:590 + +▸ increment(`columnName`: string, `amount?`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`amount?` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:594 + +___ + +### initialize + +▸ initialize(`config?`: [Config](knex.knex-1.config.md)<any\\>): void + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| [Config](knex.knex-1.config.md)<any\\> \| + +Returns: void + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:357 + +___ + +### insert + +▸ insert(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends* [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| * \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:616 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:623 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:637 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:651 + +▸ insert<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[], `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:665 + +▸ insert<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\> \\\| readonly [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, insert\\>[] : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \\\| readonly [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:679 + +___ + +### limit + +▸ limit(`limit`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`limit` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:578 + +___ + +### listenerCount + +▸ listenerCount(`event`: string \\\| symbol): number + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: number + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:73 + +___ + +### listeners + +▸ listeners(`event`: string \\\| symbol): Function[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: Function[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:70 + +___ + +### modify + +▸ modify<TRecord2, TResult2\\>(`callback`: [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\>, ...`args`: any[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord2` \| object \| any \| +`TResult2` \| object \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallbackWithArgs](../modules/knex.knex-1.md#querycallbackwithargs)<TRecord, any\\> \| +`...args` \| any[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:685 + +___ + +### off + +▸ off(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:66 + +___ + +### offset + +▸ offset(`offset`: number): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`offset` \| number \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:577 + +___ + +### on + +▸ on(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:63 + +___ + +### onConflict + +▸ onConflict<TKey, TResult2\\>(`column`: TKey): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:813 + +▸ onConflict<TKey, TResult2\\>(`columns`: readonly TKey[]): [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| + +Returns: [OnConflictQueryBuilder](knex.knex-1.onconflictquerybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:823 + +___ + +### once + +▸ once(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:64 + +___ + +### pluck + +▸ pluck<K\\>(`column`: K): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| K \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TRecord[K][]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:611 + +▸ pluck<TResult2\\>(`column`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`TResult2` \| object \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:614 + +___ + +### prependListener + +▸ prependListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:75 + +___ + +### prependOnceListener + +▸ prependOnceListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:76 + +___ + +### query + +▸ query<TRecord, TResult\\>(`conn`: any, `sql`: any, `status`: any, `value`: any): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TRecord` \| object \| any \| +`TResult` \| - \| void \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`conn` \| any \| +`sql` \| any \| +`status` \| any \| +`value` \| any \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1671 + +___ + +### queryBuilder + +▸ queryBuilder<TRecord2, TResult2\\>(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TRecord2` \| TRecord \| +`TResult2` \| TResult \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord2, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:370 + +___ + +### rawListeners + +▸ rawListeners(`event`: string \\\| symbol): Function[] + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| + +Returns: Function[] + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:71 + +___ + +### removeAllListeners + +▸ removeAllListeners(`event?`: string \\\| symbol): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event?` \| string \\\| symbol \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:67 + +___ + +### removeListener + +▸ removeListener(`event`: string \\\| symbol, `listener`: (...`args`: any[]) => void): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`event` \| string \\\| symbol \| +`listener` \| (...`args`: any[]) => void \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:65 + +___ + +### returning + +▸ returning(`column`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:786 + +▸ returning<TKey, TResult2\\>(`column`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:787 + +▸ returning<TKey, TResult2\\>(`columns`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>, false\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columns` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:798 + +▸ returning<TResult2\\>(`column`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`column` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:808 + +___ + +### rollback + +▸ rollback(`error?`: any): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`error?` \| any \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1681 + +___ + +### savepoint + +▸ savepoint<T\\>(`transactionScope`: (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => any): Promise<T\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`T` \| any \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`transactionScope` \| (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => any \| + +Returns: Promise<T\\> + +Defined in: node_modules/knex/types/index.d.ts:1677 + +___ + +### setMaxListeners + +▸ setMaxListeners(`n`: number): [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`n` \| number \| + +Returns: [Transaction](knex.knex-1.transaction.md)<TRecord, TResult\\> + +Inherited from: void + +Defined in: node_modules/@types/node/events.d.ts:68 + +___ + +### transaction + +▸ transaction(`transactionScope?`: null, `config?`: any): Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`transactionScope?` \| null \| +`config?` \| any \| + +Returns: Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:349 + +▸ transaction<T\\>(`transactionScope`: (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => void \\\| Promise<T\\>, `config?`: any): Promise<T\\> + +#### Type parameters: + +Name \| +:------ \| +`T` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`transactionScope` \| (`trx`: [Transaction](knex.knex-1.transaction.md)<any, any\\>) => void \\\| Promise<T\\> \| +`config?` \| any \| + +Returns: Promise<T\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:353 + +___ + +### transactionProvider + +▸ transactionProvider(`config?`: any): function + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`config?` \| any \| + +Returns: () => Promise<[Transaction](knex.knex-1.transaction.md)<any, any\\>\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:346 + +___ + +### truncate + +▸ truncate(): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, void\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:897 + +___ + +### update + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: K2, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| K2 \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:689 + +▸ update<K1, K2, TResult2\\>(`columnName`: K1, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\>, `returning`: readonly K2[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`K1` \| string \| - \| +`K2` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, K2\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K1 \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\>[K1]\\> \| +`returning` \| readonly K2[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:703 + +▸ update<K\\>(`columnName`: K, `value`: [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`value` \| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, number\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:717 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value), `returning`: string \\\| readonly string[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| Partial<AnyOrUnknownToOther<TRecord, {}\\>\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| +`returning` \| string \\\| readonly string[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:721 + +▸ update(`data`: [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: **, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| \| +`options?` \| DMLOptions \| + +Returns:** [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, DeferredKeySelection<TRecord, never, false, {}, false, {}, never\\>[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:727 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey, `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| SetSingle<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, true\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:732 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| - \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:744 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: TKey \\\| readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| string \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| TKey \\\| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:756 + +▸ update<TKey, TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>, `returning`: readonly TKey[], `options?`: DMLOptions): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \| - \| +`TResult2` \| {}[] \| AddAliases<AddKey<SetBase<UnwrapArrayMember<TResult\\>, TRecord\\>, TKey\\>, {}\\>[] \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| +`returning` \| readonly TKey[] \| +`options?` \| DMLOptions \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:768 + +▸ update<TResult2\\>(`data`: TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`data` \| TRecord extends [CompositeTableType](../modules/knex.knex-1.md#compositetabletype)<unknown, unknown, Partial<unknown\\>\\> ? [ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, update\\> : [DbRecordArr](../modules/knex.knex-1.md#dbrecordarr)<TRecord\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:780 + +▸ update<TResult2\\>(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| number \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:784 + +___ + +### withUserParams + +▸ withUserParams(`params`: Record<string, any\\>): Knex<any, unknown[]\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`params` \| Record<string, any\\> \| + +Returns: Knex<any, unknown[]\\> + +Inherited from: void + +Defined in: node_modules/knex/types/index.d.ts:381 diff --git a/knex.knex-1.typepreservingaggregation.md b/knex.knex-1.typepreservingaggregation.md index 1e52a6d..2f5d72b 100644 --- a/knex.knex-1.typepreservingaggregation.md +++ b/knex.knex-1.typepreservingaggregation.md @@ -0,0 +1,77 @@ +--- +id: "knex.knex-1.typepreservingaggregation" +title: "Interface: TypePreservingAggregation<TRecord, TResult, TValue>" +sidebar_label: "TypePreservingAggregation" +custom_edit_url: null +hide_title: true +--- + +# Interface: TypePreservingAggregation<TRecord, TResult, TValue\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).TypePreservingAggregation + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| +`TValue` \| any \| + +## Callable + +▸ TypePreservingAggregation<TKey, TResult2\\>(...`columnNames`: readonly TKey[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TKey` \| string \\\| number \\\| symbol \| - \| +`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[TKey]\\>, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[TKey]\\>, never\\> : Dict<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[TKey]\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly TKey[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1343 + +▸ TypePreservingAggregation<TAliases, TResult2\\>(`aliases`: TAliases): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Type \| Default \| +:------ \| :------ \| :------ \| +`TAliases` \| object \| Readonly<Record<string, string \\\| string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\>\\> \| +`TResult2` \| - \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & { [K in string \\\| number \\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, { [K in string \\\| number \\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}, never\\> : { [K in string \\\| number \\\| symbol]?: K extends keyof TRecord ? TRecord[K] : TValue}\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`aliases` \| TAliases \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1349 + +▸ TypePreservingAggregation<TResult2\\>(...`columnNames`: readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| readonly string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\>\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| ArrayIfAlready<TResult, UnwrapArrayMember<TResult\\> extends DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps, TUnionProps\\> ? true extends THasSelect ? DeferredKeySelection<TBase, TKeys, THasSelect, TAliasMapping, TSingle, TIntersectProps & Dict<TValue\\>, TUnionProps\\> : DeferredKeySelection<{}, never, true, {}, false, Dict<TValue\\>, never\\> : Dict<TValue\\>\\> \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...columnNames` \| readonly (string \\\| [Raw](knex.knex-1.raw.md)<any\\> \\\| Readonly<Record<string, string \\\| readonly string[] \\\| [Raw](knex.knex-1.raw.md)<any\\>\\>\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1359 diff --git a/knex.knex-1.union.md b/knex.knex-1.union.md index 200bf47..06fa624 100644 --- a/knex.knex-1.union.md +++ b/knex.knex-1.union.md @@ -0,0 +1,51 @@ +--- +id: "knex.knex-1.union" +title: "Interface: Union<TRecord, TResult>" +sidebar_label: "Union" +custom_edit_url: null +hide_title: true +--- + +# Interface: Union<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Union + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* [Intersect](knex.knex-1.intersect.md)<TRecord, TResult\\> + + ↳ Union + +## Callable + +▸ Union(`callback`: MaybeArray<[Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>\\>, `wrap?`: boolean): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| MaybeArray<[Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>\\> \| +`wrap?` \| boolean \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1391 + +▸ Union(...`callbacks`: readonly ([Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...callbacks` \| readonly ([Raw](knex.knex-1.raw.md)<any\\> \\\| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1395 diff --git a/knex.knex-1.valuedict.md b/knex.knex-1.valuedict.md index 65e2058..3aa5b47 100644 --- a/knex.knex-1.valuedict.md +++ b/knex.knex-1.valuedict.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.valuedict" +id: "knex.knex-1.valuedict" title: "Interface: ValueDict" sidebar_label: "ValueDict" +custom_edit_url: null hide_title: true --- @@ -11,6 +12,6 @@ hide_title: true ## Hierarchy -* Dict<[Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md)\\> +* Dict<[Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)\\> ↳ ValueDict diff --git a/knex.knex-1.where.md b/knex.knex-1.where.md index 9a98a61..938ae61 100644 --- a/knex.knex-1.where.md +++ b/knex.knex-1.where.md @@ -0,0 +1,307 @@ +--- +id: "knex.knex-1.where" +title: "Interface: Where<TRecord, TResult>" +sidebar_label: "Where" +custom_edit_url: null +hide_title: true +--- + +# Interface: Where<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).Where + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown \| + +## Hierarchy + +* [WhereRaw](knex.knex-1.whereraw.md)<TRecord, TResult\\> + +* [WhereWrapped](knex.knex-1.wherewrapped.md)<TRecord, TResult\\> + +* [WhereNull](knex.knex-1.wherenull.md)<TRecord, TResult\\> + + ↳ Where + +## Callable + +▸ Where(`raw`: [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1211 + +▸ Where(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1212 + +▸ Where(`object`: Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, {}\\>\\>\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`object` \| Readonly<Partial<AnyOrUnknownToOther<[MaybeRawRecord](../modules/knex.knex-1.md#mayberawrecord)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>\\>, {}\\>\\>\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1214 + +▸ Where(`object`: Readonly<Object\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`object` \| Readonly<Object\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1216 + +▸ Where<T\\>(`columnName`: T, `value`: null \\\| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| T \| +`value` \| null \\\| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1218 + +▸ Where(`columnName`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1223 + +▸ Where<T\\>(`columnName`: T, `operator`: ComparisonOperator, `value`: null \\\| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| T \| +`operator` \| ComparisonOperator \| +`value` \| null \\\| [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[T]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1225 + +▸ Where(`columnName`: string, `operator`: string, `value`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`operator` \| string \| +`value` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1231 + +▸ Where<T, TRecordInner, TResultInner\\>(`columnName`: T, `operator`: ComparisonOperator, `value`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`T` \| string \\\| number \\\| symbol \| +`TRecordInner` \| - \| +`TResultInner` \| - \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| T \| +`operator` \| ComparisonOperator \| +`value` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1236 + +▸ Where<TRecordInner, TResultInner\\>(`columnName`: string, `operator`: string, `value`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecordInner` \| +`TResultInner` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`operator` \| string \| +`value` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1242 + +▸ Where(`left`: [Raw](knex.knex-1.raw.md)<any\\>, `operator`: string, `right`: [Value](../modules/knex.knex-1.md#value)): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`left` \| [Raw](knex.knex-1.raw.md)<any\\> \| +`operator` \| string \| +`right` \| [Value](../modules/knex.knex-1.md#value) \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1248 + +▸ Where<TRecordInner, TResultInner\\>(`left`: [Raw](knex.knex-1.raw.md)<any\\>, `operator`: string, `right`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecordInner` \| +`TResultInner` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`left` \| [Raw](knex.knex-1.raw.md)<any\\> \| +`operator` \| string \| +`right` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1253 + +▸ Where(`condition`: boolean): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`condition` \| boolean \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1263 + +▸ Where<TResult2\\>(`sql`: string, `bindings?`: [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`bindings?` \| [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1489 + +▸ Where<TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<TResult2\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1493 + +▸ Where(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1267 + +▸ Where(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| keyof TRecord \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1271 + +▸ Where(`columnName`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1272 diff --git a/knex.knex-1.wherebetween.md b/knex.knex-1.wherebetween.md index d5a35d3..b32030a 100644 --- a/knex.knex-1.wherebetween.md +++ b/knex.knex-1.wherebetween.md @@ -0,0 +1,52 @@ +--- +id: "knex.knex-1.wherebetween" +title: "Interface: WhereBetween<TRecord, TResult>" +sidebar_label: "WhereBetween" +custom_edit_url: null +hide_title: true +--- + +# Interface: WhereBetween<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereBetween + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Callable + +▸ WhereBetween<K\\>(`columnName`: K, `range`: readonly [[DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>, [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`range` \| readonly [[DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>, [DbColumn](../modules/knex.knex-1.md#dbcolumn)<TRecord[K]\\>] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1276 + +▸ WhereBetween(`columnName`: string, `range`: readonly [[Value](../modules/knex.knex-1.md#value), [Value](../modules/knex.knex-1.md#value)]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`range` \| readonly [[Value](../modules/knex.knex-1.md#value), [Value](../modules/knex.knex-1.md#value)] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1280 diff --git a/knex.knex-1.whereexists.md b/knex.knex-1.whereexists.md index de08d77..462e2f9 100644 --- a/knex.knex-1.whereexists.md +++ b/knex.knex-1.whereexists.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.whereexists" +id: "knex.knex-1.whereexists" title: "Interface: WhereExists<TRecord, TResult>" sidebar_label: "WhereExists" +custom_edit_url: null hide_title: true --- @@ -12,43 +13,39 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TRecord` \| any \| `TResult` \| unknown[] \| -## Hierarchy - -* WhereExists - ## Callable -▸ WhereExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WhereExists(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1278 +Defined in: node_modules/knex/types/index.d.ts:1284 -▸ WhereExists<TRecordInner, TResultInner\\>(`query`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WhereExists<TRecordInner, TResultInner\\>(`query`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Type parameters: Name \| ------- \| +:------ \| `TRecordInner` \| `TResultInner` \| #### Parameters: Name \| Type \| ------- \| ------ \| -`query` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecordInner, TResultInner\\> \| +:------ \| :------ \| +`query` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1279 +Defined in: node_modules/knex/types/index.d.ts:1285 diff --git a/knex.knex-1.wherein.md b/knex.knex-1.wherein.md index 1f0669f..5b965f5 100644 --- a/knex.knex-1.wherein.md +++ b/knex.knex-1.wherein.md @@ -0,0 +1,166 @@ +--- +id: "knex.knex-1.wherein" +title: "Interface: WhereIn<TRecord, TResult>" +sidebar_label: "WhereIn" +custom_edit_url: null +hide_title: true +--- + +# Interface: WhereIn<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereIn + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Callable + +▸ WhereIn<K\\>(`columnName`: K, `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\>[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [DbColumn](../modules/knex.knex-1.md#dbcolumn)<[ResolveTableType](../modules/knex.knex-1.md#resolvetabletype)<TRecord, base\\>[K]\\>[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1291 + +▸ WhereIn(`columnName`: string, `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1295 + +▸ WhereIn<K\\>(`columnNames`: readonly K[], `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly readonly DbColumn<ResolveTableType<TRecord, "base"\\>[K]\\>[][]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly K[] \| +`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly readonly DbColumn<ResolveTableType<TRecord, "base"\\>[K]\\>[][] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1299 + +▸ WhereIn(`columnNames`: readonly string[], `values`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[][]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`values` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<any, unknown[]\\> \\\| readonly [Value](../modules/knex.knex-1.md#value)[][] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1303 + +▸ WhereIn<K, TRecordInner, TResultInner\\>(`columnName`: K, `values`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| +`TRecordInner` \| - \| +`TResultInner` \| - \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| K \| +`values` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1307 + +▸ WhereIn<TRecordInner, TResultInner\\>(`columnName`: string, `values`: [Value](../modules/knex.knex-1.md#value)[] \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecordInner` \| +`TResultInner` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnName` \| string \| +`values` \| [Value](../modules/knex.knex-1.md#value)[] \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1311 + +▸ WhereIn<K, TRecordInner, TResultInner\\>(`columnNames`: readonly K[], `values`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TRecord[K]\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| Type \| +:------ \| :------ \| +`K` \| string \\\| number \\\| symbol \| +`TRecordInner` \| - \| +`TResultInner` \| - \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly K[] \| +`values` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TRecord[K]\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1315 + +▸ WhereIn<TRecordInner, TResultInner\\>(`columnNames`: readonly string[], `values`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Type parameters: + +Name \| +:------ \| +`TRecordInner` \| +`TResultInner` \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`columnNames` \| readonly string[] \| +`values` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecordInner, TResultInner\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1319 diff --git a/knex.knex-1.wherenull.md b/knex.knex-1.wherenull.md index fa5c3d7..823fc39 100644 --- a/knex.knex-1.wherenull.md +++ b/knex.knex-1.wherenull.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.wherenull" +id: "knex.knex-1.wherenull" title: "Interface: WhereNull<TRecord, TResult>" sidebar_label: "WhereNull" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TRecord` \| any \| `TResult` \| unknown[] \| @@ -20,30 +21,30 @@ Name \| Default \| * WhereNull - ↳ [Where](knex.knex.where.md) + ↳ [Where](knex.knex-1.where.md) ## Callable -▸ WhereNull(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WhereNull(`columnName`: keyof TRecord): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| keyof TRecord \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1265 +Defined in: node_modules/knex/types/index.d.ts:1271 -▸ WhereNull(`columnName`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WhereNull(`columnName`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `columnName` \| string \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1266 +Defined in: node_modules/knex/types/index.d.ts:1272 diff --git a/knex.knex-1.whereraw.md b/knex.knex-1.whereraw.md index e04eeff..b105ae0 100644 --- a/knex.knex-1.whereraw.md +++ b/knex.knex-1.whereraw.md @@ -0,0 +1,77 @@ +--- +id: "knex.knex-1.whereraw" +title: "Interface: WhereRaw<TRecord, TResult>" +sidebar_label: "WhereRaw" +custom_edit_url: null +hide_title: true +--- + +# Interface: WhereRaw<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WhereRaw + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* [RawQueryBuilder](knex.knex-1.rawquerybuilder.md)<TRecord, TResult\\> + + ↳ WhereRaw + + ↳↳ [Where](knex.knex-1.where.md) + +## Callable + +▸ WhereRaw(`condition`: boolean): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`condition` \| boolean \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1263 + +▸ WhereRaw<TResult2\\>(`sql`: string, `bindings?`: [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`sql` \| string \| +`bindings?` \| [ValueDict](knex.knex-1.valuedict.md) \\\| [Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| readonly ([Value](../modules/knex.knex-1.md#value) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1489 + +▸ WhereRaw<TResult2\\>(`raw`: [Raw](knex.knex-1.raw.md)<TResult2\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +#### Type parameters: + +Name \| Default \| +:------ \| :------ \| +`TResult2` \| TResult \| + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`raw` \| [Raw](knex.knex-1.raw.md)<TResult2\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult2\\> + +Defined in: node_modules/knex/types/index.d.ts:1493 diff --git a/knex.knex-1.wherewrapped.md b/knex.knex-1.wherewrapped.md index 774acef..da8556e 100644 --- a/knex.knex-1.wherewrapped.md +++ b/knex.knex-1.wherewrapped.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.wherewrapped" +id: "knex.knex-1.wherewrapped" title: "Interface: WhereWrapped<TRecord, TResult>" sidebar_label: "WhereWrapped" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TRecord` \| any \| `TResult` \| unknown[] \| @@ -20,20 +21,20 @@ Name \| Default \| * WhereWrapped - ↳ [Where](knex.knex.where.md) + ↳ [Where](knex.knex-1.where.md) - ↳ [Having](knex.knex.having.md) + ↳ [Having](knex.knex-1.having.md) ## Callable -▸ WhereWrapped(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WhereWrapped(`callback`: [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `callback` \| [QueryCallback](../modules/knex.knex-1.md#querycallback)<TRecord, TResult\\> \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1261 +Defined in: node_modules/knex/types/index.d.ts:1267 diff --git a/knex.knex-1.with.md b/knex.knex-1.with.md index c9de196..adfd533 100644 --- a/knex.knex-1.with.md +++ b/knex.knex-1.with.md @@ -0,0 +1,81 @@ +--- +id: "knex.knex-1.with" +title: "Interface: With<TRecord, TResult>" +sidebar_label: "With" +custom_edit_url: null +hide_title: true +--- + +# Interface: With<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).With + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* [WithRaw](knex.knex-1.withraw.md)<TRecord, TResult\\> + +* [WithWrapped](knex.knex-1.withwrapped.md)<TRecord, TResult\\> + + ↳ With + +## Callable + +▸ With(`alias`: string, `raw`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`raw` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex-1.raw.md)<any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1188 + +▸ With(`alias`: string, `sql`: string, `bindings?`: Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`sql` \| string \| +`bindings?` \| Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[] \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1189 + +▸ With(`alias`: string, `queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`queryBuilder` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1200 + +▸ With(`alias`: string, `callback`: (`queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>) => any): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`callback` \| (`queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>) => any \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1201 diff --git a/knex.knex-1.withraw.md b/knex.knex-1.withraw.md index 7df317b..4b45432 100644 --- a/knex.knex-1.withraw.md +++ b/knex.knex-1.withraw.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.withraw" +id: "knex.knex-1.withraw" title: "Interface: WithRaw<TRecord, TResult>" sidebar_label: "WithRaw" +custom_edit_url: null hide_title: true --- @@ -12,7 +13,7 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TRecord` \| any \| `TResult` \| unknown[] \| @@ -20,33 +21,33 @@ Name \| Default \| * WithRaw - ↳ [With](knex.knex.with.md) + ↳ [With](knex.knex-1.with.md) ## Callable -▸ WithRaw(`alias`: string, `raw`: [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WithRaw(`alias`: string, `raw`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex-1.raw.md)<any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias` \| string \| -`raw` \| [QueryBuilder](../classes/knex.knex.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex.raw.md)<any\\> \| +`raw` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \\\| [Raw](knex.knex-1.raw.md)<any\\> \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1182 +Defined in: node_modules/knex/types/index.d.ts:1188 -▸ WithRaw(`alias`: string, `sql`: string, `bindings?`: Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WithRaw(`alias`: string, `sql`: string, `bindings?`: Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[]): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `alias` \| string \| `sql` \| string \| `bindings?` \| Object \\\| readonly [Value](../modules/knex.knex-1.md#value)[] \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1183 +Defined in: node_modules/knex/types/index.d.ts:1189 diff --git a/knex.knex-1.withschema.md b/knex.knex-1.withschema.md index 72cc0f7..13d6466 100644 --- a/knex.knex-1.withschema.md +++ b/knex.knex-1.withschema.md @@ -1,7 +1,8 @@ --- -id: "knex.knex.withschema" +id: "knex.knex-1.withschema" title: "Interface: WithSchema<TRecord, TResult>" sidebar_label: "WithSchema" +custom_edit_url: null hide_title: true --- @@ -12,24 +13,20 @@ hide_title: true ## Type parameters Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `TRecord` \| any \| `TResult` \| unknown[] \| -## Hierarchy - -* WithSchema - ## Callable -▸ WithSchema(`schema`: string): [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +▸ WithSchema(`schema`: string): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `schema` \| string \| -Returns: [QueryBuilder](../classes/knex.knex.querybuilder.md)<TRecord, TResult\\> +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> -Defined in: node_modules/knex/types/index.d.ts:1190 +Defined in: node_modules/knex/types/index.d.ts:1196 diff --git a/knex.knex-1.withwrapped.md b/knex.knex-1.withwrapped.md index c1a289e..f8ed8c4 100644 --- a/knex.knex-1.withwrapped.md +++ b/knex.knex-1.withwrapped.md @@ -0,0 +1,52 @@ +--- +id: "knex.knex-1.withwrapped" +title: "Interface: WithWrapped<TRecord, TResult>" +sidebar_label: "WithWrapped" +custom_edit_url: null +hide_title: true +--- + +# Interface: WithWrapped<TRecord, TResult\\> + +[knex](../modules/knex.md).[Knex](../modules/knex.knex-1.md).WithWrapped + +## Type parameters + +Name \| Default \| +:------ \| :------ \| +`TRecord` \| any \| +`TResult` \| unknown[] \| + +## Hierarchy + +* WithWrapped + + ↳ [With](knex.knex-1.with.md) + +## Callable + +▸ WithWrapped(`alias`: string, `queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`queryBuilder` \| [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\> \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1200 + +▸ WithWrapped(`alias`: string, `callback`: (`queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>) => any): [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`alias` \| string \| +`callback` \| (`queryBuilder`: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<any, any\\>) => any \| + +Returns: [QueryBuilder](../classes/knex.knex-1.querybuilder.md)<TRecord, TResult\\> + +Defined in: node_modules/knex/types/index.d.ts:1201 diff --git a/knex.table.md b/knex.table.md index c67e8b2..3d9944d 100644 --- a/knex.table.md +++ b/knex.table.md @@ -2,6 +2,7 @@ id: "knex.table" title: "Interface: Table" sidebar_label: "Table" +custom_edit_url: null hide_title: true --- @@ -9,17 +10,13 @@ hide_title: true [knex](../modules/knex.md).Table -## Hierarchy - -* Table - ## Properties ### schema\\_name -• `Optional` schema\\_name: undefined \\\| string +• `Optional` schema\\_name: string -Defined in: [packages/knex/src/typings.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L7) +Defined in: [packages/knex/src/typings.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L7) ___ @@ -27,4 +24,4 @@ ___ • table\\_name: string -Defined in: [packages/knex/src/typings.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L6) +Defined in: [packages/knex/src/typings.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L6) diff --git a/knex.tabledifference.md b/knex.tabledifference.md index abd8a06..283c3d0 100644 --- a/knex.tabledifference.md +++ b/knex.tabledifference.md @@ -2,6 +2,7 @@ id: "knex.tabledifference" title: "Interface: TableDifference" sidebar_label: "TableDifference" +custom_edit_url: null hide_title: true --- @@ -9,25 +10,21 @@ hide_title: true [knex](../modules/knex.md).TableDifference -## Hierarchy - -* TableDifference - ## Properties ### addIndex • addIndex: [IndexDef](knex.indexdef.md)[] -Defined in: [packages/knex/src/typings.ts:72](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L72) +Defined in: [packages/knex/src/typings.ts:72](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L72) ___ ### create -• create: [EntityProperty](core.entityproperty.md)<any\\>[] +• create: [EntityProperty](core.entityproperty.md)<any\\>[] -Defined in: [packages/knex/src/typings.ts:68](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L68) +Defined in: [packages/knex/src/typings.ts:68](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L68) ___ @@ -35,7 +32,7 @@ ___ • dropIndex: [IndexDef](knex.indexdef.md)[] -Defined in: [packages/knex/src/typings.ts:73](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L73) +Defined in: [packages/knex/src/typings.ts:73](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L73) ___ @@ -43,20 +40,20 @@ ___ • remove: [Column](knex.column.md)[] -Defined in: [packages/knex/src/typings.ts:71](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L71) +Defined in: [packages/knex/src/typings.ts:71](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L71) ___ ### rename -• rename: { `from`: [Column](knex.column.md) ; `to`: [EntityProperty](core.entityproperty.md)<any\\> }[] +• rename: { `from`: [Column](knex.column.md) ; `to`: [EntityProperty](core.entityproperty.md)<any\\> }[] -Defined in: [packages/knex/src/typings.ts:70](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L70) +Defined in: [packages/knex/src/typings.ts:70](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L70) ___ ### update -• update: { `column`: [Column](knex.column.md) ; `diff`: [IsSame](knex.issame.md) ; `prop`: [EntityProperty](core.entityproperty.md)<any\\> }[] +• update: { `column`: [Column](knex.column.md) ; `diff`: [IsSame](knex.issame.md) ; `prop`: [EntityProperty](core.entityproperty.md)<any\\> }[] -Defined in: [packages/knex/src/typings.ts:69](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L69) +Defined in: [packages/knex/src/typings.ts:69](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L69) diff --git a/cli.md b/cli.md index b4ccbc1..f2bdfd0 100644 --- a/cli.md +++ b/cli.md @@ -2,6 +2,7 @@ id: "cli" title: "Module: cli" sidebar_label: "cli" +custom_edit_url: null hide_title: true --- diff --git a/core.md b/core.md index ac5d172..77d9066 100644 --- a/core.md +++ b/core.md @@ -2,6 +2,7 @@ id: "core" title: "Module: core" sidebar_label: "core" +custom_edit_url: null hide_title: true --- @@ -140,6 +141,7 @@ hide_title: true - [LoadedReference](../interfaces/core.loadedreference.md) - [ManyToManyOptions](../interfaces/core.manytomanyoptions.md) - [ManyToOneOptions](../interfaces/core.manytooneoptions.md) +- [MatchingOptions](../interfaces/core.matchingoptions.md) - [MigrationObject](../interfaces/core.migrationobject.md) - [MikroORMOptions](../interfaces/core.mikroormoptions.md) - [NamingStrategy](../interfaces/core.namingstrategy.md) @@ -160,15 +162,15 @@ hide_title: true ### AnyEntity -Ƭ AnyEntity<T\\>: Partial<T\\> & { `__@EntityRepositoryType@41631?`: unknown ; `__@PrimaryKeyType@41543?`: unknown ; `__helper?`: IWrappedEntityInternal<T, keyof T\\> ; `__meta?`: [EntityMetadata](../classes/core.entitymetadata.md)<T\\> ; `__platform?`: [Platform](../classes/core.platform.md) } +Ƭ AnyEntity<T\\>: Partial<T\\> & { `[EntityRepositoryType]?`: unknown ; `[PrimaryKeyType]?`: unknown ; `__helper?`: IWrappedEntityInternal<T, keyof T\\> ; `__meta?`: [EntityMetadata](../classes/core.entitymetadata.md)<T\\> ; `__platform?`: [Platform](../classes/core.platform.md) } #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| -Defined in: [packages/core/src/typings.ts:110](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L110) +Defined in: [packages/core/src/typings.ts:110](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L110) ___ @@ -179,11 +181,11 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `R` \| -Defined in: [packages/core/src/typings.ts:12](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L12) +Defined in: [packages/core/src/typings.ts:12](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L12) ___ @@ -194,10 +196,22 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:8](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L8) +#### Type declaration: + +\\+ (...`args`: any[]): T + +#### Parameters: + +Name \| Type \| +:------ \| :------ \| +`...args` \| any[] \| + +Returns: T + +Defined in: [packages/core/src/typings.ts:8](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L8) ___ @@ -208,42 +222,45 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:15](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L15) +Defined in: [packages/core/src/typings.ts:15](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L15) ___ ### Dictionary -Ƭ Dictionary<T\\>: { [k: string]: T; } +Ƭ Dictionary<T\\>: object #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| -Defined in: [packages/core/src/typings.ts:9](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L9) +#### Type declaration: + +Defined in: [packages/core/src/typings.ts:9](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L9) ___ ### EmbeddedOptions -Ƭ EmbeddedOptions: { `entity?`: string \\\| () => [AnyEntity](core.md#anyentity) ; `nullable?`: boolean ; `object?`: boolean ; `prefix?`: string \\\| boolean ; `type?`: string } +Ƭ EmbeddedOptions: object #### Type declaration: Name \| Type \| ------- \| ------ \| -`entity?` \| string \\\| () => [AnyEntity](core.md#anyentity) \| -`nullable?` \| boolean \| -`object?` \| boolean \| -`prefix?` \| string \\\| boolean \| -`type?` \| string \| +:------ \| :------ \| +`array`? \| boolean \| +`entity`? \| string \\\| () => [AnyEntity](core.md#anyentity) \| +`nullable`? \| boolean \| +`object`? \| boolean \| +`prefix`? \| string \\\| boolean \| +`type`? \| string \| -Defined in: [packages/core/src/decorators/Embedded.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Embedded.ts#L19) +Defined in: [packages/core/src/decorators/Embedded.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Embedded.ts#L19) ___ @@ -254,89 +271,91 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:122](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L122) +Defined in: [packages/core/src/typings.ts:122](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L122) ___ ### EntityName -Ƭ EntityName<T\\>: string \\\| EntityClass<T\\> \\\| [EntitySchema](../classes/core.entityschema.md)<T, any\\> +Ƭ EntityName<T\\>: string \\\| EntityClass<T\\> \\\| [EntitySchema](../classes/core.entityschema.md)<T, any\\> #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| -Defined in: [packages/core/src/typings.ts:121](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L121) +Defined in: [packages/core/src/typings.ts:121](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L121) ___ ### EntityOptions -Ƭ EntityOptions<T\\>: { `abstract?`: boolean ; `collection?`: string ; `comment?`: string ; `customRepository?`: () => [Constructor](core.md#constructor)<[EntityRepository](../classes/core.entityrepository.md)<T\\>\\> ; `discriminatorColumn?`: string ; `discriminatorMap?`: [Dictionary](core.md#dictionary)<string\\> ; `discriminatorValue?`: string ; `readonly?`: boolean ; `tableName?`: string } +Ƭ EntityOptions<T\\>: object #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Type declaration: Name \| Type \| ------- \| ------ \| -`abstract?` \| boolean \| -`collection?` \| string \| -`comment?` \| string \| -`customRepository?` \| () => [Constructor](core.md#constructor)<[EntityRepository](../classes/core.entityrepository.md)<T\\>\\> \| -`discriminatorColumn?` \| string \| -`discriminatorMap?` \| [Dictionary](core.md#dictionary)<string\\> \| -`discriminatorValue?` \| string \| -`readonly?` \| boolean \| -`tableName?` \| string \| +:------ \| :------ \| +`abstract`? \| boolean \| +`collection`? \| string \| +`comment`? \| string \| +`customRepository`? \| () => [Constructor](core.md#constructor)<[EntityRepository](../classes/core.entityrepository.md)<T\\>\\> \| +`discriminatorColumn`? \| string \| +`discriminatorMap`? \| [Dictionary](core.md#dictionary)<string\\> \| +`discriminatorValue`? \| string \| +`readonly`? \| boolean \| +`tableName`? \| string \| -Defined in: [packages/core/src/decorators/Entity.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Entity.ts#L20) +Defined in: [packages/core/src/decorators/Entity.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Entity.ts#L20) ___ ### FieldsMap -Ƭ FieldsMap: { [K: string]: (string \\\| [FieldsMap](core.md#fieldsmap))[]; } +Ƭ FieldsMap: object + +#### Type declaration: -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:80](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L80) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:80](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L80) ___ ### FilterQuery -Ƭ FilterQuery<T\\>: NonNullable<Query<T\\>\\> \\\| { `__@PrimaryKeyType@41543?`: any } +Ƭ FilterQuery<T\\>: NonNullable<Query<T\\>\\> \\\| { `[PrimaryKeyType]?`: any } #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:76](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L76) +Defined in: [packages/core/src/typings.ts:76](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L76) ___ ### GetRepository -Ƭ GetRepository<T, U\\>: T[typeof [EntityRepositoryType](core.md#entityrepositorytype)] extends [EntityRepository](../classes/core.entityrepository.md)<any\\> \\\| undefined ? NonNullable<T[typeof [EntityRepositoryType](core.md#entityrepositorytype)]\\> : U +Ƭ GetRepository<T, U\\>: T[typeof [EntityRepositoryType](core.md#entityrepositorytype)] extends [EntityRepository](../classes/core.entityrepository.md)<any\\> \\\| undefined ? NonNullable<T[typeof [EntityRepositoryType](core.md#entityrepositorytype)]\\> : U #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| `U` \| - \| -Defined in: [packages/core/src/typings.ts:123](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L123) +Defined in: [packages/core/src/typings.ts:123](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L123) ___ @@ -347,10 +366,10 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| IPrimaryKeyValue \| IPrimaryKeyValue \| -Defined in: [packages/core/src/typings.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L37) +Defined in: [packages/core/src/typings.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L37) ___ @@ -361,11 +380,11 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| - \| -`PK` \| keyof T \\\| unknown \| [PrimaryProperty](core.md#primaryproperty)<T\\\\> \| +`PK` \| keyof T \\\| unknown \| [PrimaryProperty](core.md#primaryproperty)<T\\> \| -Defined in: [packages/core/src/entity/Reference.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/Reference.ts#L4) +Defined in: [packages/core/src/entity/Reference.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/Reference.ts#L4) ___ @@ -376,10 +395,10 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:13](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L13) +Defined in: [packages/core/src/typings.ts:13](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L13) ___ @@ -390,11 +409,11 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| - \| `P` \| - \| unknown \| -Defined in: [packages/core/src/typings.ts:407](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L407) +Defined in: [packages/core/src/typings.ts:413](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L413) ___ @@ -402,31 +421,31 @@ ___ Ƭ LoggerNamespace: query \\\| query-params \\\| discovery \\\| info -Defined in: [packages/core/src/utils/Logger.ts:34](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Logger.ts#L34) +Defined in: [packages/core/src/utils/Logger.ts:34](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Logger.ts#L34) ___ ### MigrationsOptions -Ƭ MigrationsOptions: { `allOrNothing?`: boolean ; `disableForeignKeys?`: boolean ; `dropTables?`: boolean ; `emit?`: js \\\| ts ; `fileName?`: (`timestamp`: string) => string ; `migrationsList?`: [MigrationObject](../interfaces/core.migrationobject.md)[] ; `path?`: string ; `pattern?`: RegExp ; `safe?`: boolean ; `tableName?`: string ; `transactional?`: boolean } +Ƭ MigrationsOptions: object #### Type declaration: Name \| Type \| ------- \| ------ \| -`allOrNothing?` \| boolean \| -`disableForeignKeys?` \| boolean \| -`dropTables?` \| boolean \| -`emit?` \| js \\\| ts \| -`fileName?` \| (`timestamp`: string) => string \| -`migrationsList?` \| [MigrationObject](../interfaces/core.migrationobject.md)[] \| -`path?` \| string \| -`pattern?` \| RegExp \| -`safe?` \| boolean \| -`tableName?` \| string \| -`transactional?` \| boolean \| +:------ \| :------ \| +`allOrNothing`? \| boolean \| +`disableForeignKeys`? \| boolean \| +`dropTables`? \| boolean \| +`emit`? \| js \\\| ts \| +`fileName`? \| (`timestamp`: string) => string \| +`migrationsList`? \| [MigrationObject](../interfaces/core.migrationobject.md)[] \| +`path`? \| string \| +`pattern`? \| RegExp \| +`safe`? \| boolean \| +`tableName`? \| string \| +`transactional`? \| boolean \| -Defined in: [packages/core/src/utils/Configuration.ts:294](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Configuration.ts#L294) +Defined in: [packages/core/src/utils/Configuration.ts:302](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L302) ___ @@ -437,11 +456,11 @@ ___ #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| - \| `P` \| - \| string[] \| -Defined in: [packages/core/src/typings.ts:415](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L415) +Defined in: [packages/core/src/typings.ts:421](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L421) ___ @@ -449,7 +468,7 @@ ___ Ƭ ORMDomain: Domain & { `__mikro_orm_context?`: [RequestContext](../classes/core.requestcontext.md) } -Defined in: [packages/core/src/utils/RequestContext.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/RequestContext.ts#L5) +Defined in: [packages/core/src/utils/RequestContext.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/RequestContext.ts#L5) ___ @@ -460,25 +479,25 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| -Defined in: [packages/core/src/decorators/OneToMany.ts:40](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/OneToMany.ts#L40) +Defined in: [packages/core/src/decorators/OneToMany.ts:40](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L40) ___ ### Options -Ƭ Options<D\\>: Pick<[MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>, Exclude<keyof [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>, keyof typeof [DEFAULTS](../classes/core.configuration.md#defaults)\\>\\> & Partial<[MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>\\> +Ƭ Options<D\\>: Pick<[MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>, Exclude<keyof [MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>, keyof typeof [DEFAULTS](../classes/core.configuration.md#defaults)\\>\\> & Partial<[MikroORMOptions](../interfaces/core.mikroormoptions.md)<D\\>\\> #### Type parameters: Name \| Type \| Default \| ------- \| ------ \| ------ \| +:------ \| :------ \| :------ \| `D` \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| [IDatabaseDriver](../interfaces/core.idatabasedriver.md) \| -Defined in: [packages/core/src/utils/Configuration.ts:388](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Configuration.ts#L388) +Defined in: [packages/core/src/utils/Configuration.ts:396](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Configuration.ts#L396) ___ @@ -489,105 +508,105 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:369](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L369) +Defined in: [packages/core/src/typings.ts:375](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L375) ___ ### PopulateOptions -Ƭ PopulateOptions<T\\>: { `all?`: boolean ; `children?`: [PopulateOptions](core.md#populateoptions)<T[keyof T]\\>[] ; `field`: string ; `strategy?`: [LoadStrategy](../enums/core.loadstrategy.md) } +Ƭ PopulateOptions<T\\>: object #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Type declaration: Name \| Type \| ------- \| ------ \| -`all?` \| boolean \| -`children?` \| [PopulateOptions](core.md#populateoptions)<T[keyof T]\\>[] \| +:------ \| :------ \| +`all`? \| boolean \| +`children`? \| [PopulateOptions](core.md#populateoptions)<T[keyof T]\\>[] \| `field` \| string \| -`strategy?` \| [LoadStrategy](../enums/core.loadstrategy.md) \| +`strategy`? \| [LoadStrategy](../enums/core.loadstrategy.md) \| -Defined in: [packages/core/src/typings.ts:371](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L371) +Defined in: [packages/core/src/typings.ts:377](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L377) ___ ### Primary -Ƭ Primary<T\\>: T extends { `__@PrimaryKeyType@41543`: infer PK } ? PK : T extends { `_id`: infer PK } ? PK \\\| string : T extends { `uuid`: infer PK } ? PK : T extends { `id`: infer PK } ? PK : never +Ƭ Primary<T\\>: T extends { `[PrimaryKeyType]`: infer PK } ? PK : T extends { `_id`: infer PK } ? PK \\\| string : T extends { `uuid`: infer PK } ? PK : T extends { `id`: infer PK } ? PK : never #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:26](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L26) +Defined in: [packages/core/src/typings.ts:26](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L26) ___ ### PrimaryProperty -Ƭ PrimaryProperty<T\\>: T extends { `__@PrimaryKeyProp@42958?`: infer PK } ? PK : T extends { `_id`: any } ? _id \\\| string : T extends { `uuid`: any } ? uuid : T extends { `id`: any } ? id : never +Ƭ PrimaryProperty<T\\>: T extends { `[PrimaryKeyProp]?`: infer PK } ? PK : T extends { `_id`: any } ? _id \\\| string : T extends { `uuid`: any } ? uuid : T extends { `id`: any } ? id : never #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/core/src/typings.ts:31](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L31) +Defined in: [packages/core/src/typings.ts:31](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L31) ___ ### PropertyOptions -Ƭ PropertyOptions<T\\>: { `columnType?`: string ; `comment?`: string ; `customType?`: [Type](../classes/core.type.md)<any\\> ; `default?`: string \\\| string[] \\\| number \\\| number[] \\\| boolean \\\| null ; `defaultRaw?`: string ; `fieldName?`: string ; `fieldNames?`: string[] ; `formula?`: string \\\| (`alias`: string) => string ; `hidden?`: boolean ; `index?`: boolean \\\| string ; `lazy?`: boolean ; `length?`: number ; `name?`: string ; `nullable?`: boolean ; `onCreate?`: (`entity`: T) => any ; `onUpdate?`: (`entity`: T) => any ; `persist?`: boolean ; `primary?`: boolean ; `serializedName?`: string ; `serializedPrimaryKey?`: boolean ; `serializer?`: (`value`: any) => any ; `type?`: string \\\| number \\\| boolean \\\| bigint \\\| ObjectId \\\| string \\\| unknown \\\| bigint \\\| Date \\\| [Constructor](core.md#constructor)<[Type](../classes/core.type.md)<any\\>\\> \\\| [Type](../classes/core.type.md)<any\\> ; `unique?`: boolean \\\| string ; `unsigned?`: boolean ; `version?`: boolean } +Ƭ PropertyOptions<T\\>: object #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Type declaration: Name \| Type \| ------- \| ------ \| -`columnType?` \| string \| -`comment?` \| string \| -`customType?` \| [Type](../classes/core.type.md)<any\\> \| -`default?` \| string \\\| string[] \\\| number \\\| number[] \\\| boolean \\\| null \| -`defaultRaw?` \| string \| -`fieldName?` \| string \| -`fieldNames?` \| string[] \| -`formula?` \| string \\\| (`alias`: string) => string \| -`hidden?` \| boolean \| -`index?` \| boolean \\\| string \| -`lazy?` \| boolean \| -`length?` \| number \| -`name?` \| string \| -`nullable?` \| boolean \| -`onCreate?` \| (`entity`: T) => any \| -`onUpdate?` \| (`entity`: T) => any \| -`persist?` \| boolean \| -`primary?` \| boolean \| -`serializedName?` \| string \| -`serializedPrimaryKey?` \| boolean \| -`serializer?` \| (`value`: any) => any \| -`type?` \| string \\\| number \\\| boolean \\\| bigint \\\| ObjectId \\\| string \\\| unknown \\\| bigint \\\| Date \\\| [Constructor](core.md#constructor)<[Type](../classes/core.type.md)<any\\>\\> \\\| [Type](../classes/core.type.md)<any\\> \| -`unique?` \| boolean \\\| string \| -`unsigned?` \| boolean \| -`version?` \| boolean \| - -Defined in: [packages/core/src/decorators/Property.ts:37](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L37) +:------ \| :------ \| +`columnType`? \| string \| +`comment`? \| string \| +`customType`? \| [Type](../classes/core.type.md)<any\\> \| +`default`? \| string \\\| string[] \\\| number \\\| number[] \\\| boolean \\\| null \| +`defaultRaw`? \| string \| +`fieldName`? \| string \| +`fieldNames`? \| string[] \| +`formula`? \| string \\\| (`alias`: string) => string \| +`hidden`? \| boolean \| +`index`? \| boolean \\\| string \| +`lazy`? \| boolean \| +`length`? \| number \| +`name`? \| string \| +`nullable`? \| boolean \| +`onCreate`? \| (`entity`: T) => any \| +`onUpdate`? \| (`entity`: T) => any \| +`persist`? \| boolean \| +`primary`? \| boolean \| +`serializedName`? \| string \| +`serializedPrimaryKey`? \| boolean \| +`serializer`? \| (`value`: any) => any \| +`type`? \| string \\\| number \\\| boolean \\\| bigint \\\| ObjectId \\\| string \\\| unknown \\\| bigint \\\| Date \\\| [Constructor](core.md#constructor)<[Type](../classes/core.type.md)<any\\>\\> \\\| [Type](../classes/core.type.md)<any\\> \| +`unique`? \| boolean \\\| string \| +`unsigned`? \| boolean \| +`version`? \| boolean \| + +Defined in: [packages/core/src/decorators/Property.ts:37](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L37) ___ @@ -598,10 +617,10 @@ ___ #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| -Defined in: [packages/core/src/typings.ts:77](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L77) +Defined in: [packages/core/src/typings.ts:77](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L77) ___ @@ -609,7 +628,7 @@ ___ Ƭ QueryOrderKeys: [QueryOrderKeysFlat](core.md#queryorderkeysflat) \\\| [QueryOrderMap](../interfaces/core.queryordermap.md) -Defined in: [packages/core/src/enums.ts:47](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L47) +Defined in: [packages/core/src/enums.ts:47](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L47) ___ @@ -617,7 +636,7 @@ ___ Ƭ QueryOrderKeysFlat: [QueryOrder](../enums/core.queryorder.md) \\\| [QueryOrderNumeric](../enums/core.queryordernumeric.md) \\\| keyof typeof [QueryOrder](../enums/core.queryorder.md) -Defined in: [packages/core/src/enums.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L46) +Defined in: [packages/core/src/enums.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L46) ___ @@ -625,7 +644,7 @@ ___ Ƭ TXDomain: Domain & { `__mikro_orm_tx_context?`: [TransactionContext](../classes/core.transactioncontext.md) } -Defined in: [packages/core/src/utils/TransactionContext.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/TransactionContext.ts#L5) +Defined in: [packages/core/src/utils/TransactionContext.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/TransactionContext.ts#L5) ___ @@ -636,10 +655,10 @@ ___ #### Type parameters: Name \| Default \| ------- \| ------ \| +:------ \| :------ \| `T` \| any \| -Defined in: [packages/core/src/connections/Connection.ts:141](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/connections/Connection.ts#L141) +Defined in: [packages/core/src/connections/Connection.ts:141](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/connections/Connection.ts#L141) ___ @@ -647,7 +666,7 @@ ___ Ƭ TransactionEventType: [beforeTransactionStart](../enums/core.eventtype.md#beforetransactionstart) \\\| [afterTransactionStart](../enums/core.eventtype.md#aftertransactionstart) \\\| [beforeTransactionCommit](../enums/core.eventtype.md#beforetransactioncommit) \\\| [afterTransactionCommit](../enums/core.eventtype.md#aftertransactioncommit) \\\| [beforeTransactionRollback](../enums/core.eventtype.md#beforetransactionrollback) \\\| [afterTransactionRollback](../enums/core.eventtype.md#aftertransactionrollback) -Defined in: [packages/core/src/enums.ts:115](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L115) +Defined in: [packages/core/src/enums.ts:115](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L115) ## Variables @@ -655,7 +674,7 @@ Defined in: [packages/core/src/enums.ts:115](https://github.com/mikro-orm/mikro- • `Const` ARRAY\\_OPERATORS: string[] -Defined in: [packages/core/src/enums.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L24) +Defined in: [packages/core/src/enums.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L24) ___ @@ -663,7 +682,7 @@ ___ • `Const` EntityManagerType: typeof [EntityManagerType](core.md#entitymanagertype) -Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/drivers/IDatabaseDriver.ts#L10) +Defined in: [packages/core/src/drivers/IDatabaseDriver.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/drivers/IDatabaseDriver.ts#L10) ___ @@ -671,7 +690,7 @@ ___ • `Const` EntityRepositoryType: typeof [EntityRepositoryType](core.md#entityrepositorytype) -Defined in: [packages/core/src/typings.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L23) +Defined in: [packages/core/src/typings.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L23) ___ @@ -679,7 +698,7 @@ ___ • `Const` ObjectBindingPattern: typeof [ObjectBindingPattern](core.md#objectbindingpattern) -Defined in: [packages/core/src/utils/Utils.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L14) +Defined in: [packages/core/src/utils/Utils.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L14) ___ @@ -687,7 +706,7 @@ ___ • `Const` PrimaryKeyProp: typeof [PrimaryKeyProp](core.md#primarykeyprop) -Defined in: [packages/core/src/typings.ts:25](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L25) +Defined in: [packages/core/src/typings.ts:25](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L25) ___ @@ -695,7 +714,7 @@ ___ • `Const` PrimaryKeyType: typeof [PrimaryKeyType](core.md#primarykeytype) -Defined in: [packages/core/src/typings.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/typings.ts#L24) +Defined in: [packages/core/src/typings.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/typings.ts#L24) ___ @@ -703,7 +722,7 @@ ___ • `Const` SCALAR\\_TYPES: string[] -Defined in: [packages/core/src/enums.ts:66](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/enums.ts#L66) +Defined in: [packages/core/src/enums.ts:66](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/enums.ts#L66) ## Functions @@ -711,9 +730,9 @@ Defined in: [packages/core/src/enums.ts:66](https://github.com/mikro-orm/mikro-o ▸ AfterCreate(): function -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L20) +Defined in: [packages/core/src/decorators/hooks.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L20) ___ @@ -723,9 +742,9 @@ ___ Called after deleting entity, but only when providing initialized entity to EM#remove() -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:46](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L46) +Defined in: [packages/core/src/decorators/hooks.ts:46](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L46) ___ @@ -733,9 +752,9 @@ ___ ▸ AfterUpdate(): function -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:28](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L28) +Defined in: [packages/core/src/decorators/hooks.ts:28](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L28) ___ @@ -743,9 +762,9 @@ ___ ▸ BeforeCreate(): function -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L16) +Defined in: [packages/core/src/decorators/hooks.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L16) ___ @@ -755,9 +774,9 @@ ___ Called before deleting entity, but only when providing initialized entity to EM#remove() -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:39](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L39) +Defined in: [packages/core/src/decorators/hooks.ts:39](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L39) ___ @@ -765,9 +784,9 @@ ___ ▸ BeforeUpdate(): function -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L24) +Defined in: [packages/core/src/decorators/hooks.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L24) ___ @@ -775,9 +794,9 @@ ___ ▸ Embeddable(): function -Returns: function +Returns: <T\\>(`target`: T & [Dictionary](core.md#dictionary)<any\\>) => T & [Dictionary](core.md#dictionary)<any\\> -Defined in: [packages/core/src/decorators/Embeddable.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Embeddable.ts#L4) +Defined in: [packages/core/src/decorators/Embeddable.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Embeddable.ts#L4) ___ @@ -787,30 +806,30 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`type` \| [EmbeddedOptions](core.md#embeddedoptions) \\\| () => [AnyEntity](core.md#anyentity) \| ... \| -`options` \| [EmbeddedOptions](core.md#embeddedoptions) \| ... \| +Name \| Type \| +:------ \| :------ \| +`type` \| [EmbeddedOptions](core.md#embeddedoptions) \\\| () => [AnyEntity](core.md#anyentity) \| +`options` \| [EmbeddedOptions](core.md#embeddedoptions) \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/Embedded.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Embedded.ts#L6) +Defined in: [packages/core/src/decorators/Embedded.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Embedded.ts#L6) ___ ### Entity -▸ Entity(`options?`: [EntityOptions](core.md#entityoptions)<any\\>): function +▸ Entity(`options?`: [EntityOptions](core.md#entityoptions)<any\\>): function #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [EntityOptions](core.md#entityoptions)<any\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [EntityOptions](core.md#entityoptions)<any\\> \| -Returns: function +Returns: <T\\>(`target`: T & [Dictionary](core.md#dictionary)<any\\>) => T & [Dictionary](core.md#dictionary)<any\\> -Defined in: [packages/core/src/decorators/Entity.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Entity.ts#L6) +Defined in: [packages/core/src/decorators/Entity.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Entity.ts#L6) ___ @@ -820,13 +839,13 @@ ___ #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [EnumOptions](../interfaces/core.enumoptions.md)<[AnyEntity](core.md#anyentity)\\> \\\| () => [Dictionary](core.md#dictionary) \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [EnumOptions](../interfaces/core.enumoptions.md)<[AnyEntity](core.md#anyentity)\\> \\\| () => [Dictionary](core.md#dictionary) \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/Enum.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Enum.ts#L7) +Defined in: [packages/core/src/decorators/Enum.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Enum.ts#L7) ___ @@ -837,18 +856,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| FilterDef<T\\> \| -Returns: function +Returns: <U\\>(`target`: U & [Dictionary](core.md#dictionary)<any\\>) => U & [Dictionary](core.md#dictionary)<any\\> -Defined in: [packages/core/src/decorators/Filter.ts:4](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Filter.ts#L4) +Defined in: [packages/core/src/decorators/Filter.ts:4](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Filter.ts#L4) ___ @@ -859,19 +878,19 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`formula` \| string \\\| (`alias`: string) => string \| - \| -`options` \| [FormulaOptions](../interfaces/core.formulaoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`formula` \| string \\\| (`alias`: string) => string \| +`options` \| [FormulaOptions](../interfaces/core.formulaoptions.md)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/Formula.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Formula.ts#L7) +Defined in: [packages/core/src/decorators/Formula.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Formula.ts#L7) ___ @@ -882,18 +901,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [IndexOptions](../interfaces/core.indexoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [IndexOptions](../interfaces/core.indexoptions.md)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName?`: string) => any -Defined in: [packages/core/src/decorators/Indexed.ts:20](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L20) +Defined in: [packages/core/src/decorators/Indexed.ts:20](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L20) ___ @@ -904,21 +923,21 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity?` \| [ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<T, O\\> \\\| string \\\| () => [EntityName](core.md#entityname)<T\\> \| - \| -`mappedBy?` \| string & keyof T \\\| (`e`: T) => any \| - \| -`options` \| Partial<[ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<T, O\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity?` \| [ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<T, O\\> \\\| string \\\| () => [EntityName](core.md#entityname)<T\\> \| +`mappedBy?` \| string & keyof T \\\| (`e`: T) => any \| +`options` \| Partial<[ManyToManyOptions](../interfaces/core.manytomanyoptions.md)<T, O\\>\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/ManyToMany.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToMany.ts#L7) +Defined in: [packages/core/src/decorators/ManyToMany.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToMany.ts#L7) ___ @@ -929,20 +948,20 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity` \| [ManyToOneOptions](../interfaces/core.manytooneoptions.md)<T, O\\> \\\| string \\\| (`e?`: any) => [EntityName](core.md#entityname)<T\\> \| ... \| -`options` \| Partial<[ManyToOneOptions](../interfaces/core.manytooneoptions.md)<T, O\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity` \| [ManyToOneOptions](../interfaces/core.manytooneoptions.md)<T, O\\> \\\| string \\\| (`e?`: any) => [EntityName](core.md#entityname)<T\\> \| +`options` \| Partial<[ManyToOneOptions](../interfaces/core.manytooneoptions.md)<T, O\\>\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/ManyToOne.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/ManyToOne.ts#L7) +Defined in: [packages/core/src/decorators/ManyToOne.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/ManyToOne.ts#L7) ___ @@ -950,9 +969,9 @@ ___ ▸ OnInit(): function -Returns: function +Returns: (`target`: any, `method`: string) => void -Defined in: [packages/core/src/decorators/hooks.ts:32](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/hooks.ts#L32) +Defined in: [packages/core/src/decorators/hooks.ts:32](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/hooks.ts#L32) ___ @@ -963,40 +982,40 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| string \\\| (`e?`: any) => [EntityName](core.md#entityname)<T\\> \| `mappedBy` \| string & keyof T \\\| (`e`: T) => any \| `options?` \| Partial<[OneToManyOptions](core.md#onetomanyoptions)<T, O\\>\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity), `propertyName`: string) => void -Defined in: [packages/core/src/decorators/OneToMany.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/OneToMany.ts#L24) +Defined in: [packages/core/src/decorators/OneToMany.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L24) ▸ OneToMany<T, O\\>(`options`: [OneToManyOptions](core.md#onetomanyoptions)<T, O\\>): function #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `options` \| [OneToManyOptions](core.md#onetomanyoptions)<T, O\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity), `propertyName`: string) => void -Defined in: [packages/core/src/decorators/OneToMany.ts:29](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/OneToMany.ts#L29) +Defined in: [packages/core/src/decorators/OneToMany.ts:29](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToMany.ts#L29) ___ @@ -1007,21 +1026,21 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| `O` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`entity?` \| [OneToOneOptions](../interfaces/core.onetooneoptions.md)<T, O\\> \\\| string \\\| (`e?`: any) => [EntityName](core.md#entityname)<T\\> \| - \| -`mappedBy?` \| string & keyof T \\\| (`e`: T) => any \| - \| -`options` \| Partial<[OneToOneOptions](../interfaces/core.onetooneoptions.md)<T, O\\>\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`entity?` \| [OneToOneOptions](../interfaces/core.onetooneoptions.md)<T, O\\> \\\| string \\\| (`e?`: any) => [EntityName](core.md#entityname)<T\\> \| +`mappedBy?` \| string & keyof T \\\| (`e`: T) => any \| +`options` \| Partial<[OneToOneOptions](../interfaces/core.onetooneoptions.md)<T, O\\>\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/OneToOne.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/OneToOne.ts#L5) +Defined in: [packages/core/src/decorators/OneToOne.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/OneToOne.ts#L5) ___ @@ -1032,18 +1051,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [PrimaryKeyOptions](../interfaces/core.primarykeyoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [PrimaryKeyOptions](../interfaces/core.primarykeyoptions.md)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/PrimaryKey.ts:19](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/PrimaryKey.ts#L19) +Defined in: [packages/core/src/decorators/PrimaryKey.ts:19](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/PrimaryKey.ts#L19) ___ @@ -1054,18 +1073,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [PropertyOptions](core.md#propertyoptions)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [PropertyOptions](core.md#propertyoptions)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/Property.ts:7](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Property.ts#L7) +Defined in: [packages/core/src/decorators/Property.ts:7](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Property.ts#L7) ___ @@ -1076,18 +1095,18 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| -`T` \| [AnyEntity](core.md#anyentity)<any\\> \| +:------ \| :------ \| +`T` \| [AnyEntity](core.md#anyentity)<any\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| EntityClass<T\\> \| -Returns: function +Returns: (`target`: [Constructor](core.md#constructor)<[EntityRepository](../classes/core.entityrepository.md)<T\\>\\>) => void -Defined in: [packages/core/src/decorators/Repository.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Repository.ts#L5) +Defined in: [packages/core/src/decorators/Repository.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Repository.ts#L5) ___ @@ -1098,18 +1117,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [SerializedPrimaryKeyOptions](../interfaces/core.serializedprimarykeyoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [SerializedPrimaryKeyOptions](../interfaces/core.serializedprimarykeyoptions.md)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName`: string) => any -Defined in: [packages/core/src/decorators/PrimaryKey.ts:23](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/PrimaryKey.ts#L23) +Defined in: [packages/core/src/decorators/PrimaryKey.ts:23](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/PrimaryKey.ts#L23) ___ @@ -1117,9 +1136,9 @@ ___ ▸ Subscriber(): function -Returns: function +Returns: (`target`: [Constructor](core.md#constructor)<[EventSubscriber](../interfaces/core.eventsubscriber.md)<any\\>\\>) => void -Defined in: [packages/core/src/decorators/Subscriber.ts:5](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Subscriber.ts#L5) +Defined in: [packages/core/src/decorators/Subscriber.ts:5](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Subscriber.ts#L5) ___ @@ -1130,18 +1149,18 @@ ___ #### Type parameters: Name \| ------- \| +:------ \| `T` \| #### Parameters: -Name \| Type \| Default value \| ------- \| ------ \| ------ \| -`options` \| [UniqueOptions](../interfaces/core.uniqueoptions.md)<T\\> \| ... \| +Name \| Type \| +:------ \| :------ \| +`options` \| [UniqueOptions](../interfaces/core.uniqueoptions.md)<T\\> \| -Returns: function +Returns: (`target`: [AnyEntity](core.md#anyentity)<any\\>, `propertyName?`: string) => any -Defined in: [packages/core/src/decorators/Indexed.ts:24](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/decorators/Indexed.ts#L24) +Defined in: [packages/core/src/decorators/Indexed.ts:24](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/decorators/Indexed.ts#L24) ___ @@ -1152,40 +1171,40 @@ ___ #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](core.md#entitydata)<T\\> \| `options?` \| [AssignOptions](../interfaces/core.assignoptions.md) \| Returns: T -Defined in: [packages/core/src/entity/EntityAssigner.ts:163](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L163) +Defined in: [packages/core/src/entity/EntityAssigner.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L183) ▸ `Const`assign<T\\>(`entity`: T, `data`: [EntityData](core.md#entitydata)<T\\>, `onlyProperties?`: boolean): T #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| [AnyEntity](core.md#anyentity)<T\\> \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `data` \| [EntityData](core.md#entitydata)<T\\> \| `onlyProperties?` \| boolean \| Returns: T -Defined in: [packages/core/src/entity/EntityAssigner.ts:163](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/EntityAssigner.ts#L163) +Defined in: [packages/core/src/entity/EntityAssigner.ts:183](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/EntityAssigner.ts#L183) ___ @@ -1196,13 +1215,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `a` \| any[] \| `b` \| any[] \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:59](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L59) +Defined in: [packages/core/src/utils/Utils.ts:59](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L59) ___ @@ -1213,13 +1232,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `a` \| Buffer \| `b` \| Buffer \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:76](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L76) +Defined in: [packages/core/src/utils/Utils.ts:76](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L76) ___ @@ -1230,13 +1249,13 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `a` \| any \| `b` \| any \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:16](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L16) +Defined in: [packages/core/src/utils/Utils.ts:16](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L16) ___ @@ -1249,13 +1268,13 @@ Checks if arguments are deeply (but not strictly) equal. #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `a` \| any \| `b` \| any \| Returns: boolean -Defined in: [packages/core/src/utils/Utils.ts:95](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/Utils.ts#L95) +Defined in: [packages/core/src/utils/Utils.ts:95](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/Utils.ts#L95) ___ @@ -1266,12 +1285,12 @@ ___ #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `sql` \| string \| Returns: string -Defined in: [packages/core/src/utils/QueryHelper.ts:241](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/utils/QueryHelper.ts#L241) +Defined in: [packages/core/src/utils/QueryHelper.ts:261](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/utils/QueryHelper.ts#L261) ___ @@ -1284,20 +1303,20 @@ returns WrappedEntity instance associated with this entity. This includes all th #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `preferHelper` \| true \| Returns: IWrappedEntityInternal<T, PK\\> -Defined in: [packages/core/src/entity/wrap.ts:6](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/wrap.ts#L6) +Defined in: [packages/core/src/entity/wrap.ts:6](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/wrap.ts#L6) ▸ wrap<T, PK\\>(`entity`: T, `preferHelper?`: false): [IWrappedEntity](../interfaces/core.iwrappedentity.md)<T, PK\\> @@ -1306,17 +1325,17 @@ wraps entity type with WrappedEntity internal properties and helpers like init/i #### Type parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `T` \| - \| `PK` \| string \\\| number \\\| symbol \| #### Parameters: Name \| Type \| ------- \| ------ \| +:------ \| :------ \| `entity` \| T \| `preferHelper?` \| false \| Returns: [IWrappedEntity](../interfaces/core.iwrappedentity.md)<T, PK\\> -Defined in: [packages/core/src/entity/wrap.ts:11](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/core/src/entity/wrap.ts#L11) +Defined in: [packages/core/src/entity/wrap.ts:11](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/core/src/entity/wrap.ts#L11) diff --git a/entity_generator.md b/entity_generator.md index 4d10fdb..d31930d 100644 --- a/entity_generator.md +++ b/entity_generator.md @@ -2,6 +2,7 @@ id: "entity_generator" title: "Module: entity-generator" sidebar_label: "entity-generator" +custom_edit_url: null hide_title: true --- @@ -11,4 +12,4 @@ hide_title: true ### Classes -- [EntityGenerator](../classes/entity-generator.entitygenerator.md) +- [EntityGenerator](../classes/entity_generator.entitygenerator.md) diff --git a/knex.md b/knex.md index 8b292ac..feac6aa 100644 --- a/knex.md +++ b/knex.md @@ -2,6 +2,7 @@ id: "knex" title: "Module: knex" sidebar_label: "knex" +custom_edit_url: null hide_title: true --- @@ -56,23 +57,23 @@ hide_title: true ### Field -Ƭ Field<T\\>: string \\\| keyof T \\\| [KnexStringRef](knex.md#knexstringref) \\\| [QueryBuilder](../classes/knex.knex.querybuilder.md) +Ƭ Field<T\\>: string \\\| keyof T \\\| [KnexStringRef](knex.md#knexstringref) \\\| [QueryBuilder](../classes/knex.knex-1.querybuilder.md) #### Type parameters: Name \| ------- \| +:------ \| `T` \| -Defined in: [packages/knex/src/typings.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L14) +Defined in: [packages/knex/src/typings.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L14) ___ ### KnexStringRef -Ƭ KnexStringRef: [Ref](../interfaces/knex.knex.ref.md)<string, { [alias: string]: string; }\\> +Ƭ KnexStringRef: [Ref](../interfaces/knex.knex-1.ref.md)<string, { [alias: string]: string; }\\> -Defined in: [packages/knex/src/typings.ts:10](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/typings.ts#L10) +Defined in: [packages/knex/src/typings.ts:10](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/typings.ts#L10) ## Variables @@ -82,14 +83,14 @@ Defined in: [packages/knex/src/typings.ts:10](https://github.com/mikro-orm/mikro #### Type declaration: -Name \| Type \| Value \| ------- \| ------ \| ------ \| -`MySqlDialect` \| any \| any \| -`PostgresDialectTableCompiler` \| any \| any \| -`Sqlite3Dialect` \| any \| any \| -`TableCompiler` \| any \| any \| +Name \| Type \| +:------ \| :------ \| +`MySqlDialect` \| any \| +`PostgresDialectTableCompiler` \| any \| +`Sqlite3Dialect` \| any \| +`TableCompiler` \| any \| -Defined in: [packages/knex/src/MonkeyPatchable.ts:14](https://github.com/mikro-orm/mikro-orm/blob/969d4229bd/packages/knex/src/MonkeyPatchable.ts#L14) +Defined in: [packages/knex/src/MonkeyPatchable.ts:14](https://github.com/mikro-orm/mikro-orm/blob/bcf1a0899b/packages/knex/src/MonkeyPatchable.ts#L14) ## Functions diff --git a/migrations.md b/migrations.md index 67f4ed3..731b655 100644 --- a/migrations.md +++ b/migrations.md @@ -0,0 +1,196 @@ +--- +title: Migrations +--- + +MikroORM has integrated support for migrations via [umzug](https://github.com/sequelize/umzug). +It allows you to generate migrations with current schema differences. + +By default, each migration will be all executed inside a transaction, and all of them will +be wrapped in one master transaction, so if one of them fails, everything will be rolled back. + +## Migration class + +Migrations are classes that extend Migration abstract class: + +```typescript +export class Migration20191019195930 extends Migration { + + async up(): Promise<void> { + this.addSql('select 1 + 1'); + } + +} +``` + +To support undoing those changed, you can implement the `down` method, which throws an error by default. + +Migrations are by default wrapped in a transaction. You can override this behaviour on +per migration basis by implementing the `isTransactional(): boolean` method. + +`Configuration` object and driver instance are available in the `Migration` class context. + +You can execute queries in the migration via `Migration.execute()` method, which +will run queries in the same transaction as the rest of the migration. The +`Migration.addSql()` method also accepts instances of knex. Knex instance can be +accessed via `Migration.getKnex()`; + +## Initial migration + +If you want to start using migrations, and you already have the schema generated, +you can do so by creating so called initial migration: + +> Initial migration can be created only if there are no migrations previously +> generated or executed. + +```sh +npx mikro-orm migration:create --initial +``` + +This will create the initial migration, containing the schema dump from +`schema:create` command. The migration will be automatically marked as executed. + +## Configuration + +```typescript +await MikroORM.init({ + // default values: + migrations: { + tableName: 'mikro_orm_migrations', // name of database table with log of executed transactions + path: './migrations', // path to the folder with migrations + pattern: /^[\\w-]+\\d+\\.ts$/, // regex pattern for the migration files + transactional: true, // wrap each migration in a transaction + disableForeignKeys: true, // wrap statements with `set foreign_key_checks = 0` or equivalent + allOrNothing: true, // wrap all migrations in master transaction + dropTables: true, // allow to disable table dropping + safe: false, // allow to disable table and column dropping + emit: 'ts', // migration generation mode + }, +}) +``` + +## Using via CLI + +You can use it via CLI: + +```sh +npx mikro-orm migration:create # Create new migration with current schema diff +npx mikro-orm migration:up # Migrate up to the latest version +npx mikro-orm migration:down # Migrate one step down +npx mikro-orm migration:list # List all executed migrations +npx mikro-orm migration:pending # List all pending migrations +``` + +For `migration:up` and `migration:down` commands you can specify `--from` (`-f`), `--to` (`-t`) +and `--only` (`-o`) options to run only a subset of migrations: + +```sh +npx mikro-orm migration:up --from 2019101911 --to 2019102117 # the same as above +npx mikro-orm migration:up --only 2019101923 # apply a single migration +npx mikro-orm migration:down --to 0 # migratee down all migrations +``` + +> To run TS migration files, you will need to [enable `useTsNode` flag](installation.md) +> in your `package.json`. + +## Using the Migrator programmatically + +Or you can create a simple script where you initialize MikroORM like this: + +```typescript title="./migrate.ts" +import { MikroORM } from '@mikro-orm/core'; + +(async () => { + const orm = await MikroORM.init({ + dbName: 'your-db-name', + // ... + }); + + const migrator = orm.getMigrator(); + await migrator.createMigration(); // creates file Migration20191019195930.ts + await migrator.up(); // runs migrations up to the latest + await migrator.up('name'); // runs only given migration, up + await migrator.up({ to: 'up-to-name' }); // runs migrations up to given version + await migrator.down(); // migrates one step down + await migrator.down('name'); // runs only given migration, down + await migrator.down({ to: 'down-to-name' }); // runs migrations down to given version + await migrator.down({ to: 0 }); // migrates down to the first version + + await orm.close(true); +})(); +``` + +Then run this script via `ts-node` (or compile it to plain JS and use `node`): + +```sh +$ ts-node migrate +``` + +## Providing transaction context + +In some cases you might want to control the transaction context yourself: + +```ts +await orm.em.transactional(async em => { + await migrator.up({ transaction: em.getTransactionContext() }); +}); +``` + +## Importing migrations statically + +If you do not want to dynamically import a folder (e.g. when bundling your code with webpack) you can import migrations +directly. + +```typescript +import { Migration20191019195930 } from '../migrations/Migration20191019195930.ts'; + +await MikroORM.init({ + migrations: { + migrationsList: [ + { + name: 'Migration20191019195930.ts', + class: Migration20191019195930, + }, + ], + }, +}); +``` + +With the help of (webpacks context module api)[https://webpack.js.org/guides/dependency-management/#context-module-api] +we can dynamically import the migrations making it possible to import all files in a folder. + +```typescript +import { basename } from 'path'; + +const migrations = {}; + +function importAll(r) { + r.keys().forEach( + (key) => (migrations[basename(key)] = Object.values(r(key))[0]) + ); +} + +importAll(require.context('../migrations', false, /\\.ts$/)); + +const migrationsList = Object.keys(migrations).map((migrationName) => ({ + name: migrationName, + class: migrations[migrationName], +})); + +await MikroORM.init({ + migrations: { + migrationsList, + }, +}); +``` + +## Limitations + +### MySQL + +There is no way to rollback DDL changes in MySQL. An implicit commit is forced for those +queries automatically, so transactions are not working as expected. + +- https://github.com/mikro-orm/mikro-orm/issues/217 +- https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html + +[← Back to table of contents](index.md#table-of-contents) diff --git a/reflection.md b/reflection.md index d2172b7..af916dc 100644 --- a/reflection.md +++ b/reflection.md @@ -2,6 +2,7 @@ id: "reflection" title: "Module: reflection" sidebar_label: "reflection" +custom_edit_url: null hide_title: true --- diff --git a/async-local-storage.md b/async-local-storage.md index 2964842..c565d55 100644 --- a/async-local-storage.md +++ b/async-local-storage.md @@ -0,0 +1,19 @@ +--- +title: Using AsyncLocalStorage +--- + +By default, `domain` api use used in the `RequestContext` helper. Since v4.0.3, +you can use the new `AsyncLocalStorage` too, if you are on up to date node version: + +```typescript +const storage = new AsyncLocalStorage<EntityManager>(); + +const orm = await MikroORM.init({ + context: () => storage.getStore(), + // ... +}); + +app.use((req, res, next) => { + storage.run(orm.em.fork(true, true), next); +}); +``` diff --git a/caching.md b/caching.md index 002b62a..b449571 100644 --- a/caching.md +++ b/caching.md @@ -0,0 +1,44 @@ +--- +title: Result cache +--- + +MikroORM has simple result caching mechanism. It works with those methods of +`EntityManager`: `find()`, `findOne()`, `findAndCount()`, `findOneOrFail()`, +`count()`, as well as with `QueryBuilder` result methods (including `execute`). + +By default, in memory cache is used, that is shared for the whole `MikroORM` +instance. Default expiration is 1 second. + +```ts +const res = await em.find(Book, { author: { name: 'Jon Snow' } }, { + populate: ['author', 'tags'], + cache: 50, // set expiration to 50ms + // cache: ['cache-id', 50], // set custom cache id and expiration + // cache: true, // use default cache id and expiration +}); +``` + +Or with query builder: + +```ts +const res = await em.createQueryBuilder(Book) + .where({ author: { name: 'Jon Snow' } }) + .cache() + .getResultList(); +``` + +We can change the default expiration as well as provide custom cache adapter in +the ORM configuration: + +```ts +const orm = await MikroORM.init({ + resultCache: { + adapter: MemoryCacheAdapter, + expiration: 1000, // 1s + options: {}, + }, + // ... +}); +``` + +Custom cache adapters need to implement `CacheAdapter` interface. diff --git a/cascading.md b/cascading.md index d227ee2..71b74f9 100644 --- a/cascading.md +++ b/cascading.md @@ -0,0 +1,137 @@ +--- +title: Cascading persist, merge and remove +sidebar_label: Cascading +--- + +> From v4.2, cascade merging is no longer configurable (and is kept enabled for all relations). + +> This section is about application level cascading. For that to work, we need +> to have relations populated. + +When persisting or removing entity, all your references are by default cascade persisted. +This means that by persisting any entity, ORM will automatically persist all of its +associations. + +You can control this behaviour via `cascade` attribute of `@ManyToOne`, `@ManyToMany`, +`@OneToMany` and `@OneToOne` fields. + +> New entities without primary key will be always persisted, regardless of `cascade` value. + +```typescript +// cascade persist is default value +@OneToMany({ entity: () => Book, mappedBy: 'author' }) +books = new Collection<Book>(this); + +// same as previous definition +@OneToMany({ entity: () => Book, mappedBy: 'author', cascade: [Cascade.PERSIST] }) +books = new Collection<Book>(this); + +// only cascade remove +@OneToMany({ entity: () => Book, mappedBy: 'author', cascade: [Cascade.REMOVE] }) +books = new Collection<Book>(this); + +// no cascade +@OneToMany({ entity: () => Book, mappedBy: 'author', cascade: [] }) +books = new Collection<Book>(this); + +// cascade all (persist and remove) +@OneToMany({ entity: () => Book, mappedBy: 'author', cascade: [Cascade.ALL] }) +books = new Collection<Book>(this); + +// same as previous definition +@OneToMany({ entity: () => Book, mappedBy: 'author', cascade: [Cascade.PERSIST, Cascade.REMOVE] }) +books = new Collection<Book>(this); +``` + +## Cascade persist + +Here is example of how cascade persist works: + +```typescript +const book = await orm.em.findOne(Book, 'id', ['author', 'tags']); +book.author.name = 'Foo Bar'; +book.tags[0].name = 'new name 1'; +book.tags[1].name = 'new name 2'; +await orm.em.persistAndFlush(book); // all book tags and author will be persisted too +``` + +> When cascade persisting collections, keep in mind only fully initialized collections +> will be cascade persisted. + +## Cascade remove + +Cascade remove works same way as cascade persist, just for removing entities. Following +example assumes that `Book.publisher` is set to `Cascade.REMOVE`: + +> Note that cascade remove for collections can be inefficient as it will fire 1 query +> for each entity in collection. + +```typescript +await orm.em.remove(book).flush(); // this will also remove book.publisher +``` + +Keep in mind that cascade remove can be dangerous when used on `@ManyToOne` fields, +as cascade removed entity can stay referenced in another entities that were not removed. + +```typescript +const publisher = new Publisher(...); +// all books with same publisher +book1.publisher = book2.publisher = book3.publisher = publisher; +await orm.em.remove(book1).flush(); // this will remove book1 and its publisher + +// but we still have reference to removed publisher here +console.log(book2.publisher, book3.publisher); +``` + +## Orphan removal + +In addition to `Cascade.REMOVE`, there is also additional and more aggressive remove +cascading mode which can be specified using the `orphanRemoval` flag of the `@OneToOne` +and `@OneToMany` properties: + +```typescript +@Entity() +export class Author { + + @OneToMany({ entity: () => Book, mappedBy: 'author', orphanRemoval: true }) + books = new Collection<Book>(this); + +} +``` + +> `orphanRemoval` flag behaves just like `Cascade.REMOVE` for remove operation, so specifying +> both is redundant. + +With simple `Cascade.REMOVE`, you would need to remove the `Author` entity to cascade +the operation down to all loaded `Book`s. By enabling orphan removal on the collection, +`Book`s will be also removed when they get disconnected from the collection (either via +`remove()`, or by replacing collection items via `set()`): + +```typescript +await author.books.set([book1, book2]); // replace whole collection +await author.books.remove(book1); // remove book from collection +await orm.em.persistAndFlush(author); // book1 will be removed, as well as all original items (before we called `set()`) +``` + +In this example, no `Book` would be removed with simple `Cascade.REMOVE` as no remove operation +was executed. + +## Declarative Referential Integrity + +> This is only supported in SQL drivers. + +As opposed to the application level cascading controlled by the `cascade` option, we can +also define database level referential integrity actions: `on update` and `on delete`. + +Their values are automatically inferred from the `cascade` option value. You can also +control the value manually via `onUpdateIntegrity` and `onDelete` options. + +```typescript +@Entity() +export class Book { + + @ManyToOne({ onUpdateIntegrity: 'set null', onDelete: 'cascade' }) + author?: Author; + +} +``` diff --git a/collections.md b/collections.md index 64dbf0f..775bf0e 100644 --- a/collections.md +++ b/collections.md @@ -0,0 +1,220 @@ +--- +title: Collections +--- + +`OneToMany` and `ManyToMany` collections are stored in a `Collection` wrapper. It implements +iterator so you can use `for of` loop to iterate through it. + +Another way to access collection items is to use bracket syntax like when you access array items. +Keep in mind that this approach will not check if the collection is initialed, while using `get` +method will throw error in this case. + +> Note that array access in `Collection` is available only for reading already loaded items, you +> cannot add new items to `Collection` this way. + +```typescript +const author = em.findOne(Author, '...', ['books']); // populating books collection + +// or we could lazy load books collection later via `init()` method +await author.books.init(); + +for (const book of author.books) { + console.log(book.title); // initialized + console.log(book.author.isInitialized()); // true + console.log(book.author.id); + console.log(book.author.name); // Jon Snow + console.log(book.publisher); // just reference + console.log(book.publisher.isInitialized()); // false + console.log(book.publisher.id); + console.log(book.publisher.name); // undefined +} + +// collection needs to be initialized before you can work with it +author.books.add(book); +console.log(author.books.contains(book)); // true +author.books.remove(book); +console.log(author.books.contains(book)); // false +author.books.add(book); +console.log(author.books.count()); // 1 +author.books.removeAll(); +console.log(author.books.contains(book)); // false +console.log(author.books.count()); // 0 +console.log(author.books.getItems()); // Book[] +console.log(author.books.getIdentifiers()); // array of string \| number +console.log(author.books.getIdentifiers('_id')); // array of ObjectId + +// array access works as well +console.log(author.books[1]); // Book +console.log(author.books[12345]); // undefined, even if the collection is not initialized + +const author = em.findOne(Author, '...'); // books collection has not been populated +const count = await author.books.loadCount(); // gets the count of collection items from database instead of counting loaded items +console.log(author.books.getItems()); // throws because the collection has not been initialized +// initialize collection if not already loaded and return its items as array +console.log(await author.books.loadItems()); // Book[] +``` + +## OneToMany Collections + +`OneToMany` collections are inverse side of `ManyToOne` references, to which they need to point via `fk` attribute: + +```typescript +@Entity() +export class Book { + + @PrimaryKey() + _id!: ObjectId; + + @ManyToOne() + author!: Author; + +} + +@Entity() +export class Author { + + @PrimaryKey() + _id!: ObjectId; + + @OneToMany(() => Book, book => book.author) + books1 = new Collection<Book>(this); + + // or via options object + @OneToMany({ entity: () => Book, mappedBy: 'author' }) + books2 = new Collection<Book>(this); + +} +``` + +## ManyToMany Collections + +For ManyToMany, SQL drivers use pivot table that holds reference to both entities. + +As opposed to them, with MongoDB we do not need to have join tables for `ManyToMany` +relations. All references are stored as an array of `ObjectId`s on owning entity. + +### Unidirectional + +Unidirectional `ManyToMany` relations are defined only on one side, if you define only `entity` +attribute, then it will be considered the owning side: + +```typescript +@ManyToMany(() => Book) +books1 = new Collection<Book>(this); + +// or mark it as owner explicitly via options object +@ManyToMany({ entity: () => Book, owner: true }) +books2 = new Collection<Book>(this); +``` + +### Bidirectional + +Bidirectional `ManyToMany` relations are defined on both sides, while one is owning side (where references are store), +marked by `inversedBy` attribute pointing to the inverse side: + +```typescript +@ManyToMany(() => BookTag, tag => tag.books, { owner: true }) +tags = new Collection<BookTag>(this); + +// or via options object +@ManyToMany({ entity: () => BookTag, inversedBy: 'books' }) +tags = new Collection<BookTag>(this); +``` + +And on the inversed side we define it with `mappedBy` attribute pointing back to the owner: + +```typescript +@ManyToMany(() => Book, book => book.tags) +books = new Collection<Book>(this); + +// or via options object +@ManyToMany({ entity: () => Book, mappedBy: 'tags' }) +books = new Collection<Book>(this); +``` + +### Forcing fixed order of collection items + +> Since v3 many to many collections does not require having auto increment primary key, that +> was used to ensure fixed order of collection items. + +To preserve fixed order of collections, you can use `fixedOrder: true` attribute, which will +start ordering by `id` column. Schema generator will convert the pivot table to have auto increment +primary key `id`. You can also change the order column name via `fixedOrderColumn: 'order'`. + +You can also specify default ordering via `orderBy: { ... }` attribute. This will be used when +you fully populate the collection including its items, as it orders by the referenced entity +properties instead of pivot table columns (which `fixedOrderColumn` is). On the other hand, +`fixedOrder` is used to maintain the insert order of items instead of ordering by some property. + +## Propagation of Collection's add() and remove() operations + +When you use one of `Collection.add()` method, the item is added to given collection, +and this action is also propagated to its counterpart. + +```typescript +// one to many +const author = new Author(...); +const book = new Book(...); + +author.books.add(book); +console.log(book.author); // author will be set thanks to the propagation +``` + +For M:N this works in both ways, either from owning side, or from inverse side. + +```typescript +// many to many works both from owning side and from inverse side +const book = new Book(...); +const tag = new BookTag(...); + +book.tags.add(tag); +console.log(tag.books.contains(book)); // true + +tag.books.add(book); +console.log(book.tags.contains(tag)); // true +``` + +> Collections on both sides have to be initialized, otherwise propagation won't work. + +> Although this propagation works also for M:N inverse side, you should always use owning +> side to manipulate the collection. + +Same applies for `Collection.remove()`. + +## Filtering and ordering of collection items + +When initializing collection items via `collection.init()`, you can filter the collection +as well as order its items: + +```typescript +await book.tags.init({ where: { active: true }, orderBy: { name: QueryOrder.DESC } }); +``` + +> You should never modify partially loaded collection. + +## Filtering Collections + +Collections have a `matching` method that allows to slice parts of data from a collection. +By default, it will return the list of entities based on the query. We can use the `store` +boolean parameter to save this list into the collection items - this will mark the +collection as `readonly`, methods like `add` or `remove` will throw. + +```ts +const a = await em.findOneOrFail(Author, 1); + +// only loading the list of items +const books = await a.books.matching({ limit: 3, offset: 10, orderBy: { title: 'asc' } }); +console.log(books); // [Book, Book, Book] +console.log(a.books.isInitialized()); // false + +// storing the items in collection +const tags = await books[0].tags.matching({ + limit: 3, + offset: 5, + orderBy: { name: 'asc' }, + store: true, +}); +console.log(tags); // [BookTag, BookTag, BookTag] +console.log(books[0].tags.isInitialized()); // true +console.log(books[0].tags.getItems()); // [BookTag, BookTag, BookTag] +``` diff --git a/composite-keys.md b/composite-keys.md index 5332efa..d4680f8 100644 --- a/composite-keys.md +++ b/composite-keys.md @@ -0,0 +1,264 @@ +--- +title: Composite and Foreign Keys as Primary Key +sidebar_label: Composite Primary Keys +--- + +> Support for composite keys was added in version 3.5 + +MikroORM supports composite primary keys natively. Composite keys are a very powerful +relational database concept and we took good care to make sure MikroORM supports as +many of the composite primary key use-cases. MikroORM supports composite keys of primitive +data-types as well as foreign keys as primary keys. You can also use your composite key +entities in relationships. + +This section shows how the semantics of composite primary keys work and how they map +to the database. + +## General Considerations + +ID fields have to have their values set before you call `em.persist(entity)`. + +## Primitive Types only + +Suppose you want to create a database of cars and use the model-name and year of +production as primary keys: + +```typescript +@Entity() +export class Car { + + @PrimaryKey() + name: string; + + @PrimaryKey() + year: number; + + [PrimaryKeyType]: [string, number]; // this is needed for proper type checks in `FilterQuery` + + constructor(name: string, year: number) { + this.name = name; + this.year = year; + } + +} +``` + +Now you can use this entity: + +```typescript +const car = new Car('Audi A8', 2010); +await em.persistAndFlush(car); +``` + +And for querying you need to provide all primary keys in the condition or an array of +primary keys in the same order as the keys were defined: + +```typescript +const audi1 = await em.findOneOrFail(Car, { name: 'Audi A8', year: 2010 }); +const audi2 = await em.findOneOrFail(Car, ['Audi A8', 2010]); +``` + +> If we want to use the second approach with primary key tuple, we will need to specify +> the type of entity's primary key via `PrimaryKeyType` symbol as shown in the `Car` entity. + +> `PrimaryKeyType` is not needed when your entity has single scalar primary key under +> one of following property names: `id: number \| string \| bigint`, `_id: any` or +> `uuid: string`. + +You can also use this entity in associations. MikroORM will then generate two foreign +keys one for name and to year to the related entities. + +This example shows how you can nicely solve the requirement for existing values before +`em.persist()`: By adding them as mandatory values for the constructor. + +## Identity through foreign Entities + +There are tons of use-cases where the identity of an Entity should be determined by +the entity of one or many parent entities. + +- Dynamic Attributes of an Entity (for example `Article`). Each Article has many + attributes with primary key `article_id` and `attribute_name`. +- `Address` object of a `Person`, the primary key of the address is `user_id`. This + is not a case of a composite primary key, but the identity is derived through a + foreign entity and a foreign key. +- Pivot Tables with metadata can be modelled as Entity, for example connections between + two articles with a little description and a score. + +The semantics of mapping identity through foreign entities are easy: + +- Only allowed on `@ManyToOnes` or `@OneToOne` associations. +- Use `primary: true` in the decorator. + +## Use-Case 1: Dynamic Attributes + +We keep up the example of an Article with arbitrary attributes, the mapping looks like this: + +```typescript +@Entity() +export class Article { + + @PrimaryKey() + id!: number; + + @Property() + title!: string; + + @OneToMany(() => ArticleAttribute, attr => attr.article, { cascade: Cascade.ALL }) + attributes = new Collection<ArticleAttribute>(this); + +} + +@Entity() +export class ArticleAttribute { + + @ManyToOne({ primary: true }) + article: Article; + + @PrimaryKey() + attribute: string; + + @Property() + value!: string; + + [PrimaryKeyType]: [number, string]; // this is needed for proper type checks in `FilterQuery` + + constructor(name: string, value: string, article: Article) { + this.attribute = name; + this.value = value; + this.article = article; + } + +} +``` + +## Use-Case 2: Simple Derived Identity + +Sometimes you have the requirement that two objects are related by a `@OneToOne` +association and that the dependent class should re-use the primary key of the class +it depends on. One good example for this is a user-address relationship: + +```typescript +@Entity() +export class User { + + @PrimaryKey() + id!: number; + + @OneToOne(() => Address, address => address.user, { cascade: [Cascade.ALL] }) + address?: Address; // virtual property (inverse side) to allow querying the relation + +} + +@Entity() +export class Address { + + @OneToOne({ primary: true }) + user!: User; + + [PrimaryKeyType]: number; // this is needed for proper type checks in `FilterQuery` + +} +``` + +## Use-Case 3: Join-Table with Metadata + +In the classic order product shop example there is the concept of the order item which +contains references to order and product and additional data such as the amount of products +purchased and maybe even the current price. + +```typescript +@Entity() +export class Order { + + @PrimaryKey() + id!: number; + + @ManyToOne() + customer: Customer; + + @OneToMany(() => OrderItem, item => item.order) + items = new Collection<OrderItem>(this); + + @Property() + paid = false; + + @Property() + shipped = false; + + @Property() + created = new Date(); + + constructor(customer: Customer) { + this.customer = customer; + } + +} + +@Entity() +export class Product { + + @PrimaryKey() + id!: number; + + @Property() + name!: string; + + @Property() + currentPrice!: number; + +} + +@Entity() +export class OrderItem { + + @ManyToOne({ primary: true }) + order: Order; + + @ManyToOne({ primary: true }) + product: Product; + + @Property() + amount = 1; + + @Property() + offeredPrice: number; + + [PrimaryKeyType]: [number, number]; // this is needed for proper type checks in `FilterQuery` + + constructor(order: Order, product: Product, amount = 1) { + this.order = order; + this.product = product; + this.offeredPrice = product.currentPrice; + } + +} +``` + +## Using QueryBuilder with composite keys + +Internally composite keys are represented as tuples, containing all the values in the +same order as the primary keys were defined. + +```typescript +const qb1 = em.createQueryBuilder(CarOwner); +qb1.select('').where({ car: { name: 'Audi A8', year: 2010 } }); +console.log(qb1.getQuery()); // select `e0`. from `car_owner` as `e0` where `e0`.`name` = ? and `e0`.`year` = ? + +const qb2 = em.createQueryBuilder(CarOwner); +qb2.select('').where({ car: ['Audi A8', 2010] }); +console.log(qb2.getQuery()); // 'select `e0`. from `car_owner` as `e0` where (`e0`.`car_name`, `e0`.`car_year`) = (?, ?)' + +const qb3 = em.createQueryBuilder(CarOwner); +qb3.select('').where({ car: [['Audi A8', 2010]] }); +console.log(qb3.getQuery()); // 'select `e0`. from `car_owner` as `e0` where (`e0`.`car_name`, `e0`.`car_year`) in ((?, ?))' +``` + +This also applies when you want to get a reference to entity with composite key: + +```typescript +const ref = em.getReference(Car, ['Audi A8', 2010]); +console.log(ref instanceof Car); // true +``` + +> This part of documentation is highly inspired by [doctrine tutorial](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/composite-primary-keys.html) +> as the behaviour here is pretty much the same. diff --git a/configuration.md b/configuration.md index bc98c81..787828b 100644 --- a/configuration.md +++ b/configuration.md @@ -0,0 +1,443 @@ +--- +title: Configuration +--- + +## Entity Discovery + +You can either provide array of entity instances via `entities`, or let the ORM look up your +entities in selected folders. + +```typescript +MikroORM.init({ + entities: [Author, Book, Publisher, BookTag], +}); +``` + +We can also use folder based discovery by providing list of paths to the entities +we want to discover (globs are supported as well). This way we also need to specify +`entitiesTs`, where we point the paths to the TS source files instead of the JS +compiled files (see more at [Metadata Providers](metadata-providers.md)). + +> The `entitiesTs` option is used when running the app via `ts-node`, as the ORM +> needs to discover the TS files. Always specify this option if you use folder/file +> based discovery. + +```typescript +MikroORM.init({ + entities: ['./dist/modules/users/entities', './dist/modules/projects/entities'], + entitiesTs: ['./src/modules/users/entities', './src/modules/projects/entities'], + // optionally you can override the base directory (defaults to `process.cwd()`) + baseDir: process.cwd(), +}); +``` + +> Be careful when overriding the `baseDir` with dynamic values like `__dirname`, +> as you can end up with valid paths from `ts-node`, but invalid paths from `node`. +> Ideally you should keep the default of `process.cwd()` there to always have the +> same base path regardless of how you run the app. + +By default, `ReflectMetadataProvider` is used that leverages the `reflect-metadata`. +You can also use `TsMorphMetadataProvider` by installing `@mikro-orm/reflection`. +This provider will analyse your entity source files (or `.d.ts` type definition files). +If you aim to use plain JavaScript instead of TypeScript, use `EntitySchema` or +the `JavaScriptMetadataProvider`. + +> You can also implement your own metadata provider and use it instead. To do so, extend the +> `MetadataProvider` class. + +```typescript +import { MikroORM } from '@mikro-orm/core'; +import { TsMorphMetadataProvider } from '@mikro-orm/reflection'; + +MikroORM.init({ + metadataProvider: TsMorphMetadataProvider, +}); +``` + +There are also some additional options how you can adjust the discovery process: + +```typescript +MikroORM.init({ + discovery: { + warnWhenNoEntities: false, // by default, discovery throws when no entity is processed + requireEntitiesArray: true, // force usage of class refrences in `entities` instead of paths + alwaysAnalyseProperties: false, // do not analyse properties when not needed (with ts-morph) + }, +}); +``` + +> If you disable `discovery.alwaysAnalyseProperties` option, you will need to explicitly +> provide `nullable` and `wrappedReference` parameters (where applicable). + +Read more about this in [Metadata Providers](metadata-providers.md) sections. + +## Driver + +To select driver, you can either use `type` option, or provide the driver class reference. + +\| type \| driver name \| dependency \| note \| +\|------\|-------------\|------------\|------\| +\| `mongo` \| `MongoDriver` \| `mongodb^3.3.4` \| - \| +\| `mysql` \| `MySqlDriver` \| `mysql2^2.0.0` \| compatible with MariaDB \| +\| `mariadb` \| `MariaDbDriver` \| `mariadb^2.0.0` \| compatible with MySQL \| +\| `postgresql` \| `PostgreSqlDriver` \| `pg^7.0.0` \| - \| +\| `sqlite` \| `SqliteDriver` \| `sqlite3^4.0.0` \| - \| + +> Driver and connection implementations are not directly exported from `@mikro-orm/core` module. +> You can import them from the driver packages (e.g. `import { PostgreSqlDriver } from '@mikro-orm/postgresql'`). + +> You can pass additional options to the underlying driver (e.g. `mysql2`) via `driverOptions`. +> The object will be deeply merged, overriding all internally used options. + +```typescript +import { MySqlDriver } from '@mikro-orm/mysql'; + +MikroORM.init({ + driver: MySqlDriver, + driverOptions: { connection: { timezone: '+02:00' } }, +}); +``` + +> From v3.5.1 you can also set the timezone directly in the ORM configuration: +> +> ```typescript +> MikroORM.init({ +> type: 'mysql', +> timezone: '+02:00', +> }); +> ``` + +## Connection + +Each platform (driver) provides default connection string, you can override it as a whole +through `clientUrl`, or partially through one of following options: + +```typescript +export interface ConnectionOptions { + dbName?: string; + name?: string; // for logging only (when replicas are used) + clientUrl?: string; + host?: string; + port?: number; + user?: string; + password?: string; + charset?: string; + multipleStatements?: boolean; // for mysql driver + pool?: PoolConfig; // provided by `knex` +} +``` + +Following table shows default client connection strings: + +\| type \| default connection url \| +\|------\|------------------------\| +\| `mongo` \| `mongodb://127.0.0.1:27017` \| +\| `mysql` \| `mysql://[email protected]:3306` \| +\| `mariadb` \| `mysql://[email protected]:3306` \| +\| `postgresql` \| `postgresql://[email protected]:5432` \| + +To set up read replicas, you can use `replicas` option. You can provide only those parts of the +`ConnectionOptions` interface, they will be used to override the `master` connection options. + +```typescript +MikroORM.init({ + type: 'mysql', + dbName: 'my_db_name', + user: 'write-user', + host: 'master.db.example.com', + port: 3306, + replicas: [ + { user: 'read-user-1', host: 'read-1.db.example.com', port: 3307 }, + { user: 'read-user-2', host: 'read-2.db.example.com', port: 3308 }, + { user: 'read-user-3', host: 'read-3.db.example.com', port: 3309 }, + ], +}); +``` + +Read more about this in [Installation](installation.md) and [Read Connections](read-connections.md) sections. + +## Naming Strategy + +When mapping your entities to database tables and columns, their names will be defined by naming +strategy. There are 3 basic naming strategies you can choose from: + +- `UnderscoreNamingStrategy` - default of all SQL drivers +- `MongoNamingStrategy` - default of `MongoDriver` +- `EntityCaseNamingStrategy` - uses unchanged entity and property names + +> You can also define your own custom `NamingStrategy` implementation. + +```typescript +MikroORM.init({ + namingStrategy: EntityCaseNamingStrategy, +}); +``` + +Read more about this in [Naming Strategy](naming-strategy.md) section. + +## Auto-join of 1:1 owners + +By default, owning side of 1:1 relation will be auto-joined when you select the inverse side +so we can have the reference to it. You can disable this behaviour via `autoJoinOneToOneOwner` +configuration toggle. + +```typescript +MikroORM.init({ + autoJoinOneToOneOwner: false, +}); +``` + +## Propagation of 1:1 and m:1 owners + +MikroORM defines getter and setter for every owning side of m:1 and 1:1 relation. This is +then used for propagation of changes to the inverse side of bi-directional relations. + +```typescript +const author = new Author('n', 'e'); +const book = new Book('t'); +book.author = author; +console.log(author.books.contains(book)); // true +``` + +You can disable this behaviour via `propagateToOneOwner` option. + +```typescript +MikroORM.init({ + propagateToOneOwner: false, +}); +``` + +## Forcing UTC Timezone + +Use `forceUtcTimezone` option to force the `Date`s to be saved in UTC in datetime columns +without timezone. It works for MySQL (`datetime` type) and PostgreSQL (`timestamp` type). +SQLite does this by default. + +```typescript +MikroORM.init({ + forceUtcTimezone: true, +}); +``` + +## Mapping `null` values to `undefined` + +By default `null` values from nullable database columns are hydrated as `null`. +Using `forceUndefined` we can tell the ORM to convert those `null` values to +`undefined` instead. + +```typescript +MikroORM.init({ + forceUndefined: true, +}); +``` + +## Custom Hydrator + +Hydrator is responsible for assigning values from the database to entities. +You can implement your custom `Hydrator` (by extending the abstract `Hydrator` class): + +```typescript +MikroORM.init({ + hydrator: MyCustomHydrator, +}); +``` + +## Custom Repository + +You can also register custom base repository (for all entities where you do not specify +`customRepository`) globally: + +> You can still use entity specific repositories in combination with global base repository. + +```typescript +MikroORM.init({ + entityRepository: CustomBaseRepository, +}); +``` + +Read more about this in [Repositories](repositories.md) section. + +## Strict Mode and property validation + +> Since v4.0.3 the validation needs to be explicitly enabled via `validate: true`. +> It has performance implications and usually should not be needed, as long as +> you don't modify your entities via `Object.assign()`. + +`MirkoORM` will validate your properties before actual persisting happens. It will try to fix wrong +data types for you automatically. If automatic conversion fails, it will throw an error. You can +enable strict mode to disable this feature and let ORM throw errors instead. Validation is triggered +when persisting the entity. + +```typescript +MikroORM.init({ + validate: true, + strict: true, +}); +``` + +Read more about this in [Property Validation](property-validation.md) section. + +## Debugging & Logging + +You can enable logging with `debug` option. Either set it to `true` to log everything, or +provide array of `'query' \| 'query-params' \| 'discovery' \| 'info'` namespaces. + +```typescript +MikroORM.init({ + logger: (message: string) => myLogger.info(message), // defaults to `console.log()` + debug: true, // or provide array like `['query', 'query-params']` + highlight: false, // defaults to true + highlightTheme: { ... }, // you can also provide custom highlight there +}); +``` + +Read more about this in [Debugging](debugging.md) section. + +## Custom Fail Handler + +When no entity is found during `em.findOneOrFail()` call, `new Error()` will be thrown. +You can customize how the `Error` instance is created via `findOneOrFailHandler`: + +```typescript +MikroORM.init({ + findOneOrFailHandler: (entityName: string, where: Dictionary \| IPrimaryKey) => { + return new NotFoundException(`${entityName} not found!`); + }, +}); +``` + +Read more about this in [Entity Manager](entity-manager.md#handling-not-found-entities) docs. + +## Migrations + +Under the `migrations` namespace, you can adjust how the integrated migrations support works. +Following example shows all possible options and their defaults: + +```typescript +MikroORM.init({ + migrations: { + tableName: 'mikro_orm_migrations', // migrations table name + path: process.cwd() + '/migrations', // path to folder with migration files + pattern: /^[\\w-]+\\d+\\.ts$/, // how to match migration files + transactional: true, // run each migration inside transaction + disableForeignKeys: true, // try to disable foreign_key_checks (or equivalent) + allOrNothing: true, // run all migrations in current batch in master transaction + emit: 'ts', // migration generation mode + }, +}); +``` + +Read more about this in [Migrations](migrations.md) section. + +## Caching + +By default, metadata discovery results are cached. You can either disable caching, or adjust +how it works. Following example shows all possible options and their defaults: + +```typescript +MikroORM.init({ + cache: { + enabled: true, + pretty: false, // allows to pretty print the JSON cache + adapter: FileCacheAdapter, // you can provide your own implementation here, e.g. with redis + options: { cacheDir: process.cwd() + '/temp' }, // options will be passed to the constructor of `adapter` class + }, +}); +``` + +Read more about this in [Metadata Cache](metadata-cache.md) section. + +## Importing database dump files (MySQL and PostgreSQL) + +Using the `mikro-orm database:import db-file.sql` you can import a database dump file. This can be useful when kickstarting an application or could be used in tests to reset the database. Database dumps often have queries spread over multiple lines and therefore you need the following configuration. + +```typescript +MikroORM.init({ + ... + multipleStatements: true, + ... +}); +``` + > This should be disabled in production environments for added security. + +## Using native private properties + +If we want to use native private properties inside entities, the default approach of +how MikroORM creates entity instances via `Object.create()` is not viable (more about this +in the [issue](https://github.com/mikro-orm/mikro-orm/issues/1226)). To force usage of entity +constructors, we can use `forceEntityConstructor` toggle: + +```ts +MikroORM.init({ + ... + forceEntityConstructor: true, // or specify just some entities via `[Author, 'Book', ...]` + ... +}); +``` + +## Using environment variables + +Since v4.5 it is possible to set most of the ORM options via environment variables. +By default `.env` file from the root directory is loaded - it is also possible to +set full path to the env file you want to use via `MIKRO_ORM_ENV` environment variable. + +> Environment variables always have precedence. + +Example `.env` file: + +```dotenv +MIKRO_ORM_TYPE = sqlite +MIKRO_ORM_ENTITIES = ./dist/foo/.entity.js, ./dist/bar/.entity.js +MIKRO_ORM_ENTITIES_TS = ./src/foo/.entity.ts, ./src/bar/.entity.ts +MIKRO_ORM_DB_NAME = test.db +MIKRO_ORM_MIGRATIONS_PATH = ./dist/migrations +MIKRO_ORM_MIGRATIONS_PATTERN = ^[\\w-]+\\d+\\.js$ +MIKRO_ORM_POPULATE_AFTER_FLUSH = true +MIKRO_ORM_FORCE_ENTITY_CONSTRUCTOR = true +MIKRO_ORM_FORCE_UNDEFINED = true +``` + +Full list of supported options: + +\| env variable \| config key \| +\|--------------\|------------\| +\| `MIKRO_ORM_BASE_DIR` \| `baseDir` \| +\| `MIKRO_ORM_TYPE` \| `type` \| +\| `MIKRO_ORM_ENTITIES` \| `entities` \| +\| `MIKRO_ORM_ENTITIES_TS` \| `entitiesTs` \| +\| `MIKRO_ORM_CLIENT_URL` \| `clientUrl` \| +\| `MIKRO_ORM_HOST` \| `host` \| +\| `MIKRO_ORM_PORT` \| `port` \| +\| `MIKRO_ORM_USER` \| `user` \| +\| `MIKRO_ORM_PASSWORD` \| `password` \| +\| `MIKRO_ORM_DB_NAME` \| `dbName` \| +\| `MIKRO_ORM_LOAD_STRATEGY` \| `loadStrategy` \| +\| `MIKRO_ORM_BATCH_SIZE` \| `batchSize` \| +\| `MIKRO_ORM_USE_BATCH_INSERTS` \| `useBatchInserts` \| +\| `MIKRO_ORM_USE_BATCH_UPDATES` \| `useBatchUpdates` \| +\| `MIKRO_ORM_STRICT` \| `strict` \| +\| `MIKRO_ORM_VALIDATE` \| `validate` \| +\| `MIKRO_ORM_AUTO_JOIN_ONE_TO_ONE_OWNER` \| `autoJoinOneToOneOwner` \| +\| `MIKRO_ORM_PROPAGATE_TO_ONE_OWNER` \| `propagateToOneOwner` \| +\| `MIKRO_ORM_POPULATE_AFTER_FLUSH` \| `populateAfterFlush` \| +\| `MIKRO_ORM_FORCE_ENTITY_CONSTRUCTOR` \| `forceEntityConstructor` \| +\| `MIKRO_ORM_FORCE_UNDEFINED` \| `forceUndefined` \| +\| `MIKRO_ORM_FORCE_UTC_TIMEZONE` \| `forceUtcTimezone` \| +\| `MIKRO_ORM_TIMEZONE` \| `timezone` \| +\| `MIKRO_ORM_ENSURE_INDEXES` \| `ensureIndexes` \| +\| `MIKRO_ORM_IMPLICIT_TRANSACTIONS` \| `implicitTransactions` \| +\| `MIKRO_ORM_DEBUG` \| `debug` \| +\| `MIKRO_ORM_VERBOSE` \| `verbose` \| +\| `MIKRO_ORM_DISCOVERY_WARN_WHEN_NO_ENTITIES` \| `discovery.warnWhenNoEntities` \| +\| `MIKRO_ORM_DISCOVERY_REQUIRE_ENTITIES_ARRAY` \| `discovery.requireEntitiesArray` \| +\| `MIKRO_ORM_DISCOVERY_ALWAYS_ANALYSE_PROPERTIES` \| `discovery.alwaysAnalyseProperties` \| +\| `MIKRO_ORM_DISCOVERY_DISABLE_DYNAMIC_FILE_ACCESS` \| `discovery.disableDynamicFileAccess` \| +\| `MIKRO_ORM_MIGRATIONS_TABLE_NAME` \| `migrations.tableName` \| +\| `MIKRO_ORM_MIGRATIONS_PATH` \| `migrations.path` \| +\| `MIKRO_ORM_MIGRATIONS_PATTERN` \| `migrations.pattern` \| +\| `MIKRO_ORM_MIGRATIONS_TRANSACTIONAL` \| `migrations.transactional` \| +\| `MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS` \| `migrations.disableForeignKeys` \| +\| `MIKRO_ORM_MIGRATIONS_ALL_OR_NOTHING` \| `migrations.allOrNothing` \| +\| `MIKRO_ORM_MIGRATIONS_DROP_TABLES` \| `migrations.dropTables` \| +\| `MIKRO_ORM_MIGRATIONS_SAFE` \| `migrations.safe` \| +\| `MIKRO_ORM_MIGRATIONS_EMIT` \| `migrations.emit` \| diff --git a/custom-driver.md b/custom-driver.md index c1fdec1..9b3ba59 100644 --- a/custom-driver.md +++ b/custom-driver.md @@ -0,0 +1,108 @@ +--- +title: Creating Custom Driver +--- + +If you want to use database that is not currently supported, you can implement your own driver. +To do so, you will need to design 4 classes: + +## Platform + +Platform is a class that provides information about available features of given driver: + +```typescript +import { Platform } from '@mikro-orm/core'; + +export class MyCustomPlatform extends Platform { + + protected abstract schemaHelper: MyCustomSchemaHelper; + + // here you can override default settings + usesPivotTable(): boolean; + supportsTransactions(): boolean; + supportsSavePoints(): boolean; + getNamingStrategy(): { new (): NamingStrategy; }; + getIdentifierQuoteCharacter(): string; + getParameterPlaceholder(index?: number): string; + usesReturningStatement(): boolean; + normalizePrimaryKey<T = number \| string>(data: IPrimaryKey): T; + denormalizePrimaryKey(data: IPrimaryKey): IPrimaryKey; + getSerializedPrimaryKeyField(field: string): string; + +} +``` + +## SchemaHelper + +Part of platform is a `SchemaHelper`, that provides information about how to build schema. + +```typescript +import { SchemaHelper } from '@mikro-orm/core'; + +export class MyCustomSchemaHelper extends SchemaHelper { + + // here you can override default settings + getIdentifierQuoteCharacter(): string; + getSchemaBeginning(): string; + getSchemaEnd(): string; + getSchemaTableEnd(): string; + getAutoIncrementStatement(meta: EntityMetadata): string; + getPrimaryKeySubtype(meta: EntityMetadata): string; + getTypeDefinition(prop: EntityProperty, types?: Record<string, string>, lengths?: Record<string, number>): string; + getUnsignedSuffix(prop: EntityProperty): string; + supportsSchemaConstraints(): boolean; + supportsSchemaMultiAlter(): boolean; + supportsSequences(): boolean; + quoteIdentifier(field: string): string; + dropTable(meta: EntityMetadata): string; + indexForeignKeys(): boolean; + +} +``` + +## Connection + +Next part is connection wrapper, that will be responsible for querying the database: + +```typescript +import { Connection } from '@mikro-orm/core'; + +export class MyCustomConnection extends Connection { + + // implement abstract methods + connect(): Promise<void>; + isConnected(): Promise<boolean>; + close(force?: boolean): Promise<void>; + getDefaultClientUrl(): string; + execute(query: string, params?: any[], method?: 'all' \| 'get' \| 'run'): Promise<QueryResult \| any \| any[]>; + +} +``` + +## Driver + +Last part is driver, that is responsible for using the connection to persist changes to +database. If you are building SQL driver, it might be handy to extend `AbstractSqlDriver`, +if not, extend `DatabaseDriver` abstract class. + +If you want to have absolute control, you can implement the whole driver yourself via +`IDatabaseDriver` interface. + +```typescript +import { DatabaseDriver } from '@mikro-orm/core'; + +export class MyCustomSchemaHelper extends DatabaseDriver { + + // initialize connection and platform + protected readonly connection = new MyCustomConnection(this.config); + protected readonly platform = new MyCustomPlatform; + + // and implement abstract methods + find<T extends AnyEntity>(entityName: string, where: FilterQuery<T>, populate?: string[], orderBy?: Record<string, QueryOrder>, limit?: number, offset?: number): Promise<T[]>; + findOne<T extends AnyEntity>(entityName: string, where: FilterQuery<T> \| string, populate: string[]): Promise<T \| null>; + nativeInsert<T extends AnyEntityType<T>>(entityName: string, data: EntityData<T>): Promise<QueryResult>; + nativeUpdate<T extends AnyEntity>(entityName: string, where: FilterQuery<T> \| IPrimaryKey, data: EntityData<T>): Promise<QueryResult>; + nativeDelete<T extends AnyEntity>(entityName: string, where: FilterQuery<T> \| IPrimaryKey): Promise<QueryResult>; + count<T extends AnyEntity>(entityName: string, where: FilterQuery<T>): Promise<number>; + +} +``` diff --git a/custom-types.md b/custom-types.md index da6fcc2..2a2a233 100644 --- a/custom-types.md +++ b/custom-types.md @@ -0,0 +1,301 @@ +--- +title: Custom Types +--- + +You can define custom types by extending `Type` abstract class. It has several optional methods: + +- `convertToDatabaseValue(value: any, platform: Platform): any` + + Converts a value from its JS representation to its database representation of this type. + By default returns unchanged `value`. + +- `convertToJSValue(value: any, platform: Platform): any` + + Converts a value from its database representation to its JS representation of this type. + By default returns unchanged `value`. + +- `toJSON(value: any, platform: Platform): any` + + Converts a value from its JS representation to its serialized JSON form of this type. + By default uses the runtime value. + +- `getColumnType(prop: EntityProperty, platform: Platform): string` + + Gets the SQL declaration snippet for a field of this type. + By default returns `columnType` of given property. + +- `convertToDatabaseValueSQL(key: string, platform: Platform): string` + + Converts a value from its JS representation to its database representation of this type. + _(added in v4.4.2)_ + +- `convertToJSValueSQL?(key: string, platform: Platform): string` + + Modifies the SQL expression (identifier, parameter) to convert to a JS value. + _(added in v4.4.2)_ + +```typescript +import { Type, Platform, EntityProperty, ValidationError } from '@mikro-orm/core'; + +export class DateType extends Type<Date, string> { + + convertToDatabaseValue(value: Date \| string \| undefined, platform: Platform): string { + if (value instanceof Date) { + return value.toISOString().substr(0, 10); + } + + if (!value \|\| value.toString().match(/^\\d{4}-\\d{2}-\\d{2}$/)) { + return value as string; + } + + throw ValidationError.invalidType(DateType, value, 'JS'); + } + + convertToJSValue(value: Date \| string \| undefined, platform: Platform): Date { + if (!value \|\| value instanceof Date) { + return value as Date; + } + + const date = new Date(value); + + if (date.toString() === 'Invalid Date') { + throw ValidationError.invalidType(DateType, value, 'database'); + } + + return date; + } + + getColumnType(prop: EntityProperty, platform: Platform) { + return `date(${prop.length})`; + } + +} +``` + +Then you can use this type when defining your entity properties: + +```typescript +@Entity() +export class FooBar { + + @PrimaryKey() + id!: number; + + @Property() + name!: string; + + @Property({ type: DateType, length: 3 }) + born?: Date; + +} +``` + +## Advanced example - PointType and WKT + +In this example we will combine mapping values via database as well as during runtime. + +> The Point type is part of the Spatial extension of MySQL and enables you to store +> a single location in a coordinate space by using x and y coordinates. You can use +> the Point type to store a longitude/latitude pair to represent a geographic location. + +First let's define the `Point` class that will be used to represent the value during runtime: + +```ts +export class Point { + + constructor(public latitude: number, + public longitude: number) { } + +} +``` + +Then the mapping type: + +```ts +export class PointType extends Type<Point \| undefined, string \| undefined> { + + convertToDatabaseValue(value: Point \| undefined): string \| undefined { + if (!value) { + return value; + } + + return `point(${value.latitude} ${value.longitude})`; + } + + convertToJSValue(value: string \| undefined): Point \| undefined { + const m = value?.match(/point\$(\\d+(\\.\\d+)?) (\\d+(\\.\\d+)?)\$/i); + + if (!m) { + return undefined; + } + + return new Point(+m[1], +m[3]); + } + + convertToJSValueSQL(key: string) { + return `ST_AsText(${key})`; + } + + convertToDatabaseValueSQL(key: string) { + return `ST_PointFromText(${key})`; + } + + getColumnType(): string { + return 'point'; + } + +} +``` + +Now let's define an entity: + +```ts +@Entity() +export class Location { + + @PrimaryKey() + id!: number; + + @Property({ type: PointType }) + point?: Point; + +} +``` + +...and use it: + +```ts +const loc = new Location(); +loc.point = new Point(1.23, 4.56); +await em.persist(loc).flush(); +em.clear(); + +const loc1 = await em.findOneOrFail(Location, loc.id); + +// update it +loc1.point = new Point(2.34, 9.87); +await em.flush(); +``` + +This will result in following queries: + +```sql +begin +insert into `location` (`point`) values (ST_PointFromText('point(1.23 4.56)')) +commit + +select `e0`., ST_AsText(`e0`.point) as point from `location` as `e0` where `e0`.`id` = ? limit ? + +begin +update `location` set `point` = ST_PointFromText('point(2.34 9.87)') where `id` = ? +commit +``` + +We do a 2-step conversion here. In the first step, we convert the Point object into +a string representation before saving to the database (in the convertToDatabaseValue +method) and back into an object after fetching the value from the database (in the +convertToJSValue method). + +The format of the string representation format is called Well-known text (WKT). The +advantage of this format is, that it is both human readable and parsable by MySQL. + +Internally, MySQL stores geometry values in a binary format that is not identical to +the WKT format. So, we need to let MySQL transform the WKT representation into its +internal format. + +This is where the `convertToJSValueSQL` and `convertToDatabaseValueSQL` methods come +into play. + +This methods wrap a sql expression (the WKT representation of the Point) into MySQL +functions ST_PointFromText and ST_AsText which convert WKT strings to and from the +internal format of MySQL. + +> When using DQL queries, the `convertToJSValueSQL` and `convertToDatabaseValueSQL` methods +> only apply to identification variables and path expressions in SELECT clauses. Expressions +> in WHERE clauses are not wrapped! + +## Types provided by MikroORM + +There are few types provided by MikroORM. All of them aim to provide similar +experience among all the drivers, even if the particular feature is not supported +out of box by the driver. + +### ArrayType + +In PostgreSQL and MongoDB, it uses native arrays, otherwise it concatenates the +values into string separated by commas. This means that you can't use values that +contain comma with the `ArrayType` (but you can create custom array type that will +handle this case, e.g. by using different separator). + +By default array of strings is returned from the type. You can also have arrays +of numbers or other data types - to do so, you will need to implement custom +`hydrate` method that is used for converting the array values to the right type. + +> `ArrayType` will be used automatically if `type` is set to `array` (default behaviour +> of reflect-metadata) or `string[]` or `number[]` (either manually or via ts-morph). +> In case of `number[]` it will automatically handle the conversion to numbers. +> This means that the following examples would both have the `ArrayType` used +> automatically (but with reflect-metadata we would have a string array for both +> unless we specify the type manually as `type: 'number[]') + +```typescript +@Property({ type: ArrayType, nullable: true }) +stringArray?: string[]; + +@Property({ type: new ArrayType(i => +i), nullable: true }) +numericArray?: number[]; +``` + +### BigIntType + +You can use `BigIntType` to support `bigint`s. By default, it will represent the +value as a `string`. + +```typescript +@PrimaryKey({ type: BigIntType }) +id: string; +``` + +### BlobType + +Blob type can be used to store binary data in the database. + +> `BlobType` will be used automatically if you specify the type hint as `Buffer`. +> This means that the following example should work even without the explicit +> `type: BlobType` option (with both reflect-metadata and ts-morph providers). + +```typescript +@Property({ type: BlobType, nullable: true }) +blob?: Buffer; +``` + +### JsonType + +To store objects we can use `JsonType`. As some drivers are handling objects +automatically and some don't, this type will handle the serialization in a driver +independent way (calling `parse` and `stringify` only when needed). + +```typescript +@Property({ type: JsonType, nullable: true }) +object?: { foo: string; bar: number }; +``` + +### DateType + +To store dates without time information, we can use `DateType`. It does use `date` +column type and maps it to the `Date` object. + +```typescript +@Property({ type: DateType, nullable: true }) +born?: Date; +``` + +### TimeType + +As opposed to the `DateType`, to store only the time information, we can use +`TimeType`. It will use the `time` column type, the runtime type is string. + +```typescript +@Property({ type: TimeType, nullable: true }) +bornTime?: string; +``` diff --git a/debugging.md b/debugging.md index a7aa00a..7ae0030 100644 --- a/debugging.md +++ b/debugging.md @@ -0,0 +1,80 @@ +--- +title: Logging +--- + +For development purposes it might come handy to enable logging and debug mode: + +```typescript +return MikroORM.init({ + debug: true, +}); +``` + +By doing this `MikroORM` will start using `console.log()` function to dump all queries: + +``` +[query] select `e0`. from `author` as `e0` where `e0`.`name` = ? limit ? [took 2 ms] +[query] begin [took 1 ms] +[query] insert into `author` (`name`, `email`, `created_at`, `updated_at`, `terms_accepted`) values (?, ?, ?, ?, ?) [took 2 ms] +[query] commit [took 2 ms] +``` + +It is also useful for debugging problems with entity discovery, as you will see information +about every processed entity: + +``` +[discovery] ORM entity discovery started +[discovery] - processing entity Author +[discovery] - using cached metadata for entity Author +[discovery] - processing entity Book +[discovery] - processing entity BookTag +[discovery] - entity discovery finished after 13 ms +``` + +## Custom Logger + +You can also provide your own logger via `logger` option. + +```typescript +return MikroORM.init({ + debug: true, + logger: msg => myCustomLogger.log(msg), +}); +``` + +## Logger Namespaces + +There are multiple Logger Namespaces that you can specifically request, while omitting the rest. +Just specify array of them via the `debug` option: + +```typescript +return MikroORM.init({ + debug: ['query'], // now only queries will be logged +}); +``` + +Currently, there are 4 namespaces – `query`, `query-params`, `discovery` and `info`. + +If you provide `query-params` then you must also provide `query` in order for it to take effect. + +## Highlighters + +Previously Highlight.js was used to highlight various things in the CLI, +like SQL and mongo queries, or migrations or entities generated via CLI. +While the library worked fine, it was causing performance issues mainly +for those bundling via webpack and using lambdas, as the library was huge. + +In v4 highlighting is disabled by default, and there are 2 highlighters +you can optionally use (you need to install them first). + +```typescript +import { SqlHighlighter } from '@mikro-orm/sql-highlighter'; + +MikroORM.init({ + highlighter: new SqlHighlighter(), + // ... +}); +``` + +For MongoDB you can use `MongoHighlighter` from `@mikro-orm/mongo-highlighter` +package. diff --git a/decorators.md b/decorators.md index c4b330f..c03f49e 100644 --- a/decorators.md +++ b/decorators.md @@ -0,0 +1,461 @@ +--- +title: Decorators +--- + +## Entity Definition + +### @Entity() + +`@Entity` decorator is used to mark your model classes as entities. Do not use it for +abstract base classes. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `tableName` \| `string` \| yes \| Override default collection/table name. \| +\| `collection` \| `string` \| yes \| Alias for `tableName`. \| +\| `comment` \| `string` \| yes \| Specify comment to table (SQL only) \| +\| `customRepository` \| `() => EntityRepository` \| yes \| Set custom repository class. \| + +> You can also use `@Repository()` decorator instead of `customRepository` parameter. + +```typescript +@Entity({ tableName: 'authors' }) +export class Author { ... } +``` + +## Entity Properties + +### @Property() + +`@Property()` decorator is used to define regular entity property. All following decorators +extend the `@Property()` decorator, so you can also use its parameters there. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `fieldName` \| `string` \| yes \| Override default property name (see [Naming Strategy](naming-strategy.md)). \| +\| `type` \| `string` \| `Type` \| yes \| Explicitly specify the runtime type (see [Metadata Providers](metadata-providers.md) and [Custom Types](custom-types.md)). \| +\| `onUpdate` \| `() => any` \| yes \| Automatically update the property value every time entity gets updated. \| +\| `persist` \| `boolean` \| yes \| Set to `false` to define [Shadow Property](serializing.md#shadow-properties). \| +\| `hidden` \| `boolean` \| yes \| Set to `true` to omit the property when [Serializing](serializing.md). \| +\| `columnType` \| `string` \| yes \| Specify exact database column type for [Schema Generator](schema-generator.md). (SQL only) \| +\| `length` \| `number` \| yes \| Length/precision of database column, used for `datetime/timestamp/varchar` column types for [Schema Generator](schema-generator.md). (SQL only) \| +\| `default` \| `any` \| yes \| Specify default column value for [Schema Generator](schema-generator.md). (SQL only) \| +\| `unique` \| `boolean` \| yes \| Set column as unique for [Schema Generator](schema-generator.md).. (SQL only) \| +\| `nullable` \| `boolean` \| yes \| Set column as nullable for [Schema Generator](schema-generator.md).. (SQL only) \| +\| `unsigned` \| `boolean` \| yes \| Set column as unsigned for [Schema Generator](schema-generator.md).. (SQL only) \| +\| `comment` \| `string` \| yes \| Specify comment of column for [Schema Generator](schema-generator.md).. (SQL only) \| +\| `version` \| `boolean` \| yes \| Set to true to enable [Optimistic Locking](transactions.md#optimistic-locking). (SQL only) \| + +> You can use property initializers as usual. + +```typescript +@Property({ length: 50, fieldName: 'first_name' }) +name!: string; + +@Property({ columnType: 'datetime', fieldName: 'born_date' }) +born?: Date; + +@Property({ columnType: 'tinyint' }) +age?: number; + +@Property({ onUpdate: () => new Date() }) +updatedAt = new Date(); + +@Property() +registered = false; +``` + +### @PrimaryKey() + +`@PrimaryKey()` decorator is used to define entity's unique primary key identifier. + +> `@PrimaryKey()` decorator extend the `@Property()` decorator, so you can use all +> its parameters. + +> Every entity needs to have at least one primary key (see composite primary keys). + +> Note that if only one PrimaryKey is set and it's type is number it will be set to auto incremented automatically in all SQL drivers. + +```typescript +@PrimaryKey() +id!: number; // auto increment PK in SQL drivers + +@PrimaryKey() +uuid = uuid.v4(); // uuid PK in SQL drivers + +@PrimaryKey() +_id!: ObjectId; // ObjectId PK in mongodb driver +``` + +### @SerializedPrimaryKey() + +> Property marked with `@SerializedPrimaryKey()` is virtual, it will not be persisted +> into the database. + +For MongoDB you can define serialized primary key, which will be then used in entity +serialization via `JSON.stringify()` (through method `entity.toJSON()`). +You will be able to use it to manipulate with the primary key as string. + +See [Usage with MongoDH](usage-with-mongo.md) and [Serializing](serializing.md). + +```typescript +@PrimaryKey() +_id: ObjectId; + +@SerializedPrimaryKey() +id!: string; +``` + +### @Enum() + +> `@Enum()` decorator extend the `@Property()` decorator, so you can use all its +> parameters. + +`@Enum()` decorator can be used for both numeric and string enums. By default enums are +considered numeric, and will be represented in the database schema as `tinyint/smallint`. +For string enums, if you define the enum in same file, its values will be automatically +sniffed. + +See [Defining Entities](defining-entities.md#enums). + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `items` \| `number[]` \| `string[]` \| `() => Dictionary` \| yes \| Specify enum items explicitly. \| + +```typescript +@Enum() // with ts-morph metadata provider we do not need to specify anything +enum0 = MyEnum1.VALUE_1; + +@Enum(() => MyEnum1) // or @Enum({ items: () => MyEnum1 }) +enum1 = MyEnum1.VALUE_1; + +@Enum({ type: 'MyEnum2', nullable: true }) +enum2?: MyEnum2; // MyEnum2 needs to be defined in current file (can be re-exported) + +@Enum({ items: [1, 2, 3] }) +enum3 = 3; + +@Enum({ items: ['a', 'b', 'c'] }) +enum4 = 'a'; +``` + +### @Formula() + +`@Formula()` decorator can be used to map some SQL snippet to your entity. +The SQL fragment can be as complex as you want and even include subselects. + +See [Defining Entities](defining-entities.md#formulas). + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `formula` \| `string` \| `() => string` \| no \| SQL fragment that will be part of the select clause. \| + +```typescript +@Formula('obj_length * obj_height * obj_width') +objectVolume?: number; +``` + +### @Index() and @Unique() + +Use `@Index()` to create an index, or `@Unique()` to create unique constraint. You can +use those decorators both on the entity level and on property level. To create compound +index, use the decorator on the entity level and provide list of property names via the +`properties` option. + +See [Defining Entities](defining-entities.md#indexes). + +\| Parameter \| Type \| Optional \| Description \| +\|--------------\|----------\|----------\|-------------\| +\| `name` \| `string` \| yes \| index name \| +\| `properties` \| `string` \| `string[]` \| yes \| list of properties, required when using on entity level \| +\| `type` \| `string` \| yes \| index type, not available for `@Unique()` \| + +```typescript +@Entity() +@Index({ properties: ['name', 'age'] }) // compound index, with generated name +@Index({ name: 'custom_idx_name', properties: ['name'] }) // simple index, with custom name +@Unique({ properties: ['name', 'email'] }) +export class Author { + + @Property() + @Unique() + email!: string; + + @Index() // generated name + @Property() + age?: number; + + @Index({ name: 'born_index' }) + @Property() + born?: Date; + +} +``` + +## Entity Relationships + +All relationship decorators have `entity`, `cascade` and `eager` optional parameters. +If you use the default `ReflectMetadataProvider`, then `entity` parameter might be required +You will be warned about it being not defined while required during discovery process if you +use `ReflectMetadataProvider`. + +You can also use `type` parameter instead of it - the difference being that `type` parameter +needs to be string, while in `entity` parameter you can provide a reference (wrapped in +a callback to overcome issues with circular dependencies) to the entity, which plays nice +with refactoring features in IDEs like WebStorm. + +> If you explicitly provide `entity` as a reference, it will enable type checks for other +> reference parameters like `inversedBy` or `mappedBy`. + +### @ManyToOne() + +> `@ManyToOne()` decorator extend the `@Property()` decorator, so you can use all +> its parameters. + +Many instances of the current Entity refer to One instance of the referred Entity. + +See [Defining Entities](relationships.md#manytoone) for more examples. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `entity` \| `string` \| `() => EntityName` \| yes \| Set target entity type. \| +\| `cascade` \| `Cascade[]` \| yes \| Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)). \| +\| `eager` \| `boolean` \| yes \| Always load the relationship. \| +\| `inversedBy` \| `(string & keyof T) ` \| ` (e: T) => any` \| yes \| Point to the inverse side property name. \| +\| `wrappedReference` \| `boolean` \| yes \| Wrap the entity in [`Reference` wrapper](entity-references.md). \| +\| `primary` \| `boolean` \| yes \| Use this relation as primary key. \| +\| `onDelete` \| `string` \| yes \| [Referential integrity](cascading.md#declarative-referential-integrity). \| +\| `onUpdateIntegrity` \| `string` \| yes \| [Referential integrity](cascading.md#declarative-referential-integrity). \| + +```typescript +@ManyToOne() +author1?: Author; // type taken via reflection (TsMorphMetadataProvider) + +@ManyToOne(() => Author) // explicit type +author2?: Author; + +@ManyToOne({ entity: () => Author, cascade: [Cascade.ALL] }) // options object +author3?: Author; +``` + +### @OneToOne() + +> `@OneToOne()` decorator extend the `@Property()` decorator, so you can use all +> its parameters. + +One instance of the current Entity refers to One instance of the referred Entity. + +See [Defining Entities](relationships.md#onetoone) for more examples, including bi-directional 1:1. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `entity` \| `string` \| `() => EntityName` \| yes \| Set target entity type. \| +\| `cascade` \| `Cascade[]` \| yes \| Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)). \| +\| `eager` \| `boolean` \| yes \| Always load the relationship. \| +\| `owner` \| `boolean` \| yes \| Explicitly set as owning side (same as providing `inversedBy`). \| +\| `inversedBy` \| `(string & keyof T) ` \| ` (e: T) => any` \| yes \| Point to the inverse side property name. \| +\| `mappedBy` \| `(string & keyof T)` \| `(e: T) => any` \| yes \| Point to the owning side property name. \| +\| `wrappedReference` \| `boolean` \| yes \| Wrap the entity in [`Reference` wrapper](entity-references.md). \| +\| `orphanRemoval` \| `boolean` \| yes \| Remove the entity when it gets disconnected from the relationship (see [Cascading](cascading.md#orphan-removal)). \| +\| `joinColumn` \| `string` \| yes \| Override default database column name on the owning side (see [Naming Strategy](naming-strategy.md)). \| +\| `primary` \| `boolean` \| yes \| Use this relation as primary key. \| +\| `onDelete` \| `string` \| yes \| [Referential integrity](cascading.md#declarative-referential-integrity). \| +\| `onUpdateIntegrity` \| `string` \| yes \| [Referential integrity](cascading.md#declarative-referential-integrity). \| + +```typescript +// when none of `owner/inverseBy/mappedBy` is provided, it will be considered owning side +@OneToOne() +bestFriend1!: User; + +// side with `inversedBy` is the owning one, to define inverse side use `mappedBy` +@OneToOne({ inversedBy: 'bestFriend1', orphanRemoval: true }) +bestFriend2!: User; + +// when defining it like this, you need to specifically mark the owning side with `owner: true` +@OneToOne(() => User, user => user.bestFriend2, { owner: true, orphanRemoval: true }) +bestFriend3!: User; +``` + +### @OneToMany() + +> `@OneToMany()` decorator extend the `@Property()` decorator, so you can use all +> its parameters. + +One instance of the current Entity has Many instances (references) to the referred Entity. + +See [Defining Entities](relationships.md#onetomany) for more examples, including bi-directional 1:m. + +> You need to initialize the value with `Collection<T>` instance. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `mappedBy` \| `(string & keyof T)` \| `(e: T) => any` \| no \| Point to the owning side property name. \| +\| `entity` \| `string` \| `() => EntityName` \| yes \| Set target entity type. \| +\| `cascade` \| `Cascade[]` \| yes \| Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)). \| +\| `eager` \| `boolean` \| yes \| Always load the relationship. \| +\| `orphanRemoval` \| `boolean` \| yes \| Remove the entity when it gets disconnected from the connection (see [Cascading](cascading.md#orphan-removal)). \| +\| `orderBy` \| `{ [field: string]: QueryOrder }` \| yes \| Set default ordering condition. \| +\| `joinColumn` \| `string` \| yes \| Override default database column name on the owning side (see [Naming Strategy](naming-strategy.md)). \| +\| `inverseJoinColumn` \| `string` \| yes \| Override default database column name on the inverse side (see [Naming Strategy](naming-strategy.md)). \| + +```typescript +@OneToMany(() => Book, book => book.author) +books1 = new Collection<Book>(this); + +@OneToMany({ mappedBy: 'author', cascade: [Cascade.ALL] }) +books2 = new Collection<Book>(this); // target entity type can be read via `TsMorphMetadataProvider` too +``` + +### @ManyToMany() + +> `@ManyToMany()` decorator extend the `@Property()` decorator, so you can use all +> its parameters. + +Many instances of the current Entity refers to Many instances of the referred Entity. + +See [Defining Entities](relationships.md#manytomany) for more examples, including bi-directional m:n. + +> You need to initialize the value with `Collection<T>` instance. + +\| Parameter \| Type \| Optional \| Description \| +\|-----------\|------\|----------\|-------------\| +\| `entity` \| `string` \| `() => EntityName` \| yes \| Set target entity type. \| +\| `cascade` \| `Cascade[]` \| yes \| Set what actions on owning entity should be cascaded to the relationship. Defaults to `[Cascade.PERSIST, Cascade.MERGE]` (see [Cascading](cascading.md)). \| +\| `eager` \| `boolean` \| yes \| Always load the relationship. \| +\| `owner` \| `boolean` \| yes \| Explicitly set as owning side (same as providing `inversedBy`). \| +\| `inversedBy` \| `(string & keyof T) ` \| ` (e: T) => any` \| yes \| Point to the inverse side property name. \| +\| `mappedBy` \| `(string & keyof T)` \| `(e: T) => any` \| yes \| Point to the owning side property name. \| +\| `orderBy` \| `{ [field: string]: QueryOrder }` \| yes \| Set default ordering condition. \| +\| `fixedOrder` \| `boolean` \| yes \| Force stable insertion order of items in the collection (see [Collections](collections.md#forcing-fixed-order-of-collection-items)). \| +\| `fixedOrderColumn` \| `string` \| yes \| Override default order column name (`id`). \| +\| `pivotTable` \| `string` \| yes \| Override default name for pivot table (see [Naming Strategy](naming-strategy.md)). \| +\| `joinColumn` \| `string` \| yes \| Override default database column name on the owning side (see [Naming Strategy](naming-strategy.md)). \| +\| `inverseJoinColumn` \| `string` \| yes \| Override default database column name on the inverse side (see [Naming Strategy](naming-strategy.md)). \| + +```typescript +@ManyToMany({ entity: () => BookTag, cascade: [], fixedOrderColumn: 'order' }) +tags = new Collection<BookTag>(this); // m:n with autoincrement PK + +@ManyToMany(() => BookTag, undefined, { pivotTable: 'book_to_tag_unordered', orderBy: { name: QueryOrder.ASC } }) +tagsUnordered = new Collection<BookTag>(this); // m:n with composite PK +``` + +## Lifecycle Hooks + +You can use lifecycle hooks to run some code when entity gets persisted. You can mark any of +entity methods with them, you can also mark multiple methods with same hook. + +> All hooks support async methods with one exception - `@OnInit`. + +### @OnInit() + +Fired when new instance of entity is created, either manually `em.create()`, or +automatically when new entities are loaded from database + +> `@OnInit` is not fired when you create the entity manually via its constructor (`new MyEntity()`) + +```typescript +@OnInit() +doStuffOnInit() { + this.fullName = `${this.firstName} - ${this.lastName}`; // initialize shadow property +} +``` + +### @BeforeCreate() + +Fired right before we persist the new entity into the database. + +```typescript +@BeforeCreate() +async doStuffBeforeCreate() { + // ... +} +``` + +### @AfterCreate() + +Fired right after the new entity is created in the database and merged to identity map. +Since this event entity will have reference to `EntityManager` and will be +enabled to call `wrap(entity).init()` method (including all entity references and collections). + +```typescript +@AfterCreate() +async doStuffAfterCreate() { + // ... +} +``` + +### @BeforeUpdate() + +Fired right before we update the entity in the database. + +```typescript +@BeforeUpdate() +async doStuffBeforeUpdate() { + // ... +} +``` + +### @AfterUpdate() + +Fired right after the entity is updated in the database. + +```typescript +@AfterUpdate() +async doStuffAfterUpdate() { + // ... +} +``` + +### @BeforeDelete() + +Fired right before we delete the record from database. It is fired only when +removing entity or entity reference, not when deleting records by query. + +```typescript +@BeforeDelete() +async doStuffBeforeDelete() { + // ... +} +``` + +### @AfterDelete() + +Fired right after the record gets deleted from database and it is unset from the identity map. + +```typescript +@AfterDelete() +async doStuffAfterDelete() { + // ... +} +``` + +## Entity Repository + +### @Repository() + +Used to register custom entity repository. + +> `em.getRepository()` will automatically return custom repository if it is registered. + +```typescript +@Repository(Author) +export class CustomAuthorRepository extends EntityRepository<Author> { + // your custom methods... +} +``` + +## Event Subscriber + +### @Subscriber() + +Used to register an event subscriber. Keep in mind that you need to make sure the file +gets loaded in order to make this decorator registration work (e.g. you import that file +explicitly somewhere). + +```typescript +@Subscriber() +export class AuthorSubscriber implements EventSubscriber<Author> { + // ... +} +``` diff --git a/defining-entities.md b/defining-entities.md index b0714da..91826e4 100644 --- a/defining-entities.md +++ b/defining-entities.md @@ -0,0 +1,1557 @@ +--- +title: Defining Entities +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Entities are simple javascript objects (so called POJO). No real restrictions are made, +no need to extend any base class, [using entity constructors](entity-constructors.md) +is working as well - they are never executed for managed entities (loaded from database). +Every entity is required to have a primary key. + +There are two ways how you can define your entities: + +- Decorated classes - the attributes of the entity as well as each property are provided + via decorators. We use `@Entity()` decorator on the class. Entity properties are decorated + either with `@Property` decorator, or with one of reference decorators: + `@ManyToOne`, `@OneToMany`, `@OneToOne` and `@ManyToMany`. + Check out the full [decorator reference](decorators.md). +- `EntitySchema` helper - With `EntitySchema` helper we define the schema programmatically. + We can use regular classes as well as interfaces. This approach also allows to re-use + partial entity definitions (e.g. traits/mixins). Read more about this + in [Defining Entities via EntitySchema section](entity-schema.md). + +Moreover, how the metadata extraction from decorators happens is controlled +via `MetadataProvider`. Two main metadata providers are: + +- `ReflectMetadataProvider` - uses `reflect-metadata` to read the property types. Faster + but simpler and more verbose. +- `TsMorphMetadataProvider` - uses `ts-morph` to read the type information from the + TypeScript compiled API. Heavier (requires full TS as a dependency), but allows DRY + entity definition. With `ts-morph` we are able to extract the type as it is defined in + the code, including interface names, as well as optionality of properties. + +Read more about them in the [Metadata Providers section](metadata-providers.md). + +> Current set of decorators in MikroORM is designed to work with the `tsc`. +> Using `babel` is also possible, but requires some additional setup. Read more about it +> [here](usage-with-babel.md). For notes about `webpack`, read the [deployment section](deployment.md). +> +> `ts-morph` is compatible only with the `tsc` approach. + +> From v3 you can also use default exports when defining your entity. + +Example definition of a `Book` entity follows. We can switch the tabs to see the difference +for various ways: + +<Tabs + groupId="entity-def" + defaultValue="reflect-metadata" + values={[ + {label: 'reflect-metadata', value: 'reflect-metadata'}, + {label: 'ts-morph', value: 'ts-morph'}, + {label: 'EntitySchema', value: 'entity-schema'}, + ] + }> + <TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book extends BaseEntity { + + @Property() + title!: string; + + @ManyToOne(() => Author) + author!: Author; + + @ManyToOne(() => Publisher, { wrappedReference: true, nullable: true }) + publisher?: IdentifiedReference<Publisher>; + + @ManyToMany({ entity: 'BookTag', fixedOrder: true }) + tags = new Collection<BookTag>(this); + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book extends BaseEntity { + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + + @ManyToOne() + publisher?: IdentifiedReference<Publisher>; + + @ManyToMany({ fixedOrder: true }) + tags = new Collection<BookTag>(this); + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface IBook extends BaseEntity { + title: string; + author: Author; + publisher?: IdentifiedReference<Publisher>; + tags: Collection<BookTag>; +} + +export const Book = new EntitySchema<IBook, BaseEntity>({ + name: 'Book', + extends: 'BaseEntity', + properties: { + title: { type: 'string' }, + author: { reference: 'm:1', entity: 'Author' }, + publisher: { reference: 'm:1', entity: 'Publisher', wrappedReference: true, nullable: true }, + tags: { reference: 'm:n', entity: 'BookTag', fixedOrder: true }, + }, +}); +``` + + </TabItem> +</Tabs> + +Here is another example of `Author` entity, that was referenced from the `Book` one, this +time defined for mongo: + +<Tabs + groupId="entity-def" + defaultValue="reflect-metadata" + values={[ + {label: 'reflect-metadata', value: 'reflect-metadata'}, + {label: 'ts-morph', value: 'ts-morph'}, + {label: 'EntitySchema', value: 'entity-schema'}, + ] + }> + <TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +@Entity() +export class Author { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; + + @Property() + createdAt: Date = new Date(); + + @Property({ onUpdate: () => new Date() }) + updatedAt: Date = new Date(); + + @Property() + name!: string; + + @Property() + email!: string; + + @Property({ nullable: true }) + age?: number; + + @Property() + termsAccepted: boolean = false; + + @Property({ nullable: true }) + identities?: string[]; + + @Property({ nullable: true }) + born?: Date; + + @OneToMany(() => Book, book => book.author) + books = new Collection<Book>(this); + + @ManyToMany(() => Author) + friends = new Collection<Author>(this); + + @ManyToOne(() => Book, { nullable: true }) + favouriteBook?: Book; + + @Property({ version: true }) + version!: number; + + constructor(name: string, email: string) { + this.name = name; + this.email = email; + } + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +@Entity() +export class Author { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; + + @Property() + createdAt = new Date(); + + @Property({ onUpdate: () => new Date() }) + updatedAt = new Date(); + + @Property() + name!: string; + + @Property() + email!: string; + + @Property() + age?: number; + + @Property() + termsAccepted = false; + + @Property() + identities?: string[]; + + @Property() + born?: Date; + + @OneToMany(() => Book, book => book.author) + books = new Collection<Book>(this); + + @ManyToMany() + friends = new Collection<Author>(this); + + @ManyToOne() + favouriteBook?: Book; + + @Property({ version: true }) + version!: number; + + constructor(name: string, email: string) { + this.name = name; + this.email = email; + } + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +export class Author { + + _id!: ObjectId; + id!: string; + createdAt = new Date(); + updatedAt = new Date(); + name!: string; + email!: string; + age?: number; + termsAccepted = false; + identities?: string[]; + born?: Date; + books = new Collection<Book>(this); + friends = new Collection<Author>(this); + favouriteBook?: Book; + version!: number; + + constructor(name: string, email: string) { + this.name = name; + this.email = email; + } + +} + +export const AuthorSchema = new EntitySchema<Author>({ + class: Author, + properties: { + _id: { type: 'ObjectId', primary: true }, + id: { type: String, serializedPrimaryKey: true }, + createdAt: { type: Date }, + updatedAt: { type: Date, onUpdate: () => new Date() }), + name: { type: String }, + email: { type: String }, + age: { type: Number, nullable: true }, + termsAccepted: { type: Boolean } + identities: { type: 'string[]', nullable: true } + born: { type: Date, nullable: true } + books: { reference: '1:m', entity: () => Book, mappedBy: book => book.author } + friends: { reference: 'm:n', entity: () => Author } + favouriteBook: { reference: 'm:1', entity: () => Book, nullable: true }; + version: { type: Number, version: true }; + }, +}); +``` + + </TabItem> +</Tabs> + +More information about modelling relationships can be found on [modelling relationships page](relationships.md). + +For an example of Vanilla JavaScript usage, take a look [here](usage-with-js.md). + +## Optional Properties + +With the default `reflect-metadata` provider, we need to mark each optional property as `nullable: true`. +When using `ts-morph`, if you define the property as optional (marked with `?`), this will be automatically considered +as nullable property (mainly for SQL schema generator). + +<Tabs + groupId="entity-def" + defaultValue="reflect-metadata" + values={[ + {label: 'reflect-metadata', value: 'reflect-metadata'}, + {label: 'ts-morph', value: 'ts-morph'}, + {label: 'EntitySchema', value: 'entity-schema'}, + ] + }> + <TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +@ManyToOne(() => Book, { nullable: true }) +favouriteBook?: Book; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +@ManyToOne() +favouriteBook?: Book; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +properties: { + favouriteBook: { reference: 'm:1', entity: () => Book, nullable: true }, +}, +``` + + </TabItem> +</Tabs> + +## Default values + +We can set default value of a property in 2 ways: + +1. Use runtime default value of the property. This approach should be preferred as long +as we are not using any native database function like `now()`. With this approach our +entities will have the default value set even before it is actually persisted into the +database (e.g. when we instantiate new entity via `new Author()` or `em.create(Author, { ... })`. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +@Property() +foo: number = 1; + +@Property() +bar: string = 'abc'; + +@Property() +baz: Date = new Date(); +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +@Property() +foo = 1; + +@Property() +bar = 'abc'; + +@Property() +baz = new Date(); +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +properties: { + foo: { type: Number, onCreate: () => 1 }, + bar: { type: String, onCreate: () => 'abc' }, + baz: { type: Date, onCreate: () => new Date() }, +}, +``` + + </TabItem> +</Tabs> + +2. Use `default` parameter of `@Property` decorator. This way the actual default value +will be provided by the database, and automatically mapped to the entity property after +it is being persisted (after flush). To use SQL functions like `now()`, use `defaultRaw`. + + > Since v4 you should use `defaultRaw` for SQL functions, as `default` with string values + > will be automatically quoted. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +@Property({ default: 1 }) +foo!: number; + +@Property({ default: 'abc' }) +bar!: string; + +@Property({ defaultRaw: 'now' }) +baz!: Date; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +@Property({ default: 1 }) +foo!: number; + +@Property({ default: 'abc' }) +bar!: string; + +@Property({ defaultRaw: 'now' }) +baz!: Date; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +properties: { + foo: { type: Number, default: 1 }, + bar: { type: String, default: 'abc' }, + baz: { type: Date, defaultRaw: 'now' }, +}, +``` + + </TabItem> +</Tabs> + +## Enums + +To define enum property, use `@Enum()` decorator. Enums can be either numeric or string valued. + +For schema generator to work properly in case of string enums, we need to define the enum +is same file as where it is used, so its values can be automatically discovered. If we want +to define the enum in another file, we should reexport it also in place where we use it. + +Another possibility is to provide the reference to the enum implementation in the decorator +via `@Enum(() => UserRole)`. + +> You can also set enum items manually via `items: string[]` attribute. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +import { OutsideEnum } from './OutsideEnum.ts'; + +@Entity() +export class User { + + @Enum(() => UserRole) + role!: UserRole; // string enum + + @Enum() + status!: UserStatus; // numeric/const enum + + @Enum(() => OutsideEnum) + outside!: OutsideEnum; // string enum defined outside of this file + + @Enum({ items: () => OutsideNullableEnum, nullable: true }) + outsideNullable?: OutsideNullableEnum; // string enum defined outside of this file, may be null + +} + +export enum UserRole { + ADMIN = 'admin', + MODERATOR = 'moderator', + USER = 'user', +} + +export const enum UserStatus { + DISABLED, + ACTIVE, +} + +// or we could reexport OutsideEnum +// export { OutsideEnum } from './OutsideEnum.ts'; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +import { OutsideEnum } from './OutsideEnum.ts'; + +@Entity() +export class User { + + @Enum() + role!: UserRole; // string enum + + @Enum() + status!: UserStatus; // numeric enum + + @Enum(() => OutsideEnum) + outside!: OutsideEnum; // string enum defined outside of this file + + @Enum({ items: () => OutsideNullableEnum }) + outsideNullable?: OutsideNullableEnum; // string enum defined outside of this file, may be null + +} + +export enum UserRole { + ADMIN = 'admin', + MODERATOR = 'moderator', + USER = 'user', +} + +export const enum UserStatus { + DISABLED, + ACTIVE, +} + +// or we could reexport OutsideEnum +// export { OutsideEnum } from './OutsideEnum.ts'; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +properties: { + // string enum + role: { enum: true, items: () => UserRole }, + // numeric enum + status: { enum: true, items: () => UserStatus }, + // string enum defined outside of this file + outside: { enum: true, items: () => OutsideEnum }, + // string enum defined outside of this file, may be null + outsideNullable: { enum: true, items: () => OutsideNullableEnum, nullable: true }, +}, +``` + + </TabItem> +</Tabs> + +## Enum arrays + +We can also use array of values for enum, in that case, `EnumArrayType` type +will be used automatically, that will validate items on flush. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/User.ts" +enum Role { + User = 'user', + Admin = 'admin', +} + +@Enum({ items: () => Role, array: true, default: [Role.User] }) +roles: Role[] = [Role.User]; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/User.ts" +enum Role { + User = 'user', + Admin = 'admin', +} + +@Enum({ default: [Role.User] }) +roles = [Role.User]; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/User.ts" +enum Role { + User = 'user', + Admin = 'admin', +} + +properties: { + roles: { enum: true, array: true, default: [Role.User], items: () => Role }, +}, +``` + + </TabItem> +</Tabs> + +## Mapping directly to primary keys + +Sometimes we might want to work only with the primary key of a relation. +To do that, we can use `mapToPk` option on M:1 and 1:1 relations: + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/User.ts" +@ManyToOne(() => User, { mapToPk: true }) +user: number; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/User.ts" +@ManyToOne(() => User, { mapToPk: true }) +user: number; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/User.ts" +properties: { + user: { entity: () => User, mapToPk: true }, +}, +``` + + </TabItem> +</Tabs> + +For composite keys, this will give us ordered tuple representing the raw PKs, +which is the internal format of composite PK: + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/User.ts" +@ManyToOne(() => User, { mapToPk: true }) +user: [string, string]; // [first_name, last_name] +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/User.ts" +@ManyToOne(() => User, { mapToPk: true }) +user: [string, string]; // [first_name, last_name] +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/User.ts" +properties: { + user: { entity: () => User, mapToPk: true }, +}, +``` + + </TabItem> +</Tabs> +``` + +## Formulas + +`@Formula()` decorator can be used to map some SQL snippet to your entity. +The SQL fragment can be as complex as you want and even include subselects. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Box.ts" +@Formula('obj_length * obj_height * obj_width') +objectVolume?: number; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Box.ts" +@Formula('obj_length * obj_height * obj_width') +objectVolume?: number; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Box.ts" +properties: { + objectVolume: { formula: 'obj_length * obj_height * obj_width' }, +}, +``` + + </TabItem> +</Tabs> +``` + +Formulas will be added to the select clause automatically. In case you are facing +problems with `NonUniqueFieldNameException`, you can define the formula as a +callback that will receive the entity alias in the parameter: + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Box.ts" +@Formula(alias => `${alias}.obj_length * ${alias}.obj_height * ${alias}.obj_width`) +objectVolume?: number; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Box.ts" +@Formula(alias => `${alias}.obj_length * ${alias}.obj_height * ${alias}.obj_width`) +objectVolume?: number; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Box.ts" +properties: { + objectVolume: { formula: alias => `${alias}.obj_length * ${alias}.obj_height * ${alias}.obj_width` }, +}, +``` + + </TabItem> +</Tabs> + +## Indexes + +You can define indexes via `@Index()` decorator, for unique indexes, use `@Unique()` decorator. +You can use it either on entity class, or on entity property: + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Author.ts" +@Entity() +@Index({ properties: ['name', 'age'] }) // compound index, with generated name +@Index({ name: 'custom_idx_name', properties: ['name'] }) // simple index, with custom name +@Unique({ properties: ['name', 'email'] }) +export class Author { + + @Property() + @Unique() + email!: string; + + @Property() + @Index() // generated name + age?: number; + + @Index({ name: 'born_index' }) + @Property() + born?: Date; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Author.ts" +@Entity() +@Index({ properties: ['name', 'age'] }) // compound index, with generated name +@Index({ name: 'custom_idx_name', properties: ['name'] }) // simple index, with custom name +@Unique({ properties: ['name', 'email'] }) +export class Author { + + @Property() + @Unique() + email!: string; + + @Property() + @Index() // generated name + age?: number; + + @Index({ name: 'born_index' }) + @Property() + born?: Date; + +} + +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Author.ts" +export const AuthorSchema = new EntitySchema<Author, BaseEntity>({ + class: Author, + indexes: [ + { properties: ['name', 'age'] }, // compound index, with generated name + { name: 'custom_idx_name', properties: ['name'] }, // simple index, with custom name + ], + uniques: [ + { properties: ['name', 'email'] }, + ], + properties: { + email: { type: 'string', unique: true }, // generated name + age: { type: 'number', nullable: true, index: true }, // generated name + born: { type: Date, nullable: true, index: 'born_index' }, + }, +}); +``` + + </TabItem> +</Tabs> + +## Custom Types + +You can define custom types by extending `Type` abstract class. It has 4 optional methods: + +- `convertToDatabaseValue(value: any, platform: Platform): any` + + Converts a value from its JS representation to its database representation of this type. + +- `convertToJSValue(value: any, platform: Platform): any` + + Converts a value from its database representation to its JS representation of this type. + +- `toJSON(value: any, platform: Platform): any` + + Converts a value from its JS representation to its serialized JSON form of this type. + By default converts to the database value. + +- `getColumnType(prop: EntityProperty, platform: Platform): string` + + Gets the SQL declaration snippet for a field of this type. + +More information can be found in [Custom Types](custom-types.md) section. + +## Lazy scalar properties + +You can mark any property as `lazy: true` to omit it from the select clause. +This can be handy for properties that are too large and you want to have them +available only some times, like a full text of an article. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Property({ columnType: 'text', lazy: true }) +text: string; +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Property({ columnType: 'text', lazy: true }) +text: string; +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +properties: { + text: { columnType: 'text', lazy: true }, +} +``` + + </TabItem> +</Tabs> + +You can use `populate` parameter to load them. + +```ts +const b1 = await em.find(Book, 1); // this will omit the `text` property +const b2 = await em.find(Book, 1, { populate: ['text'] }); // this will load the `text` property +``` + +> If the entity is already loaded and you need to populate a lazy scalar property, +> you might need to pass `refresh: true` in the `FindOptions`. + +## Virtual Properties + +You can define your properties as virtual, either as a method, or via JavaScript `get/set`. + +Following example defines User entity with `firstName` and `lastName` database fields, that +are both hidden from the serialized response, replaced with virtual properties `fullName` +(defined as a classic method) and `fullName2` (defined as a JavaScript getter). + +> For JavaScript getter you need to provide `{ persist: false }` option otherwise the value +> would be stored in the database. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/User.ts" +@Entity() +export class User { + + @Property({ hidden: true }) + firstName!: string; + + @Property({ hidden: true }) + lastName!: string; + + @Property({ name: 'fullName' }) + getFullName() { + return `${this.firstName} ${this.lastName}`; + } + + @Property({ persist: false }) + get fullName2() { + return `${this.firstName} ${this.lastName}`; + } + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/User.ts" +@Entity() +export class User { + + @Property({ hidden: true }) + firstName!: string; + + @Property({ hidden: true }) + lastName!: string; + + @Property({ name: 'fullName' }) + getFullName() { + return `${this.firstName} ${this.lastName}`; + } + + @Property({ persist: false }) + get fullName2() { + return `${this.firstName} ${this.lastName}`; + } + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/User.ts" +export class User { + firstName!: string; + lastName!: string; + + getFullName() { + return `${this.firstName} ${this.lastName}`; + } + + get fullName2() { + return `${this.firstName} ${this.lastName}`; + } +} + +properties: { + firstName: { type: String, hidden: true }, + lastName: { type: String, hidden: true }, + fullName: { type: 'method', persist: false, getter: true, getterName: 'getFullName' }, + fullName2: { type: 'method', persist: false, getter: true }, +} +``` + + </TabItem> +</Tabs> + +```ts +const repo = em.getRepository(User); +const author = repo.create({ firstName: 'Jon', lastName: 'Snow' }); + +console.log(author.getFullName()); // 'Jon Snow' +console.log(author.fullName2); // 'Jon Snow' +console.log(wrap(author).toJSON()); // { fullName: 'Jon Snow', fullName2: 'Jon Snow' } +``` + +## Entity file names + +Starting with MikroORM 4.2, there is no limitation for entity file names. It is now +also possible to define multiple entities in a single file using folder based discovery. + +## Using BaseEntity + +You can define your own base entity with properties that you require on all entities, like +primary key and created/updated time. Single table inheritance is also supported. + +Read more about this topic in [Inheritance Mapping](inheritance-mapping.md) section. + +> If you are initializing the ORM via `entities` option, you need to specify all your +> base entities as well. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/BaseEntity.ts" +import { v4 } from 'uuid'; + +export abstract class BaseEntity { + + @PrimaryKey() + uuid: string = v4(); + + @Property() + createdAt: Date = new Date(); + + @Property({ onUpdate: () => new Date() }) + updatedAt: Date = new Date(); + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/BaseEntity.ts" +import { v4 } from 'uuid'; + +export abstract class BaseEntity { + + @PrimaryKey() + uuid = v4(); + + @Property() + createdAt = new Date(); + + @Property({ onUpdate: () => new Date() }) + updatedAt = new Date(); + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/BaseEntity.ts" +export interface BaseEntity { + uuid: string; + createdAt: Date; + updatedAt: Date; +} + +export const schema = new EntitySchema<BaseEntity>({ + name: 'BaseEntity', + abstract: true, + properties: { + id: { type: 'number', primary: true }, + createdAt: { type: 'Date', onCreate: () => new Date(), nullable: true }, + updatedAt: { type: 'Date', onCreate: () => new Date(), onUpdate: () => new Date(), nullable: true }, + }, +}); +``` + + </TabItem> +</Tabs> + +There is a special case, when we need to annotate the base entity - if we are using +folder based discovery, and the base entity is not using any decorators (e.g. it does +not define any decorated property). In that case, we need to mark it as abstract: + +```ts +@Entity({ abstract: true }) +export abstract class BaseEntity { + // ... +} +``` + +## Examples of entity definition with various primary keys + +### Using id as primary key (SQL drivers) + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + id!: number; // string is also supported + + @Property() + title!: string; + + @ManyToOne(() => Author) + author!: Author; + + @ManyToOne(() => Publisher, { wrappedReference: true, nullable: true }) + publisher?: IdentifiedReference<Publisher>; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + id!: number; // string is also supported + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + + @ManyToOne() + publisher?: IdentifiedReference<Publisher>; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface Book { + id: number; + title: string; + author: Author; +} + +export const BookSchema = new EntitySchema<Book>({ + name: 'Book', + properties: { + id: { type: Number, primary: true }, + title: { type: String }, + author: { reference: 'm:1', entity: 'Author' }, + publisher: { reference: 'm:1', entity: 'Publisher', wrappedReference: true, nullable: true }, + }, +}); +``` + + </TabItem> +</Tabs> + +### Using UUID as primary key (SQL drivers) + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +import { v4 } from 'uuid'; + +@Entity() +export class Book { + + @PrimaryKey() + uuid: string = v4(); + + @Property() + title!: string; + + @ManyToOne(() => Author) + author!: Author; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +import { v4 } from 'uuid'; + +@Entity() +export class Book { + + @PrimaryKey() + uuid = v4(); + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface IBook { + uuid: string; + title: string; + author: Author; +} + +export const Book = new EntitySchema<IBook>({ + name: 'Book', + properties: { + uuid: { type: 'uuid', onCreate: () => v4(), primary: true }, + title: { type: 'string' }, + author: { entity: () => Author, reference: 'm:1' }, + }, +}); +``` + + </TabItem> +</Tabs> + +### Using PostgreSQL [uuid-osp](https://www.postgresql.org/docs/current/uuid-ossp.html) module function as primary key + +Requires enabling the module via: `create extension "uuid-ossp";` + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey({ type: 'uuid', defaultRaw: 'uuid_generate_v4()' }) + uuid: string; + + @Property() + title!: string; + + @ManyToOne(() => Author) + author!: Author; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey({ type: 'uuid', defaultRaw: 'uuid_generate_v4()' }) + uuid: string; + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export class Book { + uuid: string; + title!: string; + author!: Author; +} + +export const BookSchema = new EntitySchema<Book>({ + class: Book, + properties: { + uuid: { type: 'uuid', defaultRaw: 'uuid_generate_v4()', primary: true }, + title: { type: 'string' }, + author: { entity: () => Author, reference: 'm:1' }, + }, +}); +``` + + </TabItem> +</Tabs> + +### Using BigInt as primary key (MySQL and PostgreSQL) + +You can use `BigIntType` to support `bigint`s. By default, it will represent the value as +a `string`. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/BaseEntity.ts" +@Entity() +export class Book { + + @PrimaryKey({ type: BigIntType }) + id: string; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/BaseEntity.ts" +@Entity() +export class Book { + + @PrimaryKey({ type: BigIntType }) + id: string; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/BaseEntity.ts" +properties: { + id: { type: BigIntType }, +}, +``` + + </TabItem> +</Tabs> + +If you want to use native `bigint`s, read the following guide: [Using native BigInt PKs](using-bigint-pks.md). + +### Example of Mongo entity + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; // string variant of PK, will be handled automatically + + @Property() + title!: string; + + @ManyToOne(() => Author) + author!: Author; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; // string variant of PK, will be handled automatically + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface IBook { + _id: ObjectId; + id: string; + title: string; + author: Author; +} + +export const Book = new EntitySchema<IBook>({ + name: 'Book', + properties: { + _id: { type: 'ObjectId', primary: true }, + id: { type: String, serializedPrimaryKey: true }, + title: { type: String }, + }, +}); +``` + + </TabItem> +</Tabs> + +### Using MikroORM's BaseEntity (previously WrappedEntity) + +From v4 `BaseEntity` class is provided with `init`, `isInitialized`, `assign` +and other methods that are otherwise available via the `wrap()` helper. + +> Usage of the `BaseEntity` is optional. + +```ts +import { BaseEntity } from '@mikro-orm/core'; + +@Entity() +export class Book extends BaseEntity<Book, 'id'> { + + @PrimaryKey() + id!: number; + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + +} + +const book = new Book(); +console.log(book.isInitialized()); // true +``` + +With your entities set up, you can start [using entity manager](entity-manager.md) and +[repositories](repositories.md) as described in following sections. diff --git a/deployment.md b/deployment.md index 0f68028..88ae971 100644 --- a/deployment.md +++ b/deployment.md @@ -0,0 +1,278 @@ +--- +title: Deployment +--- + +Under the hood, `MikroORM` uses [`ts-morph`](https://github.com/dsherret/ts-morph) to read +TypeScript source files of all entities to be able to detect all types. Thanks to this, +defining the type is enough for runtime validation. + +This has some consequences for deployment of your application. Sometimes you will want to +deploy only your compiled output, without TS source files at all. In that case, discovery +process will probably fail. You have several options: + +## Deploy pre-built cache + +By default, output of metadata discovery will be cached in `temp` folder. You can reuse this +cache in your deployed application. Currently the cache is saved in files named like the entity +source file, e.g. `Author.ts` entity will store cache in `temp/Author.ts.json` file. + +When running compiled code, JS entities will be taken into account instead, so you will need to +generate the cache by running the compiled code locally. That will generate `temp/Author.js.json`, +which is the file you will need to deploy alongside your application. + +## Fill type or entity attributes everywhere + +What discovery process does is to sniff TS types and save their value to string, so it can be +used later for validation. You can skip the whole process by simply providing those values +manually: + +```typescript +@Entity() +export class Book { + + @PrimaryKey({ type: 'number' }) + id!: number; + + @Property({ type: 'string' }) + title!: string; + + @Enum(() => BookStatus) + status?: BookStatus; + + @ManyToOne(() => Author) // or `@ManyToOne({ type: 'Author' })` or `@ManyToOne({ entity: () => Author })` + author1!: Author; + + // or + @ManyToOne({ type: 'Author' }) + author2!: Author; + + // or + @ManyToOne({ entity: () => Author }) + author3!: Author; + +} + +export enum BookStatus { + SOLD_OUT = 'sold', + ACTIVE = 'active', + UPCOMING = 'upcoming', + } +``` + +> For numeric enums this is not be required. + +## Deploy your entity source files + +Usually it does not matter much that you deploy more files than needed, so the easiest way +is to just deploy your TS source files next to the compiled output, just like during development. + +## Deploy a bundle of entities and dependencies with [Webpack](https://webpack.js.org/) + +Webpack can be used to bundle every entity and dependency: you get a single file that contains +every required module/file and has no external dependencies. + +### Prepare your project for Webpack + +Webpack requires every required file to be hardcoded in your code. Code like this won't work +(it will throw an error because Webpack doesn't know which file to include in the bundle): + +```typescript +let dependencyNameInVariable = 'dependency'; +const dependency = import(dependencyNameInVariable); +``` + +As Webpack creates a file bundle, it isn't desired that it scans directories for entities +or metadata. Therefore you need to provide list of entities in the `entities` option in +the initialization function, folder/file based discovery is not supported (see dynamically +including entities as an alternative solution). Also you need to fill `type` or `entity` +attributes everywhere (see above) and disable caching (it will decrease start-time slightly). + +> In v4 caching is disabled by default when using `ReflectMetadataProvider`. + +#### Disabling dynamic file access + +First thing you should do is to disable dynamic file access in the discovery process via the +`discovery.disableDynamicFileAccess` toggle. This will effectively do: + +- set metadata provider to `ReflectMetadataProvider` +- disable caching +- disallow usage of paths in `entities/entitiesTs` + +#### Manually defining entities + +```typescript +import { Author, Book, BookTag, Publisher, Test } from '../entities'; + +await MikroORM.init({ + ... + entities: [Author, Book, BookTag, Publisher, Test], + discovery: { disableDynamicFileAccess: true }, + ... +}); +``` + +#### Dynamically loading dependencies + +This will make use of a Webpack feature called [dynamic imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports). +This way you can import dependencies as long as part of the path is known. + +In following example [`require.context`](https://webpack.js.org/guides/dependency-management/#requirecontext) +is used. This 'function' is only usable during the building process from Webpack so therefore +there is an alternative solution provided that will as long as the environment variable +WEBPACK is not set (e.g. during development with `ts-node`). + +Here, all files with the extension `.ts` will be imported from the directory `../entities`. + +> [`flatMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap) is a method from ECMAScript 2019 and requires [Node.js](https://nodejs.org/) 11 or higher. + +```typescript +await MikroORM.init({ + // ... + entities: await getEntities(), + discovery: { disableDynamicFileAccess: true }, + // ... +}); + +async function getEntities(): Promise<any[]> { + if (process.env.WEBPACK) { + const modules = require.context('../entities', true, /\\.ts$/); + + return modules + .keys() + .map(r => modules(r)) + .flatMap(mod => Object.keys(mod).map(className => mod[className])); + } + + const promises = fs.readdirSync('../entities').map(file => import(`../entities/${file}`)); + const modules = await Promise.all(promises); + + return modules.flatMap(mod => Object.keys(mod).map(className => mod[className])); +} +``` + +### Webpack configuration + +Webpack can be run without [configuration file](https://webpack.js.org/configuration/) but +for building MikroORM and [Node.js](https://nodejs.org/) bundles it requires additional +configuration. Configuration for Webpack is stored in the root of the project as +`webpack.config.js`. For all the options please refer to the following [page](https://webpack.js.org/configuration/). + +For bundling MikroORM the following configuration is required: + +```javascript +const path = require('path'); +const { EnvironmentPlugin, IgnorePlugin } = require('webpack'); +const TerserPlugin = require('terser-webpack-plugin'); + +// Mark our dev dependencies as externals so they don't get included in the webpack bundle. +const { devDependencies } = require('./package.json'); +const externals = {}; + +for (const devDependency of Object.keys(devDependencies)) { + externals[devDependency] = `commonjs ${devDependency}`; +} + +// And anything MikroORM's packaging can be ignored if it's not on disk. +// Later we check these dynamically and tell webpack to ignore the ones we don't have. +const optionalModules = new Set([ + ...Object.keys(require('knex/package.json').browser), + ...Object.keys(require('@mikro-orm/core/package.json').peerDependencies), + ...Object.keys(require('@mikro-orm/core/package.json').devDependencies \|\| {}) +]); + +module.exports = { + entry: path.resolve('app', 'server.ts'), + + // You can toggle development mode on to better see what's going on in the webpack bundle, + // but for anything that is getting deployed, you should use 'production'. + // mode: 'development', + mode: 'production', + + optimization: { + minimizer: [ + new TerserPlugin({ + terserOptions: { + // We want to minify the bundle, but don't want Terser to change the names of our entity + // classes. This can be controlled in a more granular way if needed, (see + // https://terser.org/docs/api-reference.html#mangle-options) but the safest default + // config is that we simply disable mangling altogether but allow minification to proceed. + mangle: false, + // Similarly, Terser's compression may at its own discretion change function and class names. + // While it only rarely does so, it's safest to also disable changing their names here. + // This can be controlled in a more granular way if needed (see + // https://terser.org/docs/api-reference.html#compress-options). + compress: { + keep_classnames: true, + keep_fnames: true, + }, + } + }) + ] + }, + target: 'node', + module: { + rules: [ + // Bring in our typescript files. + { + test: /\\.ts$/, + exclude: /node_modules/, + loader: 'ts-loader', + }, + + // Native modules can be bundled as well. + { + test: /\\.node$/, + use: 'node-loader', + }, + + // Some of MikroORM's dependencies use mjs files, so let's set them up here. + { + test: /\\.mjs$/, + include: /node_modules/, + type: 'javascript/auto', + }, + ], + }, + + // These are computed above. + externals, + + resolve: { + extensions: ['.ts', '.js'] + }, + + plugins: [ + // Ignore any of our optional modules if they aren't installed. This ignores database drivers + // that we aren't using for example. + new EnvironmentPlugin({ WEBPACK: true }), + new IgnorePlugin({ + checkResource: resource => { + const baseResource = resource.split('/', resource[0] === '@' ? 2 : 1).join('/'); + + if (optionalModules.has(baseResource)) { + try { + require.resolve(resource); + return false; + } catch { + return true; + } + } + + return false; + }, + }), + ], + + output: { + filename: 'server.js', + libraryTarget: 'commonjs', + path: path.resolve(__dirname, '..', 'output'), + }, +}; +``` + +### Running Webpack + +To run Webpack execute `webpack` (or `npx webpack` if not installed globally) in the root +of the project. It will probably throw a few warnings but you can ignore the errors regarding +MikroORM: the mentioned pieces of code won't be executed if properly bundled with Webpack. diff --git a/embeddables.md b/embeddables.md index 5fd335b..7e278b1 100644 --- a/embeddables.md +++ b/embeddables.md @@ -0,0 +1,180 @@ +--- +title: Separating Concerns using Embeddables +sidebar_label: Embeddables +--- + +> Support for embeddables was added in version 4.0 + +Embeddables are classes which are not entities themselves, but are embedded in +entities and can also be queried. You'll mostly want to use them to reduce +duplication or separating concerns. Value objects such as date range or address +are the primary use case for this feature. + +> Embeddables needs to be discovered just like regular entities, don't forget to +> add them to the list of entities when initializing the ORM. + +Embeddables can only contain properties with basic `@Property()` mapping. + +For the purposes of this tutorial, we will assume that you have a `User` class in +your application and you would like to store an address in the `User` class. We will +model the `Address` class as an embeddable instead of simply adding the respective +columns to the `User` class. + +```typescript +@Entity() +export class User { + + @Embedded() + address!: Address; + +} + +@Embeddable() +export class Address { + + @Property() + street!: string; + + @Property() + postalCode!: string; + + @Property() + city!: string; + + @Property() + country!: string; + +} +``` + +> When using ReflectMetadataProvider, you might need to provide the class in decorator options: +> `@Embedded(() => Address)` or `@Embedded({ entity: () => Address })`. + +In terms of your database schema, MikroORM will automatically inline all columns from +the `Address` class into the table of the `User` class, just as if you had declared +them directly there. + +## Initializing embeddables + +In case all fields in the embeddable are nullable, you might want to initialize the +embeddable, to avoid getting a null value instead of the embedded object. + +```typescript +@Embedded() +address = new Address(); +``` + +## Column Prefixing + +By default, MikroORM names your columns by prefixing them, using the value object name. + +Following the example above, your columns would be named as `address_street`, +`address_postal_code`... + +You can change this behaviour to meet your needs by changing the `prefix` attribute +in the `@Embedded()` notation. + +The following example shows you how to set your prefix to `myPrefix_`: + +```typescript +@Entity() +export class User { + + @Embedded({ prefix: 'myPrefix_' }) + address!: Address; + +} +``` + +To have MikroORM drop the prefix and use the value object's property name directly, +set `prefix: false`: + +```typescript +@Entity() +export class User { + + @Embedded({ entity: () => Address, prefix: false }) + address!: Address; + +} +``` + +## Storing embeddables as objects + +From MikroORM v4.2 we can also store the embeddable as an object instead of +inlining its properties to the owing entity. + +```ts +@Entity() +export class User { + + @Embedded({ entity: () => Address, object: true }) + address!: Address; + +} +``` + +In SQL drivers, this will use a JSON column to store the value. + +> Only MySQL and PostgreSQL drivers support searching by JSON properties currently. + +> This part of documentation is highly inspired by [doctrine tutorial](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/embeddables.html) +> as the behaviour here is pretty much the same. + +## Array of embeddables + +Embedded arrays are always stored as JSON. It is possible to use them inside +nested embeddables. + +```ts + @Embedded(() => Address, { array: true }) + addresses: Address[] = []; +``` + +## Nested embeddables + +Starting with v4.4, we can also nest embeddables, both in inline mode and object mode: + +```ts +@Entity() +class User { + + @PrimaryKey() + id!: number; + + @Property() + name!: string; + + @Embedded(() => Profile, { object: true, nullable: true }) + profile?: Profile; + +} + +@Embeddable() +class Profile { + + @Property() + username: string; + + @Embedded(() => Identity) + identity: Identity; + + constructor(username: string, identity: Identity) { + this.username = username; + this.identity = identity; + } + +} + +@Embeddable() +class Identity { + + @Property() + email: string; + + constructor(email: string) { + this.email = email; + } + +} +``` diff --git a/entity-constructors.md b/entity-constructors.md index 8bc1ec2..2990190 100644 --- a/entity-constructors.md +++ b/entity-constructors.md @@ -0,0 +1,44 @@ +--- +title: Using Entity Constructors +--- + +Internally, `MikroORM` never calls entity constructor, so you are free to use it as you wish. +The constructor will be called only when you instantiate the class yourself via `new` operator, +so it is a handy place to require your data when creating new entity. + +For example following `Book` entity definition will always require to set `title` and `author`, +but `publisher` will be optional: + +```typescript +@Entity() +export class Book { + + @PrimaryKey() + id!: number; + + @Property() + title!: string; + + @ManyToOne() + author!: Author; + + @ManyToOne() + publisher?: Publisher; + + @ManyToMany({ entity: () => BookTag, inversedBy: 'books' }) + tags = new Collection<BookTag>(this); + + constructor(title: string, author: Author) { + this.title = title; + this.author = author; + } + +} +``` + +## Using native private properties + +If we want to use native private properties inside entities, the default approach of +how MikroORM creates entity instances via `Object.create()` is not viable (more about this +in the [issue](https://github.com/mikro-orm/mikro-orm/issues/1226)). To force usage of entity +constructors, we can use [`forceEntityConstructor`](./configuration.md#using-native-private-properties) toggle. diff --git a/entity-generator.md b/entity-generator.md index 2fd067e..3c5e633 100644 --- a/entity-generator.md +++ b/entity-generator.md @@ -0,0 +1,43 @@ +--- +title: Entity Generator +--- + +To generate entities from existing database schema, you can use `EntityGenerator` helper. + +You can use it via CLI: + +```sh +npx mikro-orm generate-entities --dump # Dumps all generated entities +npx mikro-orm generate-entities --save --path=./my-entities # Saves entities into given directory +``` + +Or you can create simple script where you initialize MikroORM like this: + +```typescript title="./generate-entities.ts" +import { MikroORM } from '@mikro-orm/core'; + +(async () => { + const orm = await MikroORM.init({ + dbName: 'your-db-name', + // ... + }); + const generator = orm.getEntityGenerator(); + const dump = await generator.generate({ + save: true, + baseDir: process.cwd() + '/my-entities', + }); + console.log(dump); + await orm.close(true); +})(); +``` + +Then run this script via `ts-node` (or compile it to plain JS and use `node`): + +```sh +$ ts-node generate-entities +``` + +## Current limitations + +- many to many relations are not supported, pivot table will be represented as separate entity +- in mysql, tinyint columns will be defined as boolean properties diff --git a/entity-helper.md b/entity-helper.md index d16cfed..46ed4ad 100644 --- a/entity-helper.md +++ b/entity-helper.md @@ -0,0 +1,137 @@ +--- +title: EntityHelper and Decorated Entities +sidebar_label: Updating Entity Values +--- + +## Updating Entity Values with `entity.assign()` + +When you want to update entity based on user input, you will usually have just plain +string ids of entity relations as user input. Normally you would need to use +`em.getReference()` to create references from each id first, and then +use those references to update entity relations: + +```typescript +const jon = new Author('Jon Snow', '[email protected]'); +const book = new Book('Book', jon); +book.author = orm.em.getReference<Author>(Author, '...id...'); +``` + +Same result can be easily achieved with `entity.assign()`: + +```typescript +import { wrap } from '@mikro-orm/core'; + +wrap(book).assign({ + title: 'Better Book 1', + author: '...id...', +}); +console.log(book.title); // 'Better Book 1' +console.log(book.author); // instance of Author with id: '...id...' +console.log(book.author.id); // '...id...' +``` + +To use `entity.assign()` on not managed entities, you need to provide `EntityManager` +instance explicitly: + +```typescript +import { wrap } from '@mikro-orm/core'; + +const book = new Book(); +wrap(book).assign({ + title: 'Better Book 1', + author: '...id...', +}, { em: orm.em }); +``` + +By default, `entity.assign(data)` behaves same way as `Object.assign(entity, data)`, +e.g. it does not merge things recursively. To enable deep merging of object properties (not referenced entities), +use second parameter to enable `mergeObjects` flag: + +```typescript +import { wrap } from '@mikro-orm/core'; + +book.meta = { foo: 1, bar: 2 }; + +wrap(book).assign({ meta: { foo: 3 } }, { mergeObjects: true }); +console.log(book.meta); // { foo: 3, bar: 2 } + +wrap(book).assign({ meta: { foo: 4 } }); +console.log(book.meta); // { foo: 4 } +``` + +To get the same behavior as `mergeObjects` flag for m:1 and 1:1 references, enable the `updateNestedEntities` flag. + +```typescript +import { wrap } from '@mikro-orm/core'; + +const authorEntity = new Author('Jon2 Snow', '[email protected]'); +book.author = authorEntity; + +wrap(book).assign({ author: { name: 'Jon Snow2' } }, { updateNestedEntities: true }); +console.log(book.author); // { ... name: 'Jon Snow2' ... } +console.log(book.author === authorEntity) // true + +//this will have no influence as author is an entity +wrap(book).assign({ author: { name: 'Jon Snow2' } }, { mergeObjects: true }); +console.log(book.author); // { ... name: 'Jon Snow2' ... } +console.log(book.author === authorEntity) // false +``` + +## `WrappedEntity` and `wrap()` helper + +`IWrappedEntity` is an interface that defines public helper methods provided +by the ORM: + +```typescript +interface IWrappedEntity<T, PK extends keyof T> { + isInitialized(): boolean; + populated(populated?: boolean): void; + init(populated?: boolean, lockMode?: LockMode): Promise<T>; + toReference(): IdentifiedReference<T, PK>; + toObject(ignoreFields?: string[]): Dictionary; + toJSON(...args: any[]): Dictionary; + assign(data: any, options?: AssignOptions \| boolean): T; +} +``` + +There are two ways to access those methods. You can either extend `BaseEntity` +(exported from `@mikro-orm/core`), that defines those methods, or use the +`wrap()` helper to access `WrappedEntity` instance, where those methods +exist. + +Users can choose whether they are fine with polluting the entity interface with +those additional methods, or they want to keep the interface clean +and use the `wrap(entity)` helper method instead to access them. + +> Since v4 `wrap(entity)` no longer returns the entity, now the `WrappedEntity` instance is +> being returned. It contains only public methods (`init`, `assign`, `isInitialized`, ...), +> if you want to access internal properties like `__meta` or `__em`, you need to explicitly +> ask for the helper via `wrap(entity, true)`. + +```typescript +import { BaseEntity } from '@mikro-orm/core'; + +@Entity() +export class Book extends BaseEntity<Book, 'id'> { ... } +``` + +Then you can work with those methods directly: + +```typescript +book.meta = { foo: 1, bar: 2 }; +book.assign({ meta: { foo: 3 } }, { mergeObjects: true }); +console.log(book.meta); // { foo: 3, bar: 2 } +``` + +### Accessing internal prefixed properties + +Previously it was possible to access internal properties like `__meta` or `__em` +from the `wrap()` helper. Now to access them, you need to use second parameter of +wrap: + +```typescript +@Entity() +export class Author { ... } + +console.log(wrap(author, true).__meta); +``` diff --git a/entity-manager-api.md b/entity-manager-api.md index ec4fe84..45f8a46 100644 --- a/entity-manager-api.md +++ b/entity-manager-api.md @@ -0,0 +1,342 @@ +--- +title: EntityManager API +--- + +#### `getDriver(): IDatabaseDriver` + +Gets the Driver instance used by this EntityManager + +---- + +#### `getConnection(type?: 'read' \| 'write'): ReturnType<D['getConnection']>` + +Gets the Connection instance, by default returns write connection + +---- + +#### `getRepository(entityName: EntityName<T>): GetRepository<T, U>` + +Returns `EntityRepository` for given entity, respects `customRepository` option of `@Entity` +and `entityRepository` option of `MikroORM.init()`. + +---- + +#### `getValidator(): EntityValidator` + +Gets EntityValidator instance + +---- + +#### `find(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOptions<T, P>): Promise<Loaded<T, P>[]>` + +Finds all entities matching your `where` query. You can pass additional options via the `options` parameter. + +```typescript +export interface FindOptions<T, P extends Populate<T> = Populate<T>> { + populate?: P; + orderBy?: QueryOrderMap; + limit?: number; + offset?: number; + refresh?: boolean; + convertCustomTypes?: boolean; + fields?: string[]; + schema?: string; + flags?: QueryFlag[]; + groupBy?: string \| string[]; + having?: QBFilterQuery<T>; + strategy?: LoadStrategy; + filters?: Dictionary<boolean \| Dictionary> \| string[] \| boolean; +} +``` + +---- + +#### `find(entityName: EntityName<T>, where: FilterQuery<T>, populate?: P, orderBy?: QueryOrderMap, limit?: number, offset?: number): Promise<Loaded<T, P>[]>` + +Finds all entities matching your `where` query. +Same as previous `find` method, just with dedicated parameters for `populate`, `orderBy`, `limit` +and `offset`. + +---- + +#### `addFilter(name: string, cond: FilterQuery<T> \| ((args: Dictionary) => FilterQuery<T>), entityName?: EntityName<T>[], enabled?: boolean): void` + +---- + +#### `setFilterParams(name: string, args: Dictionary): void` + +---- + +#### `getFilterParams<T extends Dictionary = Dictionary>(name: string): T` + +---- + +#### `findAndCount(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOptions<T, P>): Promise<[Loaded<T, P>[], number]>` + +Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple +where first element is the array of entities and the second is the count. + +---- + +#### `findAndCount(entityName: EntityName<T>, where: FilterQuery<T>, populate?: P, orderBy?: QueryOrderMap, limit?: number, offset?: number): Promise<[Loaded<T, P>[], number]>` + +Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple +where first element is the array of entities and the second is the count. + +---- + +#### `findOne(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOneOptions<T, P>): Promise<Loaded<T, P> \| null>` + +Finds first entity matching your `where` query. + +---- + +#### `findOne(entityName: EntityName<T>, where: FilterQuery<T>, populate?: P, orderBy?: QueryOrderMap): Promise<Loaded<T, P> \| null>` + +Finds first entity matching your `where` query. + +---- + +#### `findOneOrFail(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOneOrFailOptions<T, P>): Promise<Loaded<T, P>>` + +Finds first entity matching your `where` query. If nothing found, it will throw an error. +You can override the factory for creating this method via `options.failHandler` locally +or via `Configuration.findOneOrFailHandler` globally. + +Finds first entity matching your `where` query. If nothing found, it will throw an error. + +---- + +#### `findOneOrFail(entityName: EntityName<T>, where: FilterQuery<T>, populate?: P, orderBy?: QueryOrderMap): Promise<Loaded<T, P>>` + +You can override the factory for creating this method via `options.failHandler` locally +or via `Configuration.findOneOrFailHandler` globally. + +---- + +#### `transactional(cb: (em: D[typeof EntityManagerType]) => Promise<T>, ctx?: any): Promise<T>` + +Runs your callback wrapped inside a database transaction. + +---- + +#### `begin(ctx?: Transaction): Promise<void>` + +Starts new transaction bound to this EntityManager. Use `ctx` parameter to provide the parent when nesting transactions. + +---- + +#### `commit(): Promise<void>` + +Commits the transaction bound to this EntityManager. Flushes before doing the actual commit query. + +---- + +#### `rollback(): Promise<void>` + +Rollbacks the transaction bound to this EntityManager. + +---- + +#### `lock(entity: AnyEntity, lockMode: LockMode, lockVersion?: number \| Date): Promise<void>` + +Runs your callback wrapped inside a database transaction. + +---- + +#### `nativeInsert(entity: T): Promise<Primary<T>>` + +Fires native insert query. Calling this has no side effects on the context (identity map). + +---- + +#### `nativeInsert(entityName: EntityName<T>, data: EntityData<T>): Promise<Primary<T>>` + +Fires native insert query. Calling this has no side effects on the context (identity map). + +---- + +#### `nativeUpdate(entityName: EntityName<T>, where: FilterQuery<T>, data: EntityData<T>, options?: UpdateOptions<T>): Promise<number>` + +Fires native update query. Calling this has no side effects on the context (identity map). + +---- + +#### `nativeDelete(entityName: EntityName<T>, where: FilterQuery<T>, options?: DeleteOptions<T>): Promise<number>` + +Fires native delete query. Calling this has no side effects on the context (identity map). + +---- + +#### `map(entityName: EntityName<T>, result: EntityData<T>): T` + +Maps raw DB result to entity, adding it to current Identity Map. Equivalent to +`driver.mapResult()` followed by `em.merge()`. + +---- + +#### `merge(entity: T, refresh?: boolean): T` + +Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities +via second parameter. By default it will return already loaded entities without modifying them. + +This is useful when you want to work with cached entities. + +---- + +#### `merge(entityName: EntityName<T>, data: EntityData<T>, refresh?: boolean, convertCustomTypes?: boolean): T` + +Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities +via second parameter. By default it will return already loaded entities without modifying them. + +---- + +#### `create(entityName: EntityName<T>, data: EntityData<T>): New<T, P>` + +Creates new instance of given entity and populates it with given data + +---- + +#### `assign(entity: T, data: EntityData<T>, options?: AssignOptions): T` + +Shortcut for `wrap(entity).assign(data, { em })` + +---- + +#### `getReference(entityName: EntityName<T>, id: Primary<T>, wrapped?: boolean, convertCustomTypes?: boolean): T \| Reference<T>` + +Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded + +---- + +#### `count(entityName: EntityName<T>, where?: FilterQuery<T>, options?: CountOptions<T>): Promise<number>` + +Returns total number of entities matching your `where` query. + +---- + +#### `persist(entity: AnyEntity \| Reference<AnyEntity> \| (AnyEntity \| Reference<AnyEntity>)[]): this` + +Tells the EntityManager to make an instance managed and persistent. +The entity will be entered into the database at or before transaction commit or as a result of the flush operation. + +---- + +#### `persistAndFlush(entity: AnyEntity \| Reference<AnyEntity> \| (AnyEntity \| Reference<AnyEntity>)[]): Promise<void>` + +Persists your entity immediately, flushing all not yet persisted changes to the database too. +Equivalent to `em.persist(e).flush()`. + +---- + +#### `persistLater(entity: AnyEntity \| AnyEntity[]): void` + +> deprecated, use `persist()` + +Tells the EntityManager to make an instance managed and persistent. +The entity will be entered into the database at or before transaction commit or as a result of the flush operation. + +---- + +#### `remove(entity: T \| Reference<T> \| (T \| Reference<T>)[]): this` + +Marks entity for removal. +A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. + +This method fires `beforeDelete` and `afterDelete` hooks. + +To remove entities by condition, use `em.nativeDelete()`. + +---- + +#### `removeAndFlush(entity: AnyEntity \| Reference<AnyEntity>): Promise<void>` + +Removes an entity instance immediately, flushing all not yet persisted changes to the database too. +Equivalent to `em.remove(e).flush()` + +This method fires `beforeDelete` and `afterDelete` hooks. + +---- + +#### `removeLater(entity: AnyEntity): void` + +> deprecated use `remove()` + +Marks entity for removal. +A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation. + +---- + +#### `flush(): Promise<void>` + +Flushes all changes to objects that have been queued up to now to the database. +This effectively synchronizes the in-memory state of managed objects with the database. + +---- + +#### `clear(): void` + +Clears the EntityManager. All entities that are currently managed by this EntityManager become detached. + +---- + +#### `canPopulate(entityName: EntityName<T>, property: string): boolean` + +Checks whether given property can be populated on the entity. + +---- + +#### `populate(entities: T \| T[], populate: P, where?: FilterQuery<T>, orderBy?: QueryOrderMap, refresh?: boolean, validate?: boolean): Promise<Loaded<T, P> \| Loaded<T, P>[]>` + +Populate existing entities. Supports nested (conditional) populating. + +---- + +#### `fork(clear?: boolean, useContext?: boolean): D[typeof EntityManagerType]` + +Returns new EntityManager instance with its own identity map + +``` +@param clear do we want clear identity map? defaults to true +@param useContext use request context? should be used only for top level request scope EM, defaults to false +``` + +---- + +#### `getUnitOfWork(): UnitOfWork` + +Gets the UnitOfWork used by the EntityManager to coordinate operations. + +---- + +#### `getEntityFactory(): EntityFactory` + +Gets the EntityFactory used by the EntityManager. + +---- + +#### `getEventManager(): EventManager` + +---- + +#### `isInTransaction(): boolean` + +Checks whether this EntityManager is currently operating inside a database transaction. + +---- + +#### `getTransactionContext<T extends Transaction = Transaction>(): T \| undefined` + +Gets the transaction context (driver dependent object used to make sure queries are executed on same connection). + +---- + +#### `getMetadata(): MetadataStorage` + +Gets the MetadataStorage. + +---- + +#### `getComparator(): EntityComparator` + +---- diff --git a/entity-manager.md b/entity-manager.md index 3f6b574..8ab7eb0 100644 --- a/entity-manager.md +++ b/entity-manager.md @@ -0,0 +1,338 @@ +--- +title: Working with Entity Manager +sidebar_label: Entity Manager +--- + +## Persist and Flush + +There are 2 methods we should first describe to understand how persisting works in MikroORM: +`em.persist()` and `em.flush()`. + +`em.persist(entity)` is used to mark new entities for future persisting. +It will make the entity managed by given `EntityManager` and once `flush` will be called, it +will be written to the database. + +To understand `flush`, lets first define what managed entity is: An entity is managed if +it’s fetched from the database (via `em.find()`, `em.findOne()` or via other managed entity) +or registered as new through `em.persist()`. + +`em.flush()` will go through all managed entities, compute appropriate change sets and +perform according database queries. As an entity loaded from database becomes managed +automatically, you do not have to call persist on those, and flush is enough to update +them. + +```typescript +const book = await orm.em.findOne(Book, 1); +book.title = 'How to persist things...'; + +// no need to persist `book` as its already managed by the EM +await orm.em.flush(); +``` + +## Persisting and Cascading + +To save entity state to database, you need to persist it. Persist determines +whether to use `insert` or `update` and computes appropriate change-set. Entity references +that are not persisted yet (does not have identifier) will be cascade persisted automatically. + +```typescript +// use constructors in your entities for required parameters +const author = new Author('Jon Snow', '[email protected]'); +author.born = new Date(); + +const publisher = new Publisher('7K publisher'); + +const book1 = new Book('My Life on The Wall, part 1', author); +book1.publisher = publisher; +const book2 = new Book('My Life on The Wall, part 2', author); +book2.publisher = publisher; +const book3 = new Book('My Life on The Wall, part 3', author); +book3.publisher = publisher; + +// just persist books, author and publisher will be automatically cascade persisted +await orm.em.persistAndFlush([book1, book2, book3]); + +// or one by one +orm.em.persist(book1); +orm.em.persist(book2); +orm.em.persist(book3); +await orm.em.flush(); // flush everything to database at once +``` + +## Fetching Entities with EntityManager + +To fetch entities from database you can use `find()` and `findOne()` of `EntityManager`: + +Example: + +```typescript +const author = await orm.em.findOne(Author, '...id...'); +const books = await orm.em.find(Book, {}); + +for (const author of authors) { + console.log(author.name); // Jon Snow + + for (const book of author.books) { + console.log(book.title); // initialized + console.log(book.author.isInitialized()); // true + console.log(book.author.id); + console.log(book.author.name); // Jon Snow + console.log(book.publisher); // just reference + console.log(book.publisher.isInitialized()); // false + console.log(book.publisher.id); + console.log(book.publisher.name); // undefined + } +} +``` + +To populate entity relations, you can use `populate` parameter. + +```typescript +const books = await orm.em.find(Book, { foo: 1 }, ['author.friends']); +``` + +You can also use `em.populate()` helper to populate relations (or to ensure they +are fully populated) on already loaded entities. This is also handy when loading +entities via `QueryBuilder`: + +```typescript +const authors = await orm.em.createQueryBuilder(Author).select('').getResult(); +await em.populate(authors, ['books.tags']); + +// now your Author entities will have `books` collections populated, +// as well as they will have their `tags` collections populated. +console.log(authors[0].books[0].tags[0]); // initialized BookTag +``` + +### Conditions Object (`FilterQuery<T>`) + +Querying entities via conditions object (`where` in `em.find(Entity, where: FilterQuery<T>)`) +supports many different ways: + +```typescript +// search by entity properties +const users = await orm.em.find(User, { firstName: 'John' }); + +// for searching by reference you can use primary key directly +const id = 1; +const users = await orm.em.find(User, { organization: id }); + +// or pass unpopulated reference (including `Reference` wrapper) +const ref = await orm.em.getReference(Organization, id); +const users = await orm.em.find(User, { organization: ref }); + +// fully populated entities as also supported +const ent = await orm.em.findOne(Organization, id); +const users = await orm.em.find(User, { organization: ent }); + +// complex queries with operators +const users = await orm.em.find(User, { $and: [{ id: { $nin: [3, 4] } }, { id: { $gt: 2 } }] }); + +// you can also search for array of primary keys directly +const users = await orm.em.find(User, [1, 2, 3, 4, 5]); + +// and in findOne all of this works, plus you can search by single primary key +const user1 = await orm.em.findOne(User, 1); +``` + +As you can see in the fifth example, one can also use operators like `$and`, `$or`, `$gte`, +`$gt`, `$lte`, `$lt`, `$in`, `$nin`, `$eq`, `$ne`, `$like`, `$re`. More about that can be found in +[Query Conditions](query-conditions.md) section. + +#### Mitigating `Type instantiation is excessively deep and possibly infinite.ts(2589)` error + +Sometimes you might be facing TypeScript errors caused by too complex query for it to +properly infer all types. Usually it can be solved by providing the type argument +explicitly. + +You can also opt in to use repository instead, as there the type inference should not be +problematic. + +> As a last resort, you can always type cast the query to `any`. + +```typescript +const books = await orm.em.find<Book>(Book, { ... your complex query ... }); +// or +const books = await orm.em.getRepository(Book).find({ ... your complex query ... }); +// or +const books = await orm.em.find<any>(Book, { ... your complex query ... }) as Book[]; +``` + +Another problem you might be facing is `RangeError: Maximum call stack size exceeded` error +thrown during TypeScript compilation (usually from file `node_modules/typescript/lib/typescript.js`). +The solution to this is the same, just provide the type argument explicitly. + +### Searching by referenced entity fields + +You can also search by referenced entity properties. Simply pass nested where condition like +this and all requested relationships will be automatically joined. Currently it will only join +them so you can search and sort by those. To populate entities, do not forget to pass the populate +parameter as well. + +```typescript +// find author of a book that has tag specified by name +const author = await orm.em.findOne(Author, { books: { tags: { name: 'Tag name' } } }); +console.log(author.books.isInitialized()); // false, as it only works for query and sort + +const author = await orm.em.findOne(Author, { books: { tags: { name: 'Tag name' } } }, ['books.tags']); +console.log(author.books.isInitialized()); // true, because it was populated +console.log(author.books[0].tags.isInitialized()); // true, because it was populated +console.log(author.books[0].tags[0].isInitialized()); // true, because it was populated +``` + +> This feature is fully available only for SQL drivers. In MongoDB always you need to +> query from the owning side - so in the example above, first load book tag by name, +> then associated book, then the author. Another option is to denormalize the schema. + +### Fetching Partial Entities + +> This feature is supported only for `SELECT_IN` loading strategy. + +When fetching single entity, you can choose to select only parts of an entity via `options.fields`: + +```ts +const author = await orm.em.findOne(Author, '...', { fields: ['name', 'born'] }); +console.log(author.id); // PK is always selected +console.log(author.name); // Jon Snow +console.log(author.email); // undefined +``` + +From v4.4 it is also possible to specify fields for nested relations: + +```ts +const author = await orm.em.findOne(Author, '...', { fields: ['name', 'books.title', 'books.author', 'books.price'] }); +``` + +Or with an alternative object syntax: + +```ts +const author = await orm.em.findOne(Author, '...', { fields: ['name', { books: ['title', 'author', 'price'] }] }); +``` + +It is also possible to use multiple levels: + +```ts +const author = await orm.em.findOne(Author, '...', { fields: ['name', { books: ['title', 'price', 'author', { author: ['email'] }] }] }); +``` + +Primary keys are always selected even if you omit them. On the other hand, you are responsible +for selecting the FKs - if you omit such property, the relation might not be loaded properly. +In the following example the books would not be linked the author, because we did not specify +the `books.author` field to be loaded. + +```ts +// this will load both author and book entities, but they won't be connected due to the missing FK in select +const author = await orm.em.findOne(Author, '...', { fields: ['name', { books: ['title', 'price'] }); +``` + +> Same problem can occur in mongo with M:N collections - those are stored as array property +> on the owning entity, so you need to make sure to mark such properties too. + +### Fetching Paginated Results + +If you are going to paginate your results, you can use `em.findAndCount()` that will return +total count of entities before applying limit and offset. + +```typescript +const [authors, count] = await orm.em.findAndCount(Author, { ... }, { limit: 10, offset: 50 }); +console.log(authors.length); // based on limit parameter, e.g. 10 +console.log(count); // total count, e.g. 1327 +``` + +### Handling Not Found Entities + +When you call `em.findOne()` and no entity is found based on your criteria, `null` will be +returned. If you rather have an `Error` instance thrown, you can use `em.findOneOrFail()`: + +```typescript +const author = await orm.em.findOne(Author, { name: 'does-not-exist' }); +console.log(author === null); // true + +try { + const author = await orm.em.findOneOrFail(Author, { name: 'does-not-exist' }); + // author will be always found here +} catch (e) { + console.error('Not found', e); +} +``` + +You can customize the error either globally via `findOneOrFailHandler` option, or locally via +`failHandler` option in `findOneOrFail` call. + +```typescript +try { + const author = await orm.em.findOneOrFail(Author, { name: 'does-not-exist' }, { + failHandler: (entityName: string, where: Record<string, any> \| IPrimaryKey) => new Error(`Failed: ${entityName} in ${util.inspect(where)}`) + }); +} catch (e) { + console.error(e); // your custom error +} +``` + +### Using custom SQL fragments + +It is possible to use any SQL fragment in your `WHERE` query or `ORDER BY` clause: + +> The `expr()` helper is an identity function - all it does is to return its parameter. +> We can use it to bypass the strict type checks in `FilterQuery`. + +```ts +const users = await orm.em.find(User, { [expr('lower(email)')]: '[email protected]' }, { + orderBy: { [`(point(loc_latitude, loc_longitude) <@> point(0, 0))`]: 'ASC' }, +}); +``` + +This will produce following query: + +```sql +select `e0`. +from `user` as `e0` +where lower(email) = '[email protected]' +order by (point(loc_latitude, loclongitude) <@> point(0, 0)) asc +``` + +## Disabling identity map and change set tracking + +Sometimes we might want to disable identity map and change set tracking for some query. +This is possible via `disableIdentityMap` option. Behind the scenes, it will create new +context, load the entities inside that, and clear it afterwards, so the main identity map +will stay clean. + +> As opposed to _managed_ entities, such entities are called _detached_. +> To be able to work with them, you first need to merge them via `em.registerManaged()`. + +```ts +const users = await orm.em.find(User, { email: '[email protected]' }, { + disableIdentityMap: true, + populate: { cars: { brand: true } }, +}); +users[0].name = 'changed'; +await orm.em.flush(); // calling flush have no effect, as the entity is not managed +``` + +> Keep in mind that this can also have +> [negative effect on the performance](https://stackoverflow.com/questions/9259480/entity-framework-mergeoption-notracking-bad-performance). + +## Type of Fetched Entities + +Both `em.find` and `em.findOne()` methods have generic return types. +All of following examples are equal and will let typescript correctly infer the entity type: + +```typescript +const author1 = await orm.em.findOne<Author>(Author.name, '...id...'); +const author2 = await orm.em.findOne<Author>('Author', '...id...'); +const author3 = await orm.em.findOne(Author, '...id...'); +``` + +As the last one is the least verbose, it should be preferred. + +## Entity Repositories + +Although you can use `EntityManager` directly, much more convenient way is to use +[`EntityRepository` instead](https://mikro-orm.io/repositories/). You can register +your repositories in dependency injection container like [InversifyJS](http://inversify.io/) +so you do not need to get them from `EntityManager` each time. + +For more examples, take a look at +[`tests/EntityManager.mongo.test.ts`](https://github.com/mikro-orm/mikro-orm/blob/master/tests/EntityManager.mongo.test.ts) +or [`tests/EntityManager.mysql.test.ts`](https://github.com/mikro-orm/mikro-orm/blob/master/tests/EntityManager.mysql.test.ts). diff --git a/entity-references.md b/entity-references.md index 096b2ff..71723d3 100644 --- a/entity-references.md +++ b/entity-references.md @@ -0,0 +1,305 @@ +--- +title: Entity References +sidebar_label: Entity References and Reference<T> Wrapper +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Every single entity relation is mapped to an entity reference. Reference is an entity that has +only its identifier. This reference is stored in identity map so you will get the same object +reference when fetching the same document from database. + +You can call `await wrap(entity).init()` to initialize the entity. This will trigger database call +and populate itself, keeping the same reference in identity map. + +```typescript +const author = orm.em.getReference('...id...'); +console.log(author.id); // accessing the id will not trigger any db call +console.log(author.isInitialized()); // false +console.log(author.name); // undefined + +await wrap(author).init(); // this will trigger db call +console.log(author.isInitialized()); // true +console.log(author.name); // defined +``` + +## Better Type-safety with `Reference<T>` Wrapper + +When you define `@ManyToOne` and `@OneToOne` properties on your entity, TypeScript compiler +will think that desired entities are always loaded: + +```typescript +@Entity() +export class Book { + + @PrimaryKey() + id!: number; + + @ManyToOne() + author!: Author; + + constructor(author: Author) { + this.author = author; + } + +} + +const book = await orm.em.findOne(Book, 1); +console.log(book.author instanceof Author); // true +console.log(book.author.isInitialized()); // false +console.log(book.author.name); // undefined as `Author` is not loaded yet +``` + +You can overcome this issue by using the `Reference<T>` wrapper. It simply wraps the entity, +defining `load(): Promise<T>` method that will first lazy load the association if not already +available. You can also use `unwrap(): T` method to access the underlying entity without loading +it. + +You can also use `get<K extends keyof T>(prop: K): Promise<T[K]>` helper, that will call `load()` +for you, making sure the entity is initialized first, then returning the value of given property +directly. + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +import { Entity, IdentifiedReference, ManyToOne, PrimaryKey, Reference } from '@mikro-orm/core'; + +@Entity() +export class Book { + + @PrimaryKey() + id!: number; + + @ManyToOne(() => Author, { wrappedReference: true }) + author: IdentifiedReference<Author>; + + constructor(author: Author) { + this.author = Reference.create(author); + } + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +import { Entity, IdentifiedReference, ManyToOne, PrimaryKey, Reference } from '@mikro-orm/core'; + +@Entity() +export class Book { + + @PrimaryKey() + id!: number; + + @ManyToOne() + author: IdentifiedReference<Author>; + + constructor(author: Author) { + this.author = Reference.create(author); + } + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface IBook { + id: number; + author: IdentifiedReference<Author>; +} + +export const Book = new EntitySchema<IBook>({ + name: 'Book', + properties: { + id: { type: Number, primary: true }, + author: { entity: () => Author, wrappedReference: true }, + }, +}); +``` + + </TabItem> +</Tabs> + +```ts +const book = await orm.em.findOne(Book, 1); +console.log(book.author instanceof Reference); // true +console.log(book.author.isInitialized()); // false +console.log(book.author.name); // type error, there is no `name` property +console.log(book.author.unwrap().name); // undefined as author is not loaded +console.log((await book.author.load('name'))); // ok, loading the author first +console.log((await book.author.load()).name); // ok, author already loaded +console.log(book.author.unwrap().name); // ok, author already loaded +``` + +There are also `getEntity()` and `getProperty()` methods that are synchronous getters, +that will first check if the wrapped entity is initialized, and if not, it will throw +and error. + +```typescript +const book = await orm.em.findOne(Book, 1); +console.log(book.author instanceof Reference); // true +console.log(book.author.isInitialized()); // false +console.log(book.author.getEntity()); // Error: Reference<Author> 123 not initialized +console.log(book.author.getProperty('name')); // Error: Reference<Author> 123 not initialized +console.log((await book.author.load('name'))); // ok, loading the author first +console.log(book.author.getProperty('name')); // ok, author already loaded +``` + +If you use different metadata provider than `TsMorphMetadataProvider` +(e.g. `ReflectMetadataProvider`), you will also need to explicitly set `wrappedReference` +parameter: + +```typescript +@ManyToOne(() => Author, { wrappedReference: true }) +author!: IdentifiedReference<Author>; +``` + +### Assigning to Reference Properties + +When you define the property as `Reference` wrapper, you will need to assign the `Reference` +to it instead of the entity. You can create it via `Reference.create()` factory, or use `wrapped` +parameter of `em.getReference()`: + +```typescript +const book = await orm.em.findOne(Book, 1); +const repo = orm.em.getRepository(Author); + +book.author = repo.getReference(2, true); + +// same as: +book.author = Reference.create(repo.getReference(2)); +await orm.em.flush(); +``` + +Another way is to use `toReference()` method available as part of +[`WrappedEntity` interface](entity-helper.md#wrappedentity-and-wrap-helper): + +```typescript +const author = new Author(...) +book.author = wrap(author).toReference(); +``` + +If the reference already exist, you can also re-assign to it via `set()` method: + +```typescript +book.author.set(new Author(...)); +``` + +### What is IdentifiedReference? + +`IdentifiedReference` is an intersection type that adds primary key property to the `Reference` +interface. It allows to get the primary key from `Reference` instance directly. + +By default, we try to detect the PK by checking if a property with a known name exists. +We check for those in order: `_id`, `uuid`, `id` - with a way to manually set the property +name via `PrimaryKeyProp` symbol (`[PrimaryKeyProp]?: 'foo';`). + +We can also override this via second generic type argument. + +```typescript +const book = await orm.em.findOne(Book, 1); +console.log(book.author.id); // ok, returns the PK +``` + +You can also have non-standard primary key: + +```ts +author: IdentifiedReference<Author, 'myPrimaryKey'>; + +const book = await orm.em.findOne(Book, 1); +console.log(book.author.myPrimaryKey); // ok, returns the PK +``` + +For MongoDB, defined the PK generic type argument as `'id' \| '_id'` to access both `string` +and `ObjectId` PK values: + +<Tabs +groupId="entity-def" +defaultValue="reflect-metadata" +values={[ +{label: 'reflect-metadata', value: 'reflect-metadata'}, +{label: 'ts-morph', value: 'ts-morph'}, +{label: 'EntitySchema', value: 'entity-schema'}, +] +}> +<TabItem value="reflect-metadata"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; + + @ManyToOne(() => Author, { wrappedReference: true }) + author!: IdentifiedReference<Author, 'id' \| '_id'>; + +} +``` + + </TabItem> + <TabItem value="ts-morph"> + +```ts title="./entities/Book.ts" +@Entity() +export class Book { + + @PrimaryKey() + _id!: ObjectId; + + @SerializedPrimaryKey() + id!: string; + + @ManyToOne() + author!: IdentifiedReference<Author, 'id' \| '_id'>; + +} +``` + + </TabItem> + <TabItem value="entity-schema"> + +```ts title="./entities/Book.ts" +export interface IBook { + _id: ObjectId; + id: string; + author: IdentifiedReference<IAuthor, 'id' \| '_id'>; +} + +export const Book = new EntitySchema<IBook>({ + name: 'Book', + properties: { + _id: { type: 'ObjectId', primary: true }, + id: { type: String, serializedPrimaryKey: true }, + author: { entity: 'Author', wrappedReference: true }, + }, +}); +``` + + </TabItem> +</Tabs> + +```ts +const book = await orm.em.findOne(Book, 1); +console.log(book.author.id); // ok, returns string PK +console.log(book.author._id); // ok, returns ObjectId PK +``` + +> As opposed to `EntityHelper.init()` which always refreshes the entity, `Reference.load()` +> method will query the database only if the entity is not already loaded in Identity Map. diff --git a/entity-schema.md b/entity-schema.md index 5954ccc..467043d 100644 --- a/entity-schema.md +++ b/entity-schema.md @@ -0,0 +1,179 @@ +--- +title: Defining Entities via EntitySchema +--- + +With `EntitySchema` helper you define the schema programmatically. + +```typescript title="./entities/Book.ts" +export interface Book extends BaseEntity { + title: string; + author: Author; + publisher: Publisher; + tags: Collection<BookTag>; +} + +export const schema = new EntitySchema<Book, BaseEntity>({ + name: 'Book', + extends: 'BaseEntity', + properties: { + title: { type: 'string' }, + author: { reference: 'm:1', entity: 'Author', inversedBy: 'books' }, + publisher: { reference: 'm:1', entity: 'Publisher', inversedBy: 'books' }, + tags: { reference: 'm:n', entity: 'BookTag', inversedBy: 'books', fixedOrder: true }, + }, +}); +``` + +When creating new entity instances, you will need to use `em.create()` method that will +create instance of internally created class. + +```typescript +const repo = em.getRepository<Author>('Author'); +const author = repo.create('Author', { name: 'name', email: 'email' }); // instance of internal Author class +await repo.persistAndFlush(author); +``` + +> Using this approach, metadata caching is automatically disabled as it is not needed. + +## Using custom entity classes + +You can optionally use custom class for entity instances. + +```typescript title="./entities/Author.ts" +export class Author extends BaseEntity { + name: string; + email: string; + age?: number; + termsAccepted?: boolean; + identities?: string[]; + born?: Date; + books = new Collection<Book>(this); + favouriteBook?: Book; + version?: number; + + constructor(name: string, email: string) { + this.name = name; + this.email = email; + } +} + +export const schema = new EntitySchema<Author, BaseEntity>({ + class: Author, + properties: { + name: { type: 'string' }, + email: { type: 'string', unique: true }, + age: { type: 'number', nullable: true }, + termsAccepted: { type: 'boolean', default: 0, onCreate: () => false }, + identities: { type: 'string[]', nullable: true }, + born: { type: DateType, nullable: true, length: 3 }, + books: { reference: '1:m', entity: () => 'Book', mappedBy: book => book.author }, + favouriteBook: { reference: 'm:1', type: 'Book' }, + version: { type: 'number', persist: false }, + }, +}); +``` + +Then you can use the entity class as usual: + +```typescript +const repo = em.getRepository(Author); +const author = new Author('name', 'email'); +await repo.persistAndFlush(author); +``` + +## Using BaseEntity + +Do not forget that base entities needs to be discovered just like normal entities. + +```typescript title="./entities/BaseEntity.ts" +export interface BaseEntity { + id: number; + createdAt: Date; + updatedAt: Date; +} + +export const schema = new EntitySchema<BaseEntity>({ + name: 'BaseEntity', + abstract: true, + properties: { + id: { type: 'number', primary: true }, + createdAt: { type: 'Date', onCreate: () => new Date(), nullable: true }, + updatedAt: { type: 'Date', onCreate: () => new Date(), onUpdate: () => new Date(), nullable: true }, + }, +}); +``` + +## Configuration Reference + +The parameter of `EntitySchema` requires to provide either `name` or `class` parameters. +When using `class`, `extends` will be automatically inferred. You can optionally pass +these additional parameters: + +```typescript +name: string; +class: Constructor<T>; +extends: string; +tableName: string; // alias for `collection: string` +properties: { [K in keyof T & string]: EntityProperty<T[K]> }; +indexes: { properties: string \| string[]; name?: string; type?: string }[]; +uniques: { properties: string \| string[]; name?: string }[]; +customRepository: () => Constructor<EntityRepository<T>>; +hooks: Partial<Record<HookType, (string & keyof T)[]>>; +abstract: boolean; +``` + +Every property then needs to contain a type specification - one of `type`/`customType`/`entity`. +Here are some examples of various property types: + +```typescript +export enum MyEnum { + LOCAL = 'local', + GLOBAL = 'global', +} + +export const schema = new EntitySchema<FooBar>({ + name: 'FooBar', + tableName: 'tbl_foo_bar', + indexes: [{ name: 'idx1', properties: 'name' }], + uniques: [{ name: 'unq1', properties: ['name', 'email'] }], + customRepository: () => FooBarRepository, + properties: { + id: { type: 'number', primary: true }, + name: { type: 'string' }, + baz: { reference: '1:1', entity: 'FooBaz', orphanRemoval: true, nullable: true }, + fooBar: { reference: '1:1', entity: 'FooBar', nullable: true }, + publisher: { reference: 'm:1', entity: 'Publisher', inversedBy: 'books' }, + books: { reference: '1:m', entity: () => 'Book', mappedBy: book => book.author }, + tags: { reference: 'm:n', entity: 'BookTag', inversedBy: 'books', fixedOrder: true }, + version: { type: 'Date', version: true, length: 0 }, + type: { enum: true, items: () => MyEnum, default: MyEnum.LOCAL }, + }, +}); +``` + +> As a value for `type` you can also use one of `String`/`Number`/`Boolean`/`Date`. + +## MongoDB example + +```typescript +export class BookTag { + _id!: ObjectId; + id!: string; + name: string; + books = new Collection<Book>(this); + + constructor(name: string) { + this.name = name; + } +} + +export const schema = new EntitySchema<BookTag>({ + class: BookTag, + properties: { + _id: { type: 'ObjectId', primary: true }, + id: { type: 'string', serializedPrimaryKey: true }, + name: { type: 'string' }, + books: { reference: 'm:n', entity: () => Book, mappedBy: book => book.tags }, + }, +}); +``` diff --git a/faq.md b/faq.md index 38933f7..47de0f2 100644 --- a/faq.md +++ b/faq.md @@ -0,0 +1,105 @@ +--- +title: Frequently Asked Questions +--- + +### How can I synchronize my database schema with the entities? + +There are two ways: +- [Schema Generator](./schema-generator.md) +- [Migrations](./migrations.md) + +```sh +npx mikro-orm schema:update --run +``` + +### I cannot run the CLI + +Make sure you install `@mikro-orm/cli` package locally. If you want to have +global installation, you will need to install driver packages globally too. + +### EntityManager does not have `createQueryBuilder()` method + +The method is there, the issue is in the TS type. + +In v4 the `core` package, where `EntityManager` and `EntityRepository` are +defined, is not dependent on knex, and therefore it cannot have a method +returning a `QueryBuilder`. You need to import the SQL flavour of the EM +from the driver package to access the `createQueryBuilder()` method. + +> The SQL flavour of EM is actually called `SqlEntityManager`, it is exported both under +> this name and under `EntityManager` alias, so you can just change the +> location from where you import. + +```typescript +import { EntityManager } from '@mikro-orm/mysql'; // or any other SQL driver package + +const em: EntityManager; +const qb = await em.createQueryBuilder(...); +``` + +Same applies for the `aggregate()` method in mongo driver: + +```typescript +import { EntityManager } from '@mikro-orm/mongodb'; + +const em: EntityManager; +const ret = await em.aggregate(...); +``` + +> The mongo flavour of EM is actually called `MongoEntityManager`, it is exported both under +> this name and under `EntityManager` alias, so you can just change the +> location from where you import. + +### How can I add columns to pivot table (M:N relation) + +You should model your M:N relation transparently, via 1:m and m:1 properties. +More about this can be found in [Composite Keys section](./composite-keys.md/#use-case-3-join-table-with-metadata). + +### You cannot call `em.flush()` from inside lifecycle hook handlers + +You might see this validation error even if you do not use hooks. If that happens, +the reason is usually because you do not have [request context](identity-map.md) set up properly, and +you are reusing one `EntityManager` instance. + +### Column is being created with JSON type while the TS type is `string/Date/number/...` + +You are probably using the default `ReflectMetadataProvider`, which does not +support inferring property type when there is a property initializer. + +```ts +@Property() +foo = 'abc'; +``` + +There are two ways around this: +- use [TsMorphMetadataProvider](./metadata-providers.md/#tsmorphmetadataprovider) +- specify the type explicitly: + +```ts +@Property() +foo: string = 'abc'; +``` + +### How to set foreign key by raw id? + +There are several ways: + +1. using references: + +```ts +const b = new Book(); +b.author = em.getReference(Author, 1); +``` + +2. using assign helper: + +```ts +const b = new Book(); +em.assign(b, { author: 1 }); +``` + +3. using create helper: + +```ts +const b = em.create(Book, { author: 1 }); +``` diff --git a/filters.md b/filters.md index c932b1d..12aff33 100644 --- a/filters.md +++ b/filters.md @@ -0,0 +1,168 @@ +--- +title: Filters +--- + +MikroORM has the ability to pre-define filter criteria and attach those filters +to given entities. The application can then decide at runtime whether certain +filters should be enabled and what their parameter values should be. Filters +can be used like database views, but they are parameterized inside the application. + +> Filter can be defined at the entity level, dynamically via EM (global filters) +> or in the ORM configuration. + +Filters are applied to those methods of `EntityManager`: `find()`, `findOne()`, +`findAndCount()`, `findOneOrFail()`, `count()`, `nativeUpdate()` and `nativeDelete()`. + +> The `cond` parameter can be a callback, possibly asynchronous. + +```typescript +@Entity() +@Filter({ name: 'expensive', cond: { price: { $gt: 1000 } } }) +@Filter({ name: 'long', cond: { 'length(text)': { $gt: 10000 } } }) +@Filter({ name: 'hasAuthor', cond: { author: { $ne: null } }, default: true }) +@Filter({ name: 'writtenBy', cond: args => ({ author: { name: args.name } }) }) +export class Book { + ... +} + +const books1 = await orm.em.find(Book, {}, { + filters: ['long', 'expensive'], +}); +const books2 = await orm.em.find(Book, {}, { + filters: { hasAuthor: false, long: true, writtenBy: { name: 'God' } }, +}); +``` + +## Properties of filter + +There are three parameters you can use: +- `name` - can be used to enable a filter on the query can also used to pass a parameter +- `cond` - is the condition that should be added to the query when the filter is enabled. This can be a callback, even async +- `default` - indicates if the filter is enabled by default on the query + +## Parameters + +You can define the `cond` dynamically as a callback. This callback can be also +asynchronous. It will get two arguments: + +- `args` - dictionary of parameters provided by user +- `type` - type of operation that is being filtered, one of `'read'`, `'update'`, `'delete'` + +```typescript +@Entity() +@Filter({ name: 'writtenBy', cond: async (args, type) => { + if (type === 'update') { + return {}; // do not apply when updating + } + + return { author: { name: args.name } }; +} }) +export class Book { + ... +} + +const books = await orm.em.find(Book, {}, { + filters: { writtenBy: { name: 'God' } }, +}); +``` + +### Filters without parameters + +If we want to have a filter condition that do not need arguments, but we want +to access the `type` parameter, we will need to explicitly set `args: false`, +otherwise error will be raised due to missing parameters: + +```ts +@Filter({ + name: 'withoutParams', + cond(_, type) { + return { ... }; + }, + args: false, + default: true, +}) +``` + +## Global filters + +We can also register filters dynamically via `EntityManager` API. We call such filters +global. They are enabled by default (unless disabled via last parameter in `addFilter()` +method), and applied to all entities. You can limit the global filter to only specified +entities. + +> Filters as well as filter params set on the EM will be copied to all its forks. + +```typescript +// bound to entity, enabled by default +em.addFilter('writtenBy', args => ({ author: args.id }), Book); + +// global, enabled by default, for all entities +em.addFilter('tenant', args => { ... }); + +// global, enabled by default, for only specified entities +em.addFilter('tenant', args => { ... }, [Author, Book]); +... + +// set params (probably in some middleware) +em.setFilterParams('tenant', { tenantId: 123 }); +em.setFilterParams('writtenBy', { id: 321 }); +``` + +Global filters can be also registered via ORM configuration: + +```typescript +MikroORM.init({ + filters: { tenant: { cond: args => ({ tenant: args.tenant }), entity: ['Author', 'User'] } }, + ... +}) +``` + +## Using filters + +We can control what filters will be applied via `filter` parameter in `FindOptions`. +We can either provide an array of names of filters you want to enable, or options +object, where we can also disable a filter (that was enabled by default), or pass some +parameters to those that are expecting them. + +> By passing `filters: false` we can also disable all the filters for given call. + +```typescript +em.find(Book, {}); // same as `{ tenantId: 123 }` +em.find(Book, {}, { filters: ['writtenBy'] }); // same as `{ author: 321, tenantId: 123 }` +em.find(Book, {}, { filters: { tenant: false } }); // disabled tenant filter, so truly `{}` +em.find(Book, {}, { filters: false }); // disabled all filters, so truly `{}` +``` + +## Filters and populating of relationships + +When populating relationships, filters will be applied only to the root entity of +given query, but not to those that are auto-joined. On the other hand, this means that +when you use the default loading strategy - `LoadStrategy.SELECT_IN` - filters will +be applied to every entity populated this way, as the child entities will become +root entities in their respective load calls. + +## Naming of filters + +When toggling filters via `FindOptions`, we do not care about the entity name. This +means that when you have multiple filters defined on different entities, but with +the same name, they will be controlled via single toggle in the `FindOptions`. + +```typescript +@Entity() +@Filter({ name: 'tenant', cond: args => ({ tenant: args.tenant }) }) +export class Author { + ... +} + +@Entity() +@Filter({ name: 'tenant', cond: args => ({ tenant: args.tenant }) }) +export class Book { + ... +} + +// this will apply the tenant filter to both Author and Book entities (with SELECT_IN loading strategy) +const authors = await orm.em.find(Author, {}, { + populate: ['books'], + filters: { tenant: 123 }, +}); +``` diff --git a/identity-map.md b/identity-map.md index 712a4c7..62f0075 100644 --- a/identity-map.md +++ b/identity-map.md @@ -0,0 +1,92 @@ +--- +title: Identity Map and Request Context +--- + +`MikroORM` uses identity map in background so you will always get the same instance of +one entity. + +```typescript +const authorRepository = orm.em.getRepository(Author); +const jon = await authorRepository.findOne({ name: 'Jon Snow' }, ['books']); +const authors = await authorRepository.findAll(['books']); + +// identity map in action +console.log(jon === authors[0]); // true +``` + +If you want to clear this identity map cache, you can do so via `em.clear()` method: + +```typescript +orm.em.clear(); +``` + +You should always keep unique identity map per each request. This basically means that you need +to clone entity manager and use the clone in request context. There are two ways to achieve this: + +## Forking Entity Manager + +With `fork()` method you can simply get clean entity manager with its own context and identity map: + +```typescript +const em = orm.em.fork(); +``` + +## <a name="request-context"></a> RequestContext helper for DI containers + +If you use dependency injection container like `inversify` or the one in `nestjs` framework, it +can be hard to achieve this, because you usually want to access your repositories via DI container, +but it will always provide you with the same instance, rather than new one for each request. + +To solve this, you can use `RequestContext` helper, that will use `node`'s Domain API in the +background to isolate the request context. MikroORM will always use request specific (forked) +entity manager if available, so all you need to do is to create new request context preferably +as a middleware: + +```typescript +app.use((req, res, next) => { + RequestContext.create(orm.em, next); +}); +``` + +You should register this middleware as the last one just before request handlers and before +any of your custom middleware that is using the ORM. There might be issues when you register +it before request processing middleware like `queryParser` or `bodyParser`, so definitely +register the context after them. + +Later on you can then access the request scoped `EntityManager` via `RequestContext.getEntityManager()`. +This method is used under the hood automatically, so you should not need it. + +> `RequestContext.getEntityManager()` will return `undefinded` if the context was +> not started yet. + +## Why is Request Context needed? + +Imagine you will use single Identity Map throughout your application. It will be shared across +all request handlers, that can possibly run in parallel. + +### Problem 1 - growing memory footprint + +As there would be only one shared Identity Map, you can't just clear it after your request ends. +There can be another request working with it so clearing the Identity Map from one request could +break other requests running in parallel. This will result in growing memory footprint, as every +entity that became managed at some point in time would be kept in the Identity Map. + +### Problem 2 - unstable response of API endpoints + +Every entity has `toJSON()` method, that automatically converts it to serialized form. If you +have only one shared Identity Map, following situation may occur: + +Let's say there are 2 endpoints + +1. `GET /book/:id` that returns just the book, without populating anything +2. `GET /book-with-author/:id` that returns the book and its author populated + +Now when someone requests same book via both of those endpoints, you could end up with both +returning the same output: + +1. `GET /book/1` returns `Book` without populating its property `author` property +2. `GET /book-with-author/1` returns `Book`, this time with `author` populated +3. `GET /book/1` returns `Book`, but this time also with `author` populated + +This happens because the information about entity association being populated is stored in +the Identity Map. diff --git a/inheritance-mapping.md b/inheritance-mapping.md index 88e82c1..d77d04c 100644 --- a/inheritance-mapping.md +++ b/inheritance-mapping.md @@ -0,0 +1,228 @@ +--- +title: Inheritance Mapping +--- + +## Mapped Superclasses + +A mapped superclass is an abstract or concrete class that provides persistent entity state and +mapping information for its subclasses, but which is not itself an entity. Typically, the purpose +of such a mapped superclass is to define state and mapping information that is common to multiple +entity classes. + +Mapped superclasses, just as regular, non-mapped classes, can appear in the middle of an otherwise +mapped inheritance hierarchy (through Single Table Inheritance). + +> A mapped superclass cannot be an entity, it is not query-able and persistent relationships defined +> by a mapped superclass must be unidirectional (with an owning side only). This means that One-To-Many +> associations are not possible on a mapped superclass at all. Furthermore Many-To-Many associations +> are only possible if the mapped superclass is only used in exactly one entity at the moment. For +> further support of inheritance, the single table inheritance features have to be used. + +```typescript +// do not use @Entity decorator on base classes (mapped superclasses) +// we can also use @Entity({ abstract: true }) +export abstract class Person { + + @Property() + mapped1!: number; + + @Property() + mapped2!: string; + + @OneToOne() + toothbrush!: Toothbrush; + + // ... more fields and methods +} + +@Entity() +export class Employee extends Person { + + @PrimaryKey() + id!: number; + + @Property() + name!: string; + + // ... more fields and methods + +} + +@Entity() +export class Toothbrush { + + @PrimaryKey() + id!: number; + + // ... more fields and methods + +} +``` + +The DDL for the corresponding database schema would look something like this (this is for SQLite): + +```sql +create table `employee` ( + `id` int unsigned not null auto_increment primary key, + `name` varchar(255) not null, `mapped1` integer not null, + `mapped2` varchar(255) not null, + `toothbrush_id` integer not null +); +``` + +As you can see from this DDL snippet, there is only a single table for the entity +subclass. All the mappings from the mapped superclass were inherited to the subclass +as if they had been defined on that class directly. + +## Single Table Inheritance + +> Support for STI was added in version 4.0 + +[Single Table Inheritance](https://martinfowler.com/eaaCatalog/singleTableInheritance.html) +is an inheritance mapping strategy where all classes of a hierarchy are mapped to a single +database table. In order to distinguish which row represents which type in the hierarchy +a so-called discriminator column is used. + +```typescript +@Entity({ + discriminatorColumn: 'discr', + discriminatorMap: { person: 'Person', employee: 'Employee' }, +}) +export class Person { + // ... +} + +@Entity() +export class Employee extends Person { + // ... +} +``` + +Things to note: + +- The `discriminatorColumn` option must be specified on the topmost class that is + part of the mapped entity hierarchy. +- The `discriminatorMap` specifies which values of the discriminator column identify + a row as being of a certain type. In the case above a value of `person` identifies + a row as being of type `Person` and `employee` identifies a row as being of type + `Employee`. +- All entity classes that are part of the mapped entity hierarchy (including the topmost + class) should be specified in the `discriminatorMap`. In the case above `Person` class + included. +- We can use abstract class as the root entity - then the root class should not be part + of the discriminator map +- If no discriminator map is provided, then the map is generated automatically. + The automatically generated discriminator map contains the table names that would be + otherwise used in case of regular entities. + +### Using `discriminatorValue` instead of `discriminatorMap` + +As noted above, the discriminator map can be auto-generated. In that case, we might +want to control the tokens that will be used in the map. To do so, we can use +`discriminatorValue` on the child entities: + +```ts +@Entity({ + discriminatorColumn: 'discr', + discriminatorValue: 'person', +}) +export class Person { + // ... +} + +@Entity({ + discriminatorValue: 'employee', +}) +export class Employee extends Person { + // ... +} +``` + +### Explicit discriminator column + +The `discriminatorColumn` specifies the name of special column that will be used to +define what type of class should given row be represented with. It will be defined +automatically for you and it will stay hidden (it won't by hydrated as regular property). + +On the other hand, it is perfectly fine to define the column explicitly. Doing so, +you will be able to: + +- querying by the type, e.g. `em.find(Person, { type: { $ne: 'employee' } }` +- the column will be part of the serialized response + +Following example shows how we can define the discriminator explicitly, as well +as a version where root entity is abstract class. + +```ts +@Entity({ + discriminatorColumn: 'type', + discriminatorMap: { person: 'Person', employee: 'Employee' }, +}) +export abstract class BasePerson { + + @Enum() + type!: 'person' \| 'employee'; + +} + +@Entity() +export class Person extends BasePerson { + // ... +} + +@Entity() +export class Employee extends Person { + // ... +} +``` + +If we wanted to use `discriminatorValue` with abstract entities, we need to mark +the entity as `abstract: true` so it can be skipped from the discriminator map: + +```ts +@Entity({ + discriminatorColumn: 'type', + abstract: true, +}) +export abstract class BasePerson { + + @Enum() + type!: 'person' \| 'employee'; + +} + +@Entity({ discriminatorValue: 'person' }) +export class Person extends BasePerson { + // ... +} + +@Entity({ discriminatorValue: 'employee' }) +export class Employee extends Person { + // ... +} +``` + +### Design-time considerations + +This mapping approach works well when the type hierarchy is fairly simple and stable. +Adding a new type to the hierarchy and adding fields to existing supertypes simply +involves adding new columns to the table, though in large deployments this may have +an adverse impact on the index and column layout inside the database. + +### Performance impact + +This strategy is very efficient for querying across all types in the hierarchy or +for specific types. No table joins are required, only a WHERE clause listing the +type identifiers. In particular, relationships involving types that employ this +mapping strategy are very performing. + +### SQL Schema considerations + +For Single-Table-Inheritance to work in scenarios where you are using either a legacy +database schema or a self-written database schema you have to make sure that all +columns that are not in the root entity but in any of the different sub-entities +has to allow null values. Columns that have NOT NULL constraints have to be on the +root entity of the single-table inheritance hierarchy. + +> This part of documentation is highly inspired by [doctrine docs](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/inheritance-mapping.html) +> as the behaviour here is pretty much the same. diff --git a/installation.md b/installation.md index 413ba7e..3c2572a 100644 --- a/installation.md +++ b/installation.md @@ -0,0 +1,295 @@ +--- +title: Installation & Usage +--- + +First install the module via `yarn` or `npm` and do not forget to install the +driver package as well: + +> Since v4, you should install the driver package, but not the db connector itself, +> e.g. install `@mikro-orm/sqlite`, but not `sqlite3` as that is already included +> in the driver package. + +```sh +yarn add @mikro-orm/core @mikro-orm/mongodb # for mongo +yarn add @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/postgresql # for postgresql +yarn add @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +or + +```sh +npm i -s @mikro-orm/core @mikro-orm/mongodb # for mongo +npm i -s @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/postgresql # for postgresql +npm i -s @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +Next you will need to enable support for [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html) +as well as `esModuleInterop` in `tsconfig.json` via: + +```json +"experimentalDecorators": true, +"emitDecoratorMetadata": true, +"esModuleInterop": true, +``` + +Then call `MikroORM.init` as part of bootstrapping your app: + +```typescript +const orm = await MikroORM.init({ + entities: [Author, Book, BookTag], + dbName: 'my-db-name', + type: 'mongo', // one of `mongo` \| `mysql` \| `mariadb` \| `postgresql` \| `sqlite` + clientUrl: '...', // defaults to 'mongodb://localhost:27017' for mongodb driver +}); +console.log(orm.em); // access EntityManager via `em` property +``` + +> Read more about all the possible configuration options in [Advanced Configuration](configuration.md) section. + +We can also provide paths where you store your entities via `entities` array. Internally +it uses [`globby`](https://github.com/sindresorhus/globby) so we can use +[globbing patterns](https://github.com/sindresorhus/globby#globbing-patterns), +including negative globs. + +```typescript +const orm = await MikroORM.init({ + entities: ['./dist/app//entities'], + // ... +}); +``` + +If you are experiencing problems with folder based discovery, try using `mikro-orm debug` +CLI command to check what paths are actually being used. + +> Since v4, you can also use file globs, like `./dist/app//entities/.entity.js`. + +We can also set the configuration via [environment variables](configuration.md#using-environment-variables). + +> You can pass additional options to the underlying driver (e.g. `mysql2`) via `driverOptions`. +> The object will be deeply merged, overriding all internally used options. + +## Possible issues with circular dependencies + +Your entities will most probably contain circular dependencies (e.g. if you use bi-directional +relationship). While this is fine, there might be issues caused by wrong order of entities +during discovery, especially when you are using the folder based way. + +The errors caused by circular dependencies are usually similar to this one: + +``` +TypeError: Cannot read property 'name' of undefined + at Function.className (/path/to/project/node_modules/mikro-orm/dist/utils/Utils.js:253:28) + at TsMorphMetadataProvider.extractType (/path/to/project/node_modules/mikro-orm/dist/metadata/TsMorphMetadataProvider.js:37:34) + at TsMorphMetadataProvider.initProperties (/path/to/project/node_modules/mikro-orm/dist/metadata/TsMorphMetadataProvider.js:25:31) + at TsMorphMetadataProvider.loadEntityMetadata (/path/to/project/node_modules/mikro-orm/dist/metadata/TsMorphMetadataProvider.js:16:9) + at MetadataDiscovery.discoverEntity (/path/to/project/node_modules/mikro-orm/dist/metadata/MetadataDiscovery.js:109:9) + at MetadataDiscovery.discoverDirectory (/path/to/project/node_modules/mikro-orm/dist/metadata/MetadataDiscovery.js:80:13) + at Function.runSerial (/path/to/project/node_modules/mikro-orm/dist/utils/Utils.js:303:22) + at MetadataDiscovery.findEntities (/path/to/project/node_modules/mikro-orm/dist/metadata/MetadataDiscovery.js:56:13) + at MetadataDiscovery.discover (/path/to/project/node_modules/mikro-orm/dist/metadata/MetadataDiscovery.js:30:9) + at Function.init (/path/to/project/node_modules/mikro-orm/dist/MikroORM.js:45:24) + at Function.handleSchemaCommand (/path/to/project/node_modules/mikro-orm/dist/cli/SchemaCommandFactory.js:51:21) +``` + +If you encounter this, you have basically two options: + +- Use entity references in `entities` array to have control over the order of discovery. + You might need to play with the actual order you provide here, or possibly with the + order of import statements. +- Use strings instead of references (e.g. `@OneToMany('Book', 'author')`). The downside + here is that you will lose the typechecking capabilities of the decorators. + +## Entity Discovery in TypeScript + +In v4 the default metadata provider is `ReflectMetadataProvider`. If you want to use +`ts-morph` based discovery (that reads actual TS types via the compiler API), you +need to install `@mikro-orm/reflection`. + +```typescript +import { TsMorphMetadataProvider } from '@mikro-orm/reflection'; + +const orm = await MikroORM.init({ + metadataProvider: TsMorphMetadataProvider, + // ... +}); +``` + +Read more about the differences in [Metadata Providers section](metadata-providers.md). + +```typescript +const orm = await MikroORM.init({ + entities: ['./dist/entities//.js'], // path to your JS entities (dist), relative to `baseDir` + entitiesTs: ['./src/entities/*/.ts'], // path to your TS entities (source), relative to `baseDir` + // ... +}); +``` + +> It is important that `entities` will point to the compiled JS files, and `entitiesTs` +> will point to the TS source files. You should not mix those. + +> For `ts-morph` discovery to work in production, we need to deploy `.d.ts` declaration +> files. Be sure to enable `compilerOptions.declaration` in your `tsconfig.json`. + +You can also use different [metadata provider](metadata-providers.md) or even write custom one: + +- `ReflectMetadataProvider` that uses `reflect-metadata` instead of `ts-morph` +- `JavaScriptMetadataProvider` that allows you to manually provide the entity schema (mainly for Vanilla JS) + +> Using [`EntitySchema`](entity-schema.md) is another way to define your entities, which is better +> suited than using `JavaScriptMetadataProvider`. + +```typescript +const orm = await MikroORM.init({ + // default in v4, so not needed to specify explicitly + metadataProvider: ReflectMetadataProvider, + // ... +}); +``` + +## Request Context + +Then you will need to fork Entity Manager for each request so their identity maps will not +collide. To do so, use the `RequestContext` helper: + +```typescript +const app = express(); + +app.use((req, res, next) => { + RequestContext.create(orm.em, next); +}); +``` + +> If the `next` handler needs to be awaited (like in Koa), +> use `RequestContext.createAsync()` instead. +> +> ```typescript +> app.use((ctx, next) => RequestContext.createAsync(orm.em, next)); +> ``` + +More info about `RequestContext` is described [here](identity-map.md#request-context). + +## Setting up the Commandline Tool + +MikroORM ships with a number of command line tools that are very helpful during development, +like `SchemaGenerator` and `EntityGenerator`. You can call this command from the NPM binary +directory or use `npx`: + +> To work with the CLI, first install `@mikro-orm/cli` package locally. + +```sh +# manually +$ node node_modules/.bin/mikro-orm + +# via npx +$ npx mikro-orm + +# or via yarn +$ yarn mikro-orm +``` + +For CLI to be able to access your database, you will need to create `mikro-orm.config.js` file that +exports your ORM configuration. + +> Your ORM configuration file can export the Promise, like: +> `export default Promise.resolve({...});`. + +TypeScript is also supported, just enable `useTsNode` flag in your +`package.json` file. There you can also set up array of possible paths to `mikro-orm.config` file, +as well as use different file name: + +> Do not forget to install `ts-node` when enabling `useTsNode` flag. + +> The `useTsNode` is used only when executing the CLI, it is not respected when +> running your app. + +MikroORM will always try to load the first available config file, based on the +order in `configPaths`. This means that if you specify the first item as the TS +config, but you do not have `ts-node` enabled and installed, it will fail to +load it. + +```json title="./package.json" +{ + "name": "your-app", + "dependencies": { ... }, + "mikro-orm": { + "useTsNode": true, + "configPaths": [ + "./src/mikro-orm.config.ts", + "./dist/mikro-orm.config.js" + ] + } +} +``` + +```typescript title="./src/mikro-orm.config.ts" +export default { + entities: [Author, Book, BookTag], + dbName: 'my-db-name', + type: 'mongo', // one of `mongo` \| `mysql` \| `mariadb` \| `postgresql` \| `sqlite` +}; +``` + +When we have `useTsNode` disabled and `ts-node` is not already registered and detected, +TS config files will be ignored. + +Once you have the CLI config properly set up, you can omit the `MikroORM.init()` options +parameter, and the CLI config will be automatically used. This process may fail if you +use bundlers that use tree shaking. As the config file is not referenced anywhere +statically, it would not be compiled - for that the best approach is to provide the config +explicitly: + +```ts +import config from './mikro-orm.config'; +const orm = await MikroORM.init(config); +``` + +> You can also use different names for this file, simply rename it in the `configPaths` array +> your in `package.json`. You can also use `MIKRO_ORM_CLI` environment variable with the path +> to override `configPaths` value. + +Now you should be able to start using the CLI. All available commands are listed in the CLI help: + +```sh +Usage: mikro-orm <command> [options] + +Commands: + mikro-orm cache:clear Clear metadata cache + mikro-orm cache:generate Generate metadata cache for production + mikro-orm generate-entities Generate entities based on current database + schema + mikro-orm database:import <file> Imports the SQL file to the database + mikro-orm schema:create Create database schema based on current + metadata + mikro-orm schema:drop Drop database schema based on current + metadata + mikro-orm schema:update Update database schema based on current + metadata + mikro-orm migration:create Create new migration with current schema + diff + mikro-orm migration:up Migrate up to the latest version + mikro-orm migration:down Migrate one step down + mikro-orm migration:list List all executed migrations + mikro-orm migration:pending List all pending migrations + mikro-orm debug Debug CLI configuration + +Options: + -v, --version Show version number [boolean] + -h, --help Show help [boolean] + +Examples: + mikro-orm schema:update --run Runs schema synchronization +``` + +To verify your setup, you can use `mikro-orm debug` command. + +> When you have CLI config properly set up, you can omit the `options` parameter +> when calling `MikroORM.init()`. + +> Note: When importing a dump file you need `multipleStatements: true` in your +> configuration. Please check the configuration documentation for more information. + +Now you can start [defining your entities](defining-entities.md). diff --git a/json-properties.md b/json-properties.md index 5fc4a9b..af7a99b 100644 --- a/json-properties.md +++ b/json-properties.md @@ -0,0 +1,57 @@ +--- +title: Using JSON properties +--- + +## Defining JSON properties + +Each database driver behaves a bit differently when it comes to JSON properties. +MikroORM tries to unify the experience via [JsonType](custom-types.md#jsontype). +This type will be also used if you specify `type: 'json'`. + +```ts +@Entity() +export class Book { + + @Property({ type: 'json', nullable: true }) + meta?: { foo: string; bar: number }; + +} +``` + +## Querying by JSON object properties + +> Support for querying by JSON object properties was added in v4.4.2 + +We can query by JSON object properties easily: + +```ts +const b = await em.findOne(Book, { + meta: { + valid: true, + nested: { + foo: '123', + bar: 321, + deep: { + baz: 59, + qux: false, + }, + }, + }, +}); +``` + +Will produce following query (in postgres): + +```sql +select "e0".* +from "book" as "e0" +where ("meta"->>'valid')::bool = true + and "meta"->'nested'->>'foo' = '123' + and ("meta"->'nested'->>'bar')::float8 = 321 + and ("meta"->'nested'->'deep'->>'baz')::float8 = 59 + and ("meta"->'nested'->'deep'->>'qux')::bool = false +limit 1 +``` + +> All drivers are currently supported (including sqlite and mongo). In postgres we +> also try to cast the value if we detect number or boolean on the right-hand side. diff --git a/lifecycle-hooks.md b/lifecycle-hooks.md index e7dcf27..8aedd93 100644 --- a/lifecycle-hooks.md +++ b/lifecycle-hooks.md @@ -0,0 +1,218 @@ +--- +title: Lifecycle Hooks and EventSubscriber +sidebar_label: Hooks and Events +--- + +There are two ways to hook to the lifecycle of an entity: + +- Lifecycle hooks are methods defined on the entity prototype. +- EventSubscribers are classes that can be used to hook to multiple entities + or when you do not want to have the method present on the entity prototype. + +> Hooks are internally executed the same way as subscribers. + +> Hooks are executed before subscribers. + +## Hooks + +You can use lifecycle hooks to run some code when entity gets persisted. You can mark any of +entity methods with them, you can also mark multiple methods with same hook. + +All hooks support async methods with one exception - `@OnInit`. + +- `@OnInit` is fired when new instance of entity is created, either manually `em.create()`, or +automatically when new entities are loaded from database + +- `@BeforeCreate()` and `@BeforeUpdate()` is fired right before we persist the entity in database + +- `@AfterCreate()` and `@AfterUpdate()` is fired right after the entity is updated in database and +merged to identity map. Since this event entity will have reference to `EntityManager` and will be +enabled to call `wrap(entity).init()` method (including all entity references and collections). + +- `@BeforeDelete()` is fired right before we delete the record from database. It is fired only when +removing entity or entity reference, not when deleting records by query. + +- `@AfterDelete()` is fired right after the record gets deleted from database and it is unset from +the identity map. + +> `@OnInit` is not fired when you create the entity manually via its constructor (`new MyEntity()`) + +## Limitations of lifecycle hooks + +Hooks are executed inside the commit action of unit of work, after all change +sets are computed. This means that it is not possible to create new entities as +usual from inside the hook. Calling `em.flush()` from hooks will result in +validation error. Calling `em.persist()` can result in undefined behaviour like +locking errors. + +> The internal instance of `EntityManager` accessible under `wrap(this, true).__em` is +> not meant for public usage. + +## EventSubscriber + +Use `EventSubscriber` to hook to multiple entities or if you do not want to pollute +the entity prototype. All methods are optional, if you omit the `getSubscribedEntities()` +method, it means you are subscribing to all entities. + +You can either register the subscribers manually in the ORM configuration (via +`subscribers` array where you put the instance): + +```typescript +MikroORM.init({ + subscribers: [new AuthorSubscriber()], +}); +``` + +Or use `@Subscriber()` decorator - keep in mind that you need to make sure the file gets +loaded in order to make this decorator registration work (e.g. you import that file +explicitly somewhere). + +```typescript +import { EntityName, EventArgs, EventSubscriber, Subscriber } from '@mikro-orm/core'; + +@Subscriber() +export class AuthorSubscriber implements EventSubscriber<Author> { + + getSubscribedEntities(): EntityName<Author>[] { + return [Author]; + } + + async afterCreate(args: EventArgs<Author>): Promise<void> { + // ... + } + + async afterUpdate(args: EventArgs<Author>): Promise<void> { + // ... + } + +} +``` + +Another example, where we register to all the events and all entities: + +```typescript +import { EventArgs, EventSubscriber, Subscriber } from '@mikro-orm/core'; + +@Subscriber() +export class EverythingSubscriber implements EventSubscriber { + + async beforeCreate<T>(args: EventArgs<T>): Promise<void> { ... } + async afterCreate<T>(args: EventArgs<T>): Promise<void> { ... } + async beforeUpdate<T>(args: EventArgs<T>): Promise<void> { ... } + async afterUpdate<T>(args: EventArgs<T>): Promise<void> { ... } + async beforeDelete<T>(args: EventArgs<T>): Promise<void> { ... } + async afterDelete<T>(args: EventArgs<T>): Promise<void> { ... } + async beforeFlush<T>(args: EventArgs<T>): Promise<void> { ... } + async onFlush<T>(args: EventArgs<T>): Promise<void> { ... } + async afterFlush<T>(args: EventArgs<T>): Promise<void> { ... } + onInit<T>(args: EventArgs<T>): void { ... } + +} +``` + +## EventArgs + +As a parameter to the hook method we get `EventArgs` instance. It will always contain +reference to the current `EntityManager` and the particular entity. Events fired +from `UnitOfWork` during flush operation also contain the `ChangeSet` object. + +```typescript +interface EventArgs<T> { + entity: T; + em: EntityManager; + changeSet?: ChangeSet<T>; +} + +interface ChangeSet<T> { + name: string; // entity name + collection: string; // db table name + type: ChangeSetType; // type of operation + entity: T; // up to date entity instance + payload: EntityData<T>; // changes that will be used to build the update query + persisted: boolean; // whether the changeset was already persisted/executed + originalEntity?: EntityData<T>; // snapshot of the entity when it was loaded from db +} + +enum ChangeSetType { + CREATE = 'create', + UPDATE = 'update', + DELETE = 'delete', +} +``` + +## Flush events + +There is a special kind of events executed during the commit phase (flush operation). +They are executed before, during and after the flush, and they are not bound to any +entity in particular. + +- `beforeFlush` is executed before change sets are computed, this is the only + event where it is safe to persist new entities. +- `onFlush` is executed after the change sets are computed. +- `afterFlush` is executed as the last step just before the `flush` call resolves. + it will be executed even if there are no changes to be flushed. + +Flush event args will not contain any entity instance, as they are entity agnostic. +They do contain additional reference to the `UnitOfWork` instance. + +```typescript +interface FlushEventArgs extends Omit<EventArgs<unknown>, 'entity'> { + uow?: UnitOfWork; +} +``` + +> Flush events are entity agnostic, specifying `getSubscribedEntities()` method +> will not have any effect for those. They are fired only once per the `flush` +> operation. + +### Getting the changes from UnitOfWork + +You can observe all the changes that are part of given UnitOfWork via those methods: + +```typescript +UnitOfWork.getChangeSets(): ChangeSet<AnyEntity>[]; +UnitOfWork.getOriginalEntityData(): Map<string, EntityData<AnyEntity>>; +UnitOfWork.getPersistStack(): Set<AnyEntity>; +UnitOfWork.getRemoveStack(): Set<AnyEntity>; +UnitOfWork.getCollectionUpdates(): Collection<AnyEntity>[]; +UnitOfWork.getExtraUpdates(): Set<[AnyEntity, string, (AnyEntity \| Reference<AnyEntity>)]>; +``` + +### Using onFlush event + +In following example we have 2 entities: `FooBar` and `FooBaz`, connected via +M:1 relation. Our subscriber will automatically create new `FooBaz` entity and +connect it to the `FooBar` when we detect it in the change sets. + +We first use `uow.getChangeSets()` method to look up the change set of entity +we are interested in. After we create the `FooBaz` instance and link it with +`FooBar`, we need to do two things: + +1. Call `uow.computeChangeSet(baz)` to compute the change set of newly created + `FooBaz` entity +2. Call `uow.recomputeSingleChangeSet(cs.entity)` to recalculate the existing + change set of the `FooBar` entity. + +```typescript +@Subscriber() +export class FooBarSubscriber implements EventSubscriber { + + async onFlush(args: FlushEventArgs): Promise<void> { + const changeSets = args.uow.getChangeSets(); + const cs = changeSets.find(cs => cs.type === ChangeSetType.CREATE && cs.entity instanceof FooBar); + + if (cs) { + const baz = new FooBaz(); + baz.name = 'dynamic'; + cs.entity.baz = baz; + args.uow.computeChangeSet(baz); + args.uow.recomputeSingleChangeSet(cs.entity); + } + } + +} + +const bar = new FooBar(); +bar.name = 'bar'; +await em.persistAndFlush(bar); +``` diff --git a/loading-strategies.md b/loading-strategies.md index 04114ac..4dcb824 100644 --- a/loading-strategies.md +++ b/loading-strategies.md @@ -0,0 +1,85 @@ +--- +title: Relationship Loading Strategies +sidebar_label: Loading Strategies +--- + +> SQL only feature + +Controls how relationships get loaded when querying. By default, populated relationships +are loaded via the `select-in` strategy. This strategy issues one additional `SELECT` +statement per relation being loaded. + +The loading strategy can be specified both at mapping time and when loading entities. + +For example, given the following entities: + +```typescript +import { Entity, LoadStrategy, OneToMany, ManyToOne } from '@mikro-orm/core'; + +@Entity() +export class Author { + @OneToMany(() => Book, b => b.author) + books = new Collection<Book>(this); +} + +@Entity() +export class Book { + @ManyToOne() + author: Author; +} +``` + +The following will issue two SQL statements. +One to load the author and another to load all the books belonging to that author: + +```typescript +const author = await orm.em.findOne(Author, 1, ['books']); +``` + +If we update the `Author.books` mapping to the following: + +```typescript +import { Entity, LoadStrategy, OneToMany } from '@mikro-orm/core'; + +@Entity() +export class Author { + @OneToMany({ + entity: () => Book, + mappedBy: b => b.author, + strategy: LoadStrategy.JOINED, + }) + books = new Collection<Book>(this); +} +``` + +The following will issue one SQL statement: + +```typescript +const author = await orm.em.findOne(Author, 1, ['books']); +``` + +You can also specify the load strategy as needed. This will override whatever strategy is declared in the mapping. +This also works for nested populates: + +```typescript +// one level +const author = await orm.em.findOne(Author, 1, { populate: { books: LoadStrategy.JOINED } }); + +// two levels +const author = await orm.em.findOne(Author, 1, { populate: { + books: [LoadStrategy.JOINED, { publisher: LoadStrategy.JOINED }] +} }); +``` + +## Changing the loading strategy globally + +You can use `loadStrategy` option in the ORM config: + +```ts +MikroORM.init({ + loadStrategy: LoadStrategy.JOINED, +}); +``` + +This value will be used as the default, specifying the loading strategy on +property level has precedence, as well as specifying it in the `FindOptions`. diff --git a/metadata-cache.md b/metadata-cache.md index d5bb433..ab9e941 100644 --- a/metadata-cache.md +++ b/metadata-cache.md @@ -0,0 +1,87 @@ +--- +title: Metadata Cache +--- + +> In v4 you need to explicitly install `@mikro-orm/reflection` to use `TsMorphMetadataProvider`. + +Under the hood, `MikroORM` uses [`ts-morph`](https://github.com/dsherret/ts-morph) to read +TypeScript source files of all entities to be able to detect all types. Thanks to this, +defining the type is enough for runtime validation. + +If you use folder-based discovery, you should specify paths to +the compiled entities via `entities` as well as paths to the TS source files of +those entities via `entitiesTs`. When you run the ORM via `ts-node`, the latter +will be used automatically, or if you explicitly pass `tsNode: true` in the config. + +After the discovery process ends, all metadata will be cached. By default, `FileCacheAdapter` +will be used to store the cache inside `./temp` folder to JSON files. + +## Automatic Invalidation + +Entity metadata are cached together with modified time of the source file, and every time +the cache is requested, it first checks if the cache is not invalid. This way you can forgot +about the caching mechanism most of the time. + +One case where you can end up needing to wipe the cache manually is when you work withing a +git branch where contents of entities folder differs. + +## Disabling Metadata Cache + +You can disable caching via: + +```typescript +await MikroORM.init({ + cache: { enabled: false }, + // ... +}); +``` + +## Pretty Printing + +By default, cached metadata will be one line JSON string. You can force pretty printing it: + +```typescript +await MikroORM.init({ + cache: { pretty: true }, + // ... +}); +``` + +## Using Different temp Folder + +You can set the temp folder via: + +```typescript +await MikroORM.init({ + cache: { options: { cacheDir: '...' } }, + // ... +}); +``` + +## Providing Custom Cache Adapter + +You can also implement your own cache adapter, for example to store the cache in redis. +To do so, just implement simple `CacheAdapter` interface: + +```typescript +export interface CacheAdapter { + + get(name: string): any; + + set(name: string, data: any, origin: string): void; + +} +``` + +```typescript +export class RedisCacheAdapter implements CacheAdapter { ... } +``` + +And provide the implementation in `cache.adapter` option: + +```typescript +await MikroORM.init({ + cache: { adapter: RedisCacheAdapter, options: { ... } }, + // ... +}); +``` diff --git a/metadata-providers.md b/metadata-providers.md index a05327d..37f7668 100644 --- a/metadata-providers.md +++ b/metadata-providers.md @@ -0,0 +1,156 @@ +--- +title: Metadata Providers +--- + +As part of entity discovery process, MikroORM uses so called `MetadataProvider` to get necessary +type information about your entities' properties. There are 3 built-in metadata providers you can +use: + +> You can also implement custom metadata provider by extending abstract `MetadataProvider` class. + +## TsMorphMetadataProvider + +With `TsMorphMetadataProvider` MikroORM will use [`ts-morph`](https://github.com/dsherret/ts-morph) to read +TypeScript source files of all entities to be able to detect all types. Thanks to this, +defining the type is enough for runtime validation. + +To use it, first install the `@mikro-orm/reflection` package. + +```typescript +import { TsMorphMetadataProvider } from '@mikro-orm/reflection'; + +await MikroORM.init({ + metadataProvider: TsMorphMetadataProvider, + // ... +}); +``` + +If you use folder-based discovery, you should specify paths to +the compiled entities via `entities` as well as paths to the TS source files of +those entities via `entitiesTs`. When you run the ORM via `ts-node`, the latter +will be used automatically, or if you explicitly pass `tsNode: true` in the config. + +> When running via `node`, `.d.ts` files are used to obtain the type, so we +> need to ship them in the production build. TS source files are no longer +> needed (since v4). Be sure to enable `compilerOptions.declaration` in your +> `tsconfig.json`. + +After the discovery process ends, all [metadata will be cached](metadata-cache.md). By default, +`FileCacheAdapter` will be used to store the cache inside `./temp` folder in JSON files. + +> You can generate production cache via CLI command `mikro-orm cache:generate`. + +> You can implement custom cache adapter by implementing `CacheAdapter` interface. + +## ReflectMetadataProvider + +`ReflectMetadataProvider` uses `reflect-metadata` module to read the type from decorator +metadata exported by TypeScript compiler. + +You will need to install `reflect-metadata` module and import at the top of your app's +bootstrap script (e.g. `main.ts` or `app.ts`). + +```typescript +import 'reflect-metadata'; +``` + +Next step is to enable `emitDecoratorMetadata` flag in your `tsconfig.json`. + +> As this approach does not have performance impact, metadata caching is not really necessary. + +```typescript +await MikroORM.init({ + metadataProvider: ReflectMetadataProvider, + // ... +}); +``` + +### Limitations and requirements + +#### Explicit types + +Type inference is not supported, you need to always explicitly specify the type: + +```typescript +@Property() +createdAt: Date = new Date(); +``` + +#### Collection properties and Identified references + +You need to provide target entity type in `@OneToMany` and `@ManyToMany` decorators: + +```typescript +@OneToMany(() => Book, b => b.author) +books = new Collection<Book>(this); + +@ManyToOne(() => Publisher, { wrappedReference: true }) +publisher!: IdentifiedReference<Publisher>; +``` + +#### Optional properties + +Reading property nullability is not supported, you need to explicitly set `nullable` attribute: + +```typescript +@Property({ nullable: true }) +prop?: string; +``` + +#### Enums + +By default, enum is considered as numeric type. For string enums, you need to explicitly +provide one of: + +- reference to the enum (which will force you to define the enum before defining the entity) + ```typescript + @Enum(() => UserRole) + role: UserRole; + ``` +- name of the enum (if it is present in the same file) + ```typescript + @Enum({ type: 'UserRole' }) + role: UserRole; + ``` +- list of the enum items + ```typescript + @Enum({ items: ['a', 'b', 'c'] }) + role: UserRole; + ``` + +#### Circular dependencies + +Reading type of referenced entity in `@ManyToOne` and `@OneToOne` properties fails if there is +circular dependency. You will need to explicitly define the type in the decorator (preferably +via `entity: () => ...` callback). + +```typescript +@ManyToOne({ entity: () => Author }) +author: Author; +``` + +> There can be recursion issues when you define multiple entities (with circular dependencies +> between each other) in single file. In that case, you might want to provide the type via decorator's +> `type` or `entity` attributes and set the TS property type to something else (like `any` or `object`). + +#### Additional typings might be required + +You might have to install additional typings, one example is use of `ObjectId` in MongoDB, +which requires `@types/mongodb` to be installed. + +## JavaScriptMetadataProvider + +> `JavaScriptMetadataProvider` is deprecated, [use `EntitySchema` instead](entity-schema.md). + +This provider should be used only if you are not using TypeScript at all and therefore you do +not use decorators to annotate your properties. It will require you to specify the whole schema +manually. + +```typescript +await MikroORM.init({ + metadataProvider: JavaScriptMetadataProvider, + // ... +}); +``` + +You can read more about it in [Usage with JavaScript section](usage-with-js.md). diff --git a/multiple-schemas.md b/multiple-schemas.md index 418a20b..4886e65 100644 --- a/multiple-schemas.md +++ b/multiple-schemas.md @@ -0,0 +1,37 @@ +--- +title: Using Multiple Schemas +--- + +In MySQL and PostgreSQL is is possible to define your entities in multiple schemas. In MySQL +terminology, it is called database, but from implementation point of view, it is a schema. + +> To use multiple schemas, your connection needs to have access to all of them (multiple +> connections are not supported). + +All you need to do is simply define the table name including schema name in `collection` option: + +```typescript +@Entity({ tableName: 'first_schema.foo' }) +export class Foo { ... } + +@Entity({ tableName: 'second_schema.bar' }) +export class Bar { ... } +``` + +Then use those entities as usual. Resulting SQL queries will use this `tableName` value as a +table name so as long as your connection has access to given schema, everything should work +as expected. + +You can also query for entity in specific schema via `EntityManager`, `EntityRepository` or +`QueryBuilder`: + +```typescript +const user = await em.findOne(User, { ... }, { schema: 'client-123' }); +``` + +To create entity in specific schema, you will need to use `QueryBuilder`: + +```typescript +const qb = em.createQueryBuilder(User); +await qb.insert({ email: '[email protected]' }).withSchema('client-123'); +``` diff --git a/naming-strategy.md b/naming-strategy.md index 8aec535..c0cb3db 100644 --- a/naming-strategy.md +++ b/naming-strategy.md @@ -0,0 +1,98 @@ +--- +title: Naming Strategy +--- + +When mapping your entities to database tables and columns, their names will be defined by naming +strategy. There are 3 basic naming strategies you can choose from: + +- `UnderscoreNamingStrategy` - default of all SQL drivers +- `MongoNamingStrategy` - default of `MongoDriver` +- `EntityCaseNamingStrategy` - uses unchanged entity and property names + +You can override this when initializing ORM. You can also provide your own naming strategy, just +implement `NamingStrategy` interface and provide your implementation when bootstrapping ORM: + +```typescript +class YourCustomNamingStrategy implements NamingStrategy { + ... +} + +const orm = await MikroORM.init({ + ... + namingStrategy: YourCustomNamingStrategy, + ... +}); +``` + +> You can also extend `AbstractNamingStrategy` which implements one method for you - `getClassName()` +> that is used to map entity file name to class name. + +## Naming Strategy in mongo driver + +`MongoNamingStrategy` will simply use all field names as they are defined. Collection names will +be translated into lower-cased dashed form: + +`MyCoolEntity` will be translated into `my-cool-entity` collection name. + +## Naming Strategy in SQL drivers + +`MySqlDriver` defaults to `UnderscoreNamingStrategy`, which means your all your database tables and +columns will be lower-cased and words divided by underscored: + +```sql +CREATE TABLE `author` ( + `id` int(11) unsigned NOT NULL AUTO_INCREMENT, + `created_at` datetime(3) DEFAULT NULL, + `updated_at` datetime(3) DEFAULT NULL, + `terms_accepted` tinyint(1) DEFAULT NULL, + `name` varchar(255) DEFAULT NULL, + `email` varchar(255) DEFAULT NULL, + `born` datetime DEFAULT NULL, + `favourite_book_id` int(11) DEFAULT NULL, + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; +``` + +## NamingStrategy API + +#### `NamingStrategy.getClassName(file: string, separator?: string): string` + +Return a name of the class based on its file name. + +--- + +#### `NamingStrategy.classToTableName(entityName: string): string` + +Return a table name for an entity class. + +--- + +#### `NamingStrategy.propertyToColumnName(propertyName: string): string` + +Return a column name for a property. + +--- + +#### `NamingStrategy.referenceColumnName(): string` + +Return the default reference column name. + +--- + +#### `NamingStrategy.joinColumnName(propertyName: string): string` + +Return a join column name for a property. + +--- + +#### `NamingStrategy.joinTableName(sourceEntity: string, targetEntity: string, propertyName: string): string` + +Return a join table name. This is used as default value for `pivotTable`. + +--- + +#### `NamingStrategy.joinKeyColumnName(entityName: string, referencedColumnName?: string): string` + +Return the foreign key column name for the given parameters. + +--- diff --git a/nested-populate.md b/nested-populate.md index 7b197ab..caaedc7 100644 --- a/nested-populate.md +++ b/nested-populate.md @@ -0,0 +1,70 @@ +--- +title: Smart Nested Populate +--- + +`MikroORM` is capable of loading large nested structures while maintaining good +performance, querying each database table only once. Imagine you have this nested +structure: + +- `Book` has one `Publisher` (M:1), one `Author` (M:1) and many `BookTag`s (M:N) +- `Publisher` has many `Test`s (M:N) + +When you use nested populate while querying all `BookTag`s, this is what happens in +the background: + +```typescript +const tags = await orm.em.findAll(BookTag, ['books.publisher.tests', 'books.author']); +console.log(tags[0].books[0].publisher.tests[0].name); // prints name of nested test +console.log(tags[0].books[0].author.name); // prints name of nested author +``` + +1. Load all `BookTag`s +2. Load all `Book`s associated with previously loaded `BookTag`s +3. Load all `Publisher`s associated with previously loaded `Book`s +4. Load all `Test`s associated with previously loaded `Publisher`s +5. Load all `Author`s associated with previously loaded `Book`s + +> You can also populate all relationships by passing `populate: true`. + +For SQL drivers with pivot tables this means: + +```sql +SELECT `e0`.* FROM `book_tag` AS `e0`; + +SELECT `e0`., `e1`.`book_id`, `e1`.`book_tag_id` + FROM `book` AS `e0` LEFT JOIN `book_to_book_tag` AS `e1` ON `e0`.`id` = `e1`.`book_id` + WHERE `e1`.`book_tag_id` IN (?, ?, ?, ?, ?) + ORDER BY `e1`.`id` ASC; + +SELECT `e0`. FROM `publisher` AS `e0` WHERE `e0`.`id` IN (?, ?, ?); + +SELECT `e0`., `e1`.`test_id`, `e1`.`publisher_id` + FROM `test` AS `e0` LEFT JOIN `publisher_to_test` AS `e1` ON `e0`.`id` = `e1`.`test_id` + WHERE `e1`.`publisher_id` IN (?, ?, ?) + ORDER BY `e1`.`id` ASC; + +SELECT `e0`. FROM `author` AS `e0` WHERE `e0`.`id` IN (?); +``` + +For mongo driver its even simpler as no pivot tables are involved: + +```typescript +db.getCollection("book-tag").find({}).toArray(); +db.getCollection("book").find({"tags":{"$in":[...]}}).toArray(); +db.getCollection("publisher").find({"_id":{"$in":[...]}}).toArray(); +db.getCollection("test").find({"_id":{"$in":[...]}}).toArray(); +db.getCollection("author").find({"_id":{"$in":[...]}}).toArray(); +``` + +## Populating already loaded entities + +To populate existing entities, you can use `em.populate()`. + +```typescript +const authors = await orm.em.createQueryBuilder(Author).select('').getResult(); +await em.populate(authors, ['books.tags']); + +// now your Author entities will have `books` collections populated, +// as well as they will have their `tags` collections populated. +console.log(authors[0].books[0].tags[0]); // initialized BookTag +``` diff --git a/propagation.md b/propagation.md index 27a0357..3d33b74 100644 --- a/propagation.md +++ b/propagation.md @@ -0,0 +1,51 @@ +--- +title: Propagation +--- + +By default MikroORM will propagate all changes made to one side of bi-directional relations +to the other side, keeping them in sync. This works for all relations, including M:1 and 1:1. +As part of the discovery process, all M:1 and 1:1 properties are re-defined as getter/setter. + +```typescript +const author = new Author(...); +const book = new Book(...); +book.author = author; +console.log(author.books.contains(book)); // true +``` + +> You can disable this behaviour via `propagateToOneOwner` option. + +## Propagation of Collection's add() and remove() operations + +When you use one of `Collection.add()` method, the item is added to given collection, +and this action is also propagated to its counterpart. + +```typescript +// one to many +const author = new Author(...); +const book = new Book(...); + +author.books.add(book); +console.log(book.author); // author will be set thanks to the propagation +``` + +For M:N this works in both ways, either from owning side, or from inverse side. + +```typescript +// many to many works both from owning side and from inverse side +const book = new Book(...); +const tag = new BookTag(...); + +book.tags.add(tag); +console.log(tag.books.contains(book)); // true + +tag.books.add(book); +console.log(book.tags.contains(tag)); // true +``` + +> Collections on both sides have to be initialized, otherwise propagation won't work. + +> Although this propagation works also for M:N inverse side, you should always use owning +> side to manipulate the collection. + +Same applies for `Collection.remove()`. diff --git a/property-validation.md b/property-validation.md index 01d5a0b..efc4337 100644 --- a/property-validation.md +++ b/property-validation.md @@ -0,0 +1,51 @@ +--- +title: Property Validation +--- + +> Since v4.0.3 the validation needs to be explicitly enabled via `validate: true`. +> It has performance implications and usually should not be needed, as long as +> you don't modify your entities via `Object.assign()`. + +`MirkoORM` will validate your properties before actual persisting happens. It will try to fix wrong +data types for you automatically. If automatic conversion fails, it will throw an error. You can +enable strict mode to disable this feature and let ORM throw errors instead. Validation is triggered +when persisting the entity. + +```typescript +// number instead of string will throw +const author = new Author('test', 'test'); +wrap(author).assign({ name: 111, email: 222 }); +await orm.em.persistAndFlush(author); // throws "Validation error: trying to set Author.name of type 'string' to '111' of type 'number'" + +// string date with unknown format will throw +wrap(author).assign(author, { name: '333', email: '444', born: 'asd' }); +await orm.em.persistAndFlush(author); // throws "Validation error: trying to set Author.born of type 'date' to 'asd' of type 'string'" + +// string date with correct format will be auto-corrected +wrap(author).assign({ name: '333', email: '444', born: '2018-01-01' }); +await orm.em.persistAndFlush(author); +console.log(author.born).toBe(true); // instance of Date + +// Date object will be ok +wrap(author).assign({ born: new Date() }); +await orm.em.persistAndFlush(author); +console.log(author.born).toBe(true); // instance of Date + +// null will be ok +wrap(author).assign({ born: null }); +await orm.em.persistAndFlush(author); +console.log(author.born); // null + +// string number with correct format will be auto-corrected +wrap(author).assign({ age: '21' }); +await orm.em.persistAndFlush(author); +console.log(author.age); // number 21 + +// string instead of number with will throw +wrap(author).assign({ age: 'asd' }); +await orm.em.persistAndFlush(author); // throws "Validation error: trying to set Author.age of type 'number' to 'asd' of type 'string'" +wrap(author).assign({ age: new Date() }); +await orm.em.persistAndFlush(author); // throws "Validation error: trying to set Author.age of type 'number' to '2019-01-17T21:14:23.875Z' of type 'date'" +wrap(author).assign({ age: false }); +await orm.em.persistAndFlush(author); // throws "Validation error: trying to set Author.age of type 'number' to 'false' of type 'boolean'" +``` diff --git a/query-builder-api.md b/query-builder-api.md index 21ef832..fabcfb2 100644 --- a/query-builder-api.md +++ b/query-builder-api.md @@ -0,0 +1,50 @@ +--- +title: Query Builder API +--- + +`QueryBuilder` provides fluent interface with these methods: + +```typescript +select(fields: Field<T> \| Field<T>[], distinct?: boolean): QueryBuilder; +addSelect(fields: string \| string[]): QueryBuilder; +insert(data: any): QueryBuilder; +update(data: any): QueryBuilder; +delete(cond?: QBFilterQuery): QueryBuilder; +truncate(): QueryBuilder; +count(field?: string \| string[], distinct?: boolean): QueryBuilder; +join(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' \| 'innerJoin' \| 'pivotJoin', path?: string): QueryBuilder; +leftJoin(field: string, alias: string, cond?: QBFilterQuery): QueryBuilder; +withSubQuery(subQuery: KnexQueryBuilder, alias: string): QueryBuilder; +where(cond: QBFilterQuery<T>, operator?: keyof typeof GroupOperator): QueryBuilder; +where(cond: string, params?: any[], operator?: keyof typeof GroupOperator): QueryBuilder; +andWhere(cond: QBFilterQuery<T>): QueryBuilder; +andWhere(cond: string, params?: any[]): QueryBuilder; +orWhere(cond: QBFilterQuery<T>): QueryBuilder; +orWhere(cond: string, params?: any[]): QueryBuilder; +orderBy(orderBy: QueryOrderMap): QueryBuilder; +groupBy(fields: (string \| keyof T) \| (string \| keyof T)[]): QueryBuilder; +having(cond?: QBFilterQuery \| string, params?: any[]): QueryBuilder; +raw(sql: string): Raw; +limit(limit?: number, offset?: number): QueryBuilder; +offset(offset?: number): QueryBuilder; +withSchema(schema?: string): QueryBuilder; +setLockMode(mode?: LockMode): QueryBuilder; +setFlag(flag: QueryFlag): QueryBuilder; +unsetFlag(flag: QueryFlag): QueryBuilder; +getKnexQuery(): KnexQueryBuilder; +getQuery(): string; +getParams(): readonly Value[]; +getAliasForJoinPath(path: string): string \| undefined; +getNextAlias(prefix?: string): string; +execute<U = any>(method?: 'all' \| 'get' \| 'run', mapResults?: boolean): Promise<U>; +getResult(): Promise<T[]>; +getResultList(): Promise<T[]>; +getSingleResult(): Promise<T \| null>; +/* + * Returns knex instance with sub-query aliased with given alias. + * You can provide `EntityName.propName` as alias, then the field name will be used based on the metadata + / +as(alias: string): KnexQueryBuilder; +clone(): QueryBuilder<T>; +getKnex(): KnexQueryBuilder; +``` diff --git a/query-builder.md b/query-builder.md index c7cb09e..2c93337 100644 --- a/query-builder.md +++ b/query-builder.md @@ -0,0 +1,359 @@ +--- +title: Using Query Builder +--- + +:::info +Since v4, we need to make sure we are working with correctly typed `EntityManager` +or `EntityRepository` to have access to `createQueryBuilder()` method. + +```ts +import { EntityManager, EntityRepository } from '@mikro-orm/mysql'; // or any other driver package +``` +::: + +When you need to execute some SQL query without all the ORM stuff involved, you can either +compose the query yourself, or use the `QueryBuilder` helper to construct the query for you: + +```typescript +const qb = orm.em.createQueryBuilder(Author); +qb.update({ name: 'test 123', type: PublisherType.GLOBAL }).where({ id: 123, type: PublisherType.LOCAL }); + +console.log(qb.getQuery()); +// update `publisher2` set `name` = ?, `type` = ? where `id` = ? and `type` = ? + +console.log(qb.getParams()); +// ['test 123', PublisherType.GLOBAL, 123, PublisherType.LOCAL] + +// run the query +const res1 = await qb.execute(); +``` + +`QueryBuilder` also supports [smart query conditions](query-conditions.md). + +## Using Knex.js + +Under the hood, `QueryBuilder` uses [`Knex.js`](https://knexjs.org) to compose and run queries. +You can access configured `knex` instance via `qb.getKnexQuery()` method: + +```typescript +const qb = orm.em.createQueryBuilder(Author); +qb.update({ name: 'test 123', type: PublisherType.GLOBAL }).where({ id: 123, type: PublisherType.LOCAL }); +const knex = qb.getKnexQuery(); // instance of Knex' QueryBuilder + +// do what ever you need with `knex` + +const res = await orm.em.getConnection().execute(knex); +const entities = res.map(a => orm.em.map(Author, a)); +console.log(entities); // Author[] +``` + +You can also get clear and configured knex instance from the connection via `getKnex()` method. +As this method is not available on the base `Connection` class, you will need to either manually +type cast the connection to `AbstractSqlConnection` (or the actual implementation you are using, +e.g. `MySqlConnection`), or provide correct driver type hint to your `EntityManager` instance, +which will be then automatically inferred in `em.getConnection()` method. + +> Driver and connection implementations are not directly exported from `@mikro-orm/core` module. +> You can import them from the driver packages (e.g. `import { PostgreSqlDriver } from '@mikro-orm/postgresql'`). + +```typescript +const conn = orm.em.getConnection() as AbstractSqlConnection; +// you can make sure the `em` is correctly typed to `EntityManager<AbstractSqlDriver>` +// or one of its implementations: +// const em: EntityManager<AbstractSqlDriver> = orm.em; + +const knex = conn.getKnex(); + +// do what ever you need with `knex` + +const res = await knex; +``` + +## Running Native SQL Query + +You can run native SQL via underlying connection + +```typescript +const connection = orm.em.getConnection(); +const res = await connection.execute('select 1 as count'); +console.log(res); // res is array of objects: `[ { count: 1 } ]` +``` + +## Executing the Query + +You can use `execute(method = 'all', mapResults = true)`'s parameters to control form of result: + +```typescript +const res1 = await qb.execute('all'); // returns array of objects, default behavior +const res2 = await qb.execute('get'); // returns single object +const res3 = await qb.execute('run'); // returns object like `{ affectedRows: number, insertId: number, row: any }` +``` + +Second argument can be used to disable mapping of database columns to property names (which +is enabled by default). In following example, `Book` entity has `createdAt` property defined +with implicit underscored field name `created_at`: + +```typescript +const res4 = await orm.em.createQueryBuilder(Book).select('').execute('get', true); +console.log(res4); // `createdAt` will be defined, while `created_at` will be missing +const res5 = await orm.em.createQueryBuilder(Book).select('').execute('get', false); +console.log(res5); // `created_at` will be defined, while `createdAt` will be missing +``` + +To get entity instances from the QueryBuilder result, you can use `getResult()` and `getSingleResult()` +methods: + +```typescript +const book = await orm.em.createQueryBuilder(Book).select('').where({ id: 1 }).getSingleResult(); +console.log(book instanceof Book); // true +const books = await orm.em.createQueryBuilder(Book).select('').getResult(); +console.log(books[0] instanceof Book); // true +``` + +> You can also use `qb.getResultList()` which is alias to `qb.getResult()`. + +## Mapping Raw Results to Entities + +Another way to create entity from raw results (that are not necessarily mapped to entity properties) +is to use `map()` method of `EntityManager`, that is basically a shortcut for mapping results +via `IDatabaseDriver.mapResult()` (which converts field names to property names - e.g. `created_at` +to `createdAt`) and `merge()` which converts the data to entity instance and makes it managed. + +This method comes handy when you want to use 3rd party query builders, where the result is not +mapped to entity properties automatically: + +```typescript +const results = await knex.select('').from('users').where(knex.raw('id = ?', [id])); +const users = results.map(user => orm.em.map(User, user)); + +// or use EntityRepository.map() +const repo = orm.em.getRepository(User); +const users = results.map(user => repo.map(user)); +``` + +## Implicit Joining + +`QueryBuilder` supports automatic joining based on entity metadata: + +```typescript +const qb = orm.em.createQueryBuilder(BookTag, 't'); +qb.select('').where({ books: 123 }); + +console.log(qb.getQuery()); +// select `t`., `e1`.`book_tag_id`, `e1`.`book_uuid_pk` +// from `book_tag` as `t` +// left join `book_to_book_tag` as `e1` ON `t`.`id` = `e1`.`book_tag_id` +// where `e1`.`book_uuid_pk` = ? +``` + +This also works for multiple levels of nesting: + +```typescript +const qb = orm.em.createQueryBuilder(Author); +qb.select('') + .where({ books: { tags: { name: 'Cool' } } }) + .orderBy({ books: { tags: { createdBy: QueryOrder.DESC } } }); + +console.log(qb.getQuery()); +// select `e0`. +// from `author` as `e0` +// left join `book2` as `e1` on `e0`.`id` = `e1`.`author_id` +// left join `book2_to_book_tag2` as `e3` on `e1`.`uuid_pk` = `e3`.`book2_uuid_pk` +// left join `book_tag2` as `e2` on `e3`.`book_tag2_id` = `e2`.`id` +// where `e2`.`name` = ? +// order by `e1`.`tags` asc +``` + +This is currently available only for filtering (`where`) and sorting (`orderBy`), only +the root entity will be selected. To populate its relationships, you can use [`em.populate()`](nested-populate.md). + +## Explicit Joining + +Another way is to manually specify join property via `join()`/`leftJoin()` methods: + +```typescript +const qb = orm.em.createQueryBuilder(BookTag, 't'); +qb.select(['b.uuid', 'b.', 't.'], true) + .join('t.books', 'b') + .where({ 'b.title': 'test 123' }) + .limit(2, 1); + +console.log(qb.getQuery()); +// select distinct `b`.`uuid_pk`, `b`., `t`., `e1`.`book_tag_id`, `e1`.`book_uuid_pk` from `book_tag` as `t` +// join `book_to_book_tag` as `e1` ON `t`.`id` = `e1`.`book_tag_id` +// join `book` as `b` ON `e1`.`book_uuid_pk` = `b`.`uuid_pk` +// where `b`.`title` = ? +// limit ? offset ? +``` + +## Mapping joined results + +To select multiple entities and map them from `QueryBuilder`, we can use +`joinAndSelect` or `leftJoinAndSelect` method: + +```ts +// `res` will contain array of authors, with books and their tags populated +const res = await orm.em.createQueryBuilder(Author, 'a') + .select('') + .leftJoinAndSelect('a.books', 'b') + .leftJoinAndSelect('b.tags', 't') + .where({ 't.name': ['sick', 'sexy'] }) + .getResultList(); +``` + +## Complex Where Conditions + +There are multiple ways to construct complex query conditions. You can either write parts of SQL +manually, use `andWhere()`/`orWhere()`, or provide condition object: + +### Using custom SQL fragments + +It is possible to use any SQL fragment in your `WHERE` query or `ORDER BY` clause: + +```ts +const users = orm.em.createQueryBuilder(User) + .select('') + .where({ 'lower(email)': '[email protected]' }) + .orderBy({ [`(point(loc_latitude, loc_longitude) <@> point(0, 0))`]: 'ASC' }) + .getResultList(); +``` + +This will produce following query: + +```sql +select `e0`.* +from `user` as `e0` +where lower(email) = '[email protected]' +order by (point(loc_latitude, loclongitude) <@> point(0, 0)) asc +``` + +### Custom SQL in where + +```typescript +const qb = orm.em.createQueryBuilder(BookTag, 't'); +qb.select(['b.', 't.']) + .leftJoin('t.books', 'b') + .where('b.title = ? or b.title = ?', ['test 123', 'lol 321']) + .andWhere('1 = 1') + .orWhere('1 = 2') + .limit(2, 1); + +console.log(qb.getQuery()); +// select `b`., `t`., `e1`.`book_tag_id`, `e1`.`book_uuid_pk` from `book_tag` as `t` +// left join `book_to_book_tag` as `e1` ON `t`.`id` = `e1`.`book_tag_id` +// left join `book` as `b` ON `e1`.`book_uuid_pk` = `b`.`uuid_pk` +// where (((b.title = ? or b.title = ?) and (1 = 1)) or (1 = 2)) +// limit ? offset ? +``` + +### andWhere() and orWhere() + +```typescript +const qb = orm.em.createQueryBuilder(BookTag, 't'); +qb.select(['b.', 't.']) + .leftJoin('t.books', 'b') + .where('b.title = ? or b.title = ?', ['test 123', 'lol 321']) + .andWhere('1 = 1') + .orWhere('1 = 2') + .limit(2, 1); + +console.log(qb.getQuery()); +// select `b`., `t`., `e1`.`book_tag_id`, `e1`.`book_uuid_pk` from `book_tag` as `t` +// left join `book_to_book_tag` as `e1` ON `t`.`id` = `e1`.`book_tag_id` +// left join `book` as `b` ON `e1`.`book_uuid_pk` = `b`.`uuid_pk` +// where (((b.title = ? or b.title = ?) and (1 = 1)) or (1 = 2)) +// limit ? offset ? +``` + +### Conditions Object + +```typescript +const qb = orm.em.createQueryBuilder(Test); +qb.select('').where({ $and: [{ id: { $nin: [3, 4] } }, { id: { $gt: 2 } }] }); + +console.log(qb.getQuery()); +// select `e0`. from `test` as `e0` where (`e0`.`id` not in (?, ?) and `e0`.`id` > ?) +``` + +## Using sub-queries + +You can filter using sub-queries in where conditions: + +```typescript +const qb1 = orm.em.createQueryBuilder(Book2, 'b').select('b.author').where({ price: { $gt: 100 } }); +const qb2 = orm.em.createQueryBuilder(Author2, 'a').select('').where({ id: { $in: qb1.getKnexQuery() } }); + +console.log(qb2.getQuery()); +// select `a`. from `author2` as `a` where `a`.`id` in (select `b`.`author_id` from `book2` as `b` where `b`.`price` > ?) +``` + +For sub-queries in selects, use the `qb.as(alias)` method: + +> The dynamic property (`booksTotal`) needs to be defined at the entity level (as `persist: false`). + +```typescript +const knex = orm.em.getKnex(); +const qb1 = orm.em.createQueryBuilder(Book2, 'b').count('b.uuid', true).where({ author: knex.ref('a.id') }).as('Author2.booksTotal'); +const qb2 = orm.em.createQueryBuilder(Author2, 'a'); +qb2.select(['', qb1]).orderBy({ booksTotal: 'desc' }); + +console.log(qb2.getQuery()); +// select `a`., (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` order by `books_total` desc +``` + +```typescript +const knex = orm.em.getKnex(); +const qb3 = orm.em.createQueryBuilder(Book2, 'b').count('b.uuid', true).where({ author: knex.ref('a.id') }).as('books_total'); +const qb4 = orm.em.createQueryBuilder(Author2, 'a'); +qb4.select(['', qb3]).orderBy({ booksTotal: 'desc' }); + +console.log(qb4.getQuery()); +// select `a`., (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) as `books_total` from `author2` as `a` order by `books_total` desc +``` + +When you want to filter by sub-query on the left-hand side of a predicate, you will need to register it first via `qb.withSubquery()`: + +> The dynamic property (`booksTotal`) needs to be defined at the entity level (as `persist: false`). +> You always need to use prefix in the `qb.withSchema()` (so `a.booksTotal`). + +```typescript +const knex = orm.em.getKnex(); +const qb1 = orm.em.createQueryBuilder(Book2, 'b').count('b.uuid', true).where({ author: knex.ref('a.id') }).getKnexQuery(); +const qb2 = orm.em.createQueryBuilder(Author2, 'a'); +qb2.select('').withSubQuery(qb1, 'a.booksTotal').where({ 'a.booksTotal': { $in: [1, 2, 3] } }); + +console.log(qb2.getQuery()); +// select `a`. from `author2` as `a` where (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) in (?, ?, ?) +``` + +```typescript +const knex = orm.em.getKnex(); +const qb3 = orm.em.createQueryBuilder(Book2, 'b').count('b.uuid', true).where({ author: knex.ref('a.id') }).getKnexQuery(); +const qb4 = orm.em.createQueryBuilder(Author2, 'a'); +qb4.select('').withSubQuery(qb3, 'a.booksTotal').where({ 'a.booksTotal': 1 }); + +console.log(qb4.getQuery()); +// select `a`. from `author2` as `a` where (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) = ? +``` + +## Referring to column in update queries + +You can use `qb.raw()` to insert raw SQL snippets like this: + +```typescript +const qb = orm.em.createQueryBuilder(Book); +qb.update({ price: qb.raw('price + 1') }).where({ uuid: '123' }); + +console.log(qb.getQuery()); +// update `book` set `price` = price + 1 where `uuid_pk` = ? +``` + +## Locking support + +```typescript +const qb = orm.em.createQueryBuilder(Test); +qb.select('').where({ name: 'Lol 321' }).setLockMode(LockMode.PESSIMISTIC_READ); + +console.log(qb.getQuery()); // for MySQL +// select `e0`. from `test` as `e0` where `e0`.`name` = ? lock in share mode +``` diff --git a/query-conditions.md b/query-conditions.md index e49ffd4..9503047 100644 --- a/query-conditions.md +++ b/query-conditions.md @@ -0,0 +1,108 @@ +--- +title: Smart Query Conditions +--- + +When you want to make complex queries, you can easily end up with a lot of boilerplate code +full of curly brackets: + +```typescript +const res = await orm.em.find(Author, { $and: [ + { id: { $in: [1, 2, 7] }, }, + { id: { $nin: [3, 4] }, }, + { id: { $gt: 5 }, }, + { id: { $lt: 10 }, }, + { id: { $gte: 7 }, }, + { id: { $lte: 8 }, }, + { id: { $ne: 9 }, }, +] }); +``` + +For AND condition with single field, you can also do this: + +```typescript +const res = await orm.em.find(Author, { + id: { + $in: [1, 2, 7], + $nin: [3, 4], + $gt: 5, + $lt: 10, + $gte: 7, + $lte: 8, + $ne: 9, + }, +}); +``` + +Another way to do this by including the operator in your keys: + +> This approach is deprecated and will be removed in future versions. + +```typescript +const res = await orm.em.find(Author, { $and: [ + { 'id:in': [1, 2, 7] }, + { 'id:nin': [3, 4] }, + { 'id:gt': 5 }, + { 'id:lt': 10 }, + { 'id:gte': 7 }, + { 'id:lte': 8 }, + { 'id:ne': 9 }, +] }); +``` + +For comparison operators, you can also use their mathematical symbols: + +```typescript +const res = await orm.em.find(Author, { $and: [ + { 'id >': 5 }, + { 'id <': 10 }, + { 'id >=': 7 }, + { 'id <=': 8 }, + { 'id !=': 9 }, +] }); +``` + +> Keys with operators like this will cause TypeScript errors as there is no way to support +> them on the typings side. They are still supported, but you will need to cast the condition +> to `any` to use them. + +There is also shortcut for `$in` - simply provide array as value and it +will be converted automatically: + +```typescript +const res = await orm.em.find(Author, { favouriteBook: [1, 2, 7] }); +``` + +For primary key lookup, you can provide the array directly to `em.find()`: + +```typescript +const res = await orm.em.find(Author, [1, 2, 7]); +``` + +## List of supported operators + +### Comparison + +\| operator \| name \| description \| +\|----------\|--------------------\|-------------\| +\| `$eq` \| equals \| Matches values that are equal to a specified value. \| +\| `$gt` \| greater \| Matches values that are greater than a specified value. \| +\| `$gte` \| greater or equal \| Matches values that are greater than or equal to a specified value. \| +\| `$in` \| contains \| Matches any of the values specified in an array. \| +\| `$lt` \| lower \| Matches values that are less than a specified value. \| +\| `$lte` \| lower or equal \| Matches values that are less than or equal to a specified value. \| +\| `$ne` \| not equal \| Matches all values that are not equal to a specified value. \| +\| `$nin` \| not contains \| Matches none of the values specified in an array. \| +\| `$like` \| like \| Uses LIKE operator \| +\| `$re` \| regexp \| Uses REGEXP operator \| +\| `$ilike` \| ilike \| (postgres only) \| +\| `$overlap` \| && \| (postgres only) \| +\| `$contains` \| @> \| (postgres only) \| +\| `$contained` \| <@ \| (postgres only) \| + +### Logical + +\| operator \| description \| +\|----------\|-------------\| +\| `$and` \| Joins query clauses with a logical AND returns all documents that match the conditions of both clauses. \| +\| `$not` \| Inverts the effect of a query expression and returns documents that do not match the query expression. \| +\| `$or` \| Joins query clauses with a logical OR returns all documents that match the conditions of either clause. \| diff --git a/quick-start.md b/quick-start.md index 937319e..f4d9643 100644 --- a/quick-start.md +++ b/quick-start.md @@ -0,0 +1,192 @@ +--- +title: Quick Start +--- + +First install the module via `yarn` or `npm` and do not forget to install the +database driver as well: + +```sh +yarn add @mikro-orm/core @mikro-orm/mongodb # for mongo +yarn add @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/postgresql # for postgresql +yarn add @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +or + +```sh +npm i -s @mikro-orm/core @mikro-orm/mongodb # for mongo +npm i -s @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/postgresql # for postgresql +npm i -s @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +Next you will need to enable support for [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html) +as well as `esModuleInterop` in `tsconfig.json` via: + +```json +"experimentalDecorators": true, +"emitDecoratorMetadata": true, +"esModuleInterop": true +``` + +Then call `MikroORM.init` as part of bootstrapping your app: + +```typescript +const orm = await MikroORM.init({ + entities: ['./dist/entities'], // path to your JS entities (dist), relative to `baseDir` + dbName: 'my-db-name', + type: 'mongo', + clientUrl: '...', // defaults to 'mongodb://localhost:27017' for mongodb driver +}); +console.log(orm.em); // access EntityManager via `em` property +``` + +There are more ways to configure your entities, take a look at +[installation page](https://mikro-orm.io/installation/). + +> Read more about all the possible configuration options in [Advanced Configuration](https://mikro-orm.io/docs/configuration) section. + +Then you will need to fork entity manager for each request so their +[identity maps](https://mikro-orm.io/identity-map/) will not collide. +To do so, use the `RequestContext` helper: + +```typescript +const app = express(); + +app.use((req, res, next) => { + RequestContext.create(orm.em, next); +}); +``` + +> You should register this middleware as the last one just before request handlers and before +> any of your custom middleware that is using the ORM. There might be issues when you register +> it before request processing middleware like `queryParser` or `bodyParser`, so definitely +> register the context after them. + +More info about `RequestContext` is described [here](https://mikro-orm.io/identity-map/#request-context). + +Now you can start defining your entities (in one of the `entities` folders). This is how +simple entity can look like in mongo driver: + +```typescript title="./entities/MongoBook.ts" +@Entity() +export class MongoBook { + + @PrimaryKey() + _id: ObjectID; + + @SerializedPrimaryKey() + id: string; + + @Property() + title: string; + + @ManyToOne() + author: Author; + + @ManyToMany() + tags = new Collection<BookTag>(this); + + constructor(title: string, author: Author) { + this.title = title; + this.author = author; + } + +} +``` + +For SQL drivers, you can use `id: number` PK: + +```typescript title="./entities/SqlBook.ts" +@Entity() +export class SqlBook { + + @PrimaryKey() + id: number; + +} +``` + +Or if you want to use UUID primary keys: + +```typescript title="./entities/UuidBook.ts" +import { v4 } from 'uuid'; + +@Entity() +export class UuidBook { + + @PrimaryKey() + uuid = v4(); + +} +``` + +More information can be found in +[defining entities section](https://mikro-orm.io/defining-entities/) in docs. + +When you have your entities defined, you can start using ORM either via `EntityManager` +or via `EntityRepository`s. + +To save entity state to database, you need to persist it. Persist determines +whether to use `insert` or `update` and computes appropriate change-set. Entity references +that are not persisted yet (does not have identifier) will be cascade persisted automatically. + +```typescript +// use constructors in your entities for required parameters +const author = new Author('Jon Snow', '[email protected]'); +author.born = new Date(); + +const publisher = new Publisher('7K publisher'); + +const book1 = new Book('My Life on The Wall, part 1', author); +book1.publisher = publisher; +const book2 = new Book('My Life on The Wall, part 2', author); +book2.publisher = publisher; +const book3 = new Book('My Life on The Wall, part 3', author); +book3.publisher = publisher; + +// just persist books, author and publisher will be automatically cascade persisted +await orm.em.persistAndFlush([book1, book2, book3]); +``` + +To fetch entities from database you can use `find()` and `findOne()` of `EntityManager`: + +```typescript +const authors = orm.em.find(Author, {}); + +for (const author of authors) { + console.log(author); // instance of Author entity + console.log(author.name); // Jon Snow + + for (const book of author.books) { // iterating books collection + console.log(book); // instance of Book entity + console.log(book.title); // My Life on The Wall, part 1/2/3 + } +} +``` + +More convenient way of fetching entities from database is by using `EntityRepository`, that +carries the entity name so you do not have to pass it to every `find` and `findOne` calls: + +```typescript +const booksRepository = orm.em.getRepository(Book); + +// with sorting, limit and offset parameters, populating author references +const books = await booksRepository.find({ author: '...' }, ['author'], { title: QueryOrder.DESC }, 2, 1); + +// or with options object +const books = await booksRepository.find({ author: '...' }, { + populate: ['author'], + limit: 1, + offset: 2, + orderBy: { title: QueryOrder.DESC }, +}); + +console.log(books); // Book[] +``` + +Take a look at docs about [working with `EntityManager`](https://mikro-orm.io/entity-manager/) +or [using `EntityRepository` instead](https://mikro-orm.io/repositories/). diff --git a/read-connections.md b/read-connections.md index bb22eec..dbd6302 100644 --- a/read-connections.md +++ b/read-connections.md @@ -0,0 +1,43 @@ +--- +title: Read Replica Connections +--- + +Users can specify multiple read connections via `replicas` option. You can provide only fields +that differ from master connection, rest will be taken from it. + +```typescript +const orm = await MikroORM.init({ + entities: [Author, ...], + dbName: `my_database`, + type: 'mysql', + user: 'master_user', + host: 'master_host', + replicas: [ + { name: 'read-1', host: 'read_host_1', user: 'read_user' }, + { name: 'read-2', host: 'read_host_2' }, // user omitted, will be taken from master connection + ], +}); +``` + +By default select queries will use random read connection if not inside transaction. You can +specify connection type manually in `em.getConnection(type: 'read' \| 'write')`. + +```typescript +const connection = orm.em.getConnection(); // write connection +const readConnection = orm.em.getConnection('read'); // random read connection + +const qb1 = orm.em.createQueryBuilder(Author); +const res1 = await qb1.select('').execute(); // random read connection + +const qb2 = orm.em.createQueryBuilder(Author, 'a', 'write'); +const res2 = await qb2.select('').execute(); // write connection + +const qb3 = orm.em.createQueryBuilder(Author); +const res3 = await qb3.update(...).where(...).execute(); // write connection + +// all queries inside a transaction will use write connection +await orm.em.transactional(async em => { + const a = await em.findOne(Author, 1); // write connection + a.name = 'test'; // will trigger update on write connection once flushed +}); +``` diff --git a/relationships.md b/relationships.md index 76dbb36..54ca3dc 100644 --- a/relationships.md +++ b/relationships.md @@ -0,0 +1,172 @@ +--- +title: Modeling Entity Relationships +sidebar_label: Modeling Entity Relationships +--- + +There are 4 types of entity relationships in MikroORM: + +- ManyToOne +- OneToMany +- OneToOne +- ManyToMany + +Relations can be unidirectional and bidirectional. Unidirectional are defined only on one +side (the owning side). Bidirectional are defined on both sides, while one is owning side +(where references are store), marked by `inversedBy` attribute pointing to the inverse side. +On the inversed side we define it with `mappedBy` attribute pointing back to the owner: + +> When modeling bidirectional relationship, you can also omit the `inversedBy` attribute, +> defining `mappedBy` on the inverse side is enough as it will be auto-wired. + +## ManyToOne + +> Many instances of the current Entity refer to One instance of the referred Entity. + +There are multiple ways how to define the relationship, all of following is equivalent: + +```typescript +@Entity() +export class Book { + + @ManyToOne() // plain decorator is enough, type will be sniffer via reflection! + author1!: Author; + + @ManyToOne(() => Author) // you can specify type manually as a callback + author2!: Author; + + @ManyToOne('Author') // or as a string + author3!: Author; + + @ManyToOne({ entity: () => Author }) // or use options object + author4!: Author; + +} +``` + +You can also specify how operations on given entity should [cascade](cascading.md) +to the referred entity. + +## OneToMany + +> One instance of the current Entity has Many instances (references) to the referred Entity. + +Again, all of following is equivalent: + +```typescript +@Entity() +export class Author { + + @OneToMany(() => Book, book => book.author) + books1 = new Collection<Book>(this); + + @OneToMany('Book', 'author') + books2 = new Collection<Book>(this); + + @OneToMany({ mappedBy: book => book.author }) // referenced entity type can be sniffer too + books3 = new Collection<Book>(this); + + @OneToMany({ entity: () => Book, mappedBy: 'author', orphanRemoval: true }) + books4 = new Collection<Book>(this); + +} +``` + +As you can see, OneToMany is the inverse side of ManyToOne (which is the owning side). +More about how collections work can be found on [collections page](collections.md). + +You can also specify how operations on given entity should [cascade](cascading.md) to the referred +entities. There is also more aggressive remove mode called [Orphan Removal](cascading.md#orphan-removal) +(`books4` example). + +## OneToOne + +> One instance of the current Entity refers to One instance of the referred Entity. + +This is a variant of ManyToOne, where there is always just one entity on both sides. This means +that the foreign key column is also unique. + +### Owning Side + +```typescript +@Entity() +export class User { + + // when none of `owner/inverseBy/mappedBy` is provided, it will be considered owning side + @OneToOne() + bestFriend1!: User; + + // side with `inversedBy` is the owning one, to define inverse side use `mappedBy` + @OneToOne({ inversedBy: 'bestFriend1', orphanRemoval: true }) + bestFriend2!: User; + + // when defining it like this, you need to specifically mark the owning side with `owner: true` + @OneToOne(() => User, user => user.bestFriend2, { owner: true, orphanRemoval: true }) + bestFriend3!: User; + +} +``` + +### Inverse Side + +```typescript +@Entity() +export class User { + + @OneToOne({ mappedBy: 'bestFriend1' }) + bestFriend1!: User; + + @OneToOne(() => User, user => user.bestFriend2) + bestFriend2!: User; + +} +``` + +As you can see, relationships can be also self-referencing (all of them. OneToOne also supports +[Orphan Removal](cascading.md#orphan-removal). + +## ManyToMany + +> Many instances of the current Entity refers to Many instances of the referred Entity. + +Here are examples of how you can define ManyToMany relationship: + +### Owning Side + +```typescript +@Entity() +export class Book { + + // when none of `owner/inverseBy/mappedBy` is provided, it will be considered owning side + @ManyToMany() + tags1 = new Collection<BookTag>(this); + + @ManyToMany(() => BookTag, 'books', { owner: true }) + tags2 = new Collection<BookTag>(this); + + @ManyToMany(() => BookTag, 'books', { owner: true }) + tags3 = new Collection<BookTag>(this); + + @ManyToMany(() => BookTag, 'books', { owner: true }) + tags4 = new Collection<BookTag>(this); + + // to define uni-directional many to many, simply provide only + @ManyToMany(() => Author) + friends: Collection<Author> = new Collection<Author>(this); + +} +``` + +### Inverse Side + +```typescript +@Entity() +export class BookTag { + + // inverse side has to point to the owning side via `mappedBy` attribute/parameter + @ManyToMany(() => Book, book => book.tags) + books = new Collection<Book>(this); + +} +``` + +Again, more information about how collections work can be found on [collections page](collections.md). diff --git a/repositories-api.md b/repositories-api.md index d3bd85d..512bd96 100644 --- a/repositories-api.md +++ b/repositories-api.md @@ -0,0 +1,138 @@ +--- +title: EntityRepository API +--- + +#### `find(where: FilterQuery<T>, options?: FindOptions): Promise<T[]>` + +Returns array of entities found for given condition. You can specify `FindOptions` to request +population of referenced entities or control the pagination: + +```typescript +export interface FindOptions { + populate?: string[]; + orderBy?: { [k: string]: QueryOrder }; + limit?: number; + offset?: number; + schema?: string; +} +``` + +--- + +#### `find(where: FilterQuery<T>, populate?: string[], orderBy?: { [k: string]: QueryOrder }, limit?: number, offset?: number): Promise<T[]>` + +Same as previous `find` method, just with dedicated parameters for `populate`, `orderBy`, `limit` +and `offset`. + +--- + +#### `findAndCount(where: FilterQuery<T>, populate?: string[], orderBy?: { [k: string]: QueryOrder }, limit?: number, offset?: number): Promise<T[]>` + +Combination of `find` and `count` methods. + +--- + +#### `findAll(options?: FindOptions): Promise<T[]>` + +Returns all entities for given type. + +--- + +#### `findAll(populate?: string[], orderBy?: { [k: string]: QueryOrder }, limit?: number, offset?: number): Promise<T[]>` + +Same as previous `findAll` method, just with dedicated parameters for `populate`, `orderBy`, `limit` +and `offset`. + +--- + +#### `findOne(where: FilterQuery<T> \| string, populate?: string[]): Promise<T \| null>` + +Finds an entity by given `where` condition. You can use primary key as `where` value, then +if the entity is already managed, no database call will be made. + +--- + +#### `findOneOrFail(where: FilterQuery<T> \| string, populate?: string[]): Promise<T>` + +Just like `findOne`, but throws when entity not found, so it always resolves to given entity. +You can customize the error either globally via `findOneOrFailHandler` option, or locally via +`failHandler` option in `findOneOrFail` call. + +--- + +#### `merge(data: EntityData<T>): T` + +Adds given entity to current Identity Map. After merging, entity becomes managed. +This is useful when you want to work with cached entities. + +--- + +#### `getReference(id: string): T` + +Gets a reference to the entity identified by the given type and identifier without actually +loading it, if the entity is not yet loaded. + +--- + +#### `count(where?: FilterQuery<T>): Promise<number>` + +Gets count of entities matching the `where` condition. + +--- + +#### `persist(entity: AnyEntity \| AnyEntity[]): Promise<void>` + +Tells the EntityManager to make an instance managed and persistent. The entity will be +entered into the database at or before transaction commit or as a result of the flush +operation. + +--- + +#### `persistAndFlush(entity: AnyEntity \| AnyEntity[]): Promise<void>` + +Shortcut for `persist` & `flush`. + +--- + +#### `persistLater(entity: AnyEntity \| AnyEntity[]): void` + +Shortcut for just `persist`, without flushing. Deprecated, use `em.persist()`. + +--- + +#### `flush(): Promise<void>` + +Flushes all changes to objects that have been queued up to now to the database. + +--- + +#### `remove(where: AnyEntity \| Reference<AnyEntity> \| (AnyEntity \| Reference<AnyEntity>)[]): Promise<void>` + +It queues entity for removal when flush or commit is called. + +This method fires `beforeDelete` and `afterDelete` hooks. + +--- + +#### `removeAndFlush(entity: AnyEntity): Promise<void>` + +Shortcut for `remove` & `flush`. + +This method fires `beforeDelete` and `afterDelete` hooks. + +--- + +#### `removeLater(entity: AnyEntity): void` + +Shortcut for `remove` without flushing. Deprecated, use `em.remove()`. + +This method fires `beforeDelete` and `afterDelete` hooks. + +--- + +#### `canPopulate(property: string): boolean` + +Returns whether given entity has given property which can be populated (is reference or +collection). + +--- diff --git a/repositories.md b/repositories.md index 804e6aa..d33d23e 100644 --- a/repositories.md +++ b/repositories.md @@ -0,0 +1,91 @@ +--- +title: Using EntityRepository instead of EntityManager +sidebar_label: Entity Repository +--- + +More convenient way of fetching entities from database is by using `EntityRepository`, that +carries the entity name so you do not have to pass it to every `find` and `findOne` calls: + +Example: + +```typescript +const booksRepository = orm.em.getRepository(Book); + +// with sorting, limit and offset parameters, populating author references +const books = await booksRepository.find({ author: '...' }, ['author'], { title: QueryOrder.DESC }, 2, 1); + +// or with options object +const books = await booksRepository.find({ author: '...' }, { + populate: ['author'], + limit: 1, + offset: 2, + orderBy: { title: QueryOrder.DESC }, +}); + +console.log(books); // Book[] +``` + +## Custom Repository + +:::info +Since v4, we need to make sure we are working with correctly typed `EntityRepository` +to have access to driver specific methods (like `createQueryBuilder()`). Use the one +exported from your driver package. +::: + +To use custom repository, just extend `EntityRepository<T>` class: + +```typescript +import { EntityRepository } from '@mikro-orm/mysql'; // or any other driver package + +@Repository(Author) +export class CustomAuthorRepository extends EntityRepository<Author> { + + // your custom methods... + public findAndUpdate(...) { + // ... + } + +} +``` + +You can also omit the `@Repository` decorator and register your repository in `@Entity` +decorator instead: + +```typescript +@Entity({ customRepository: () => CustomAuthorRepository }) +export class Author { + // ... +} +``` + +Note that we need to pass that repository reference inside a callback so we will not run +into circular dependency issues when using entity references inside that repository. + +Now you can access your custom repository via `em.getRepository()` method. + +### Inferring custom repository type + +To have the `em.getRepository()` method return correctly typed custom repository +instead of the generic `EntityRepository<T>`, we can use `EntityRepositoryType` +symbol: + +```ts +@Entity({ customRepository: () => AuthorRepository }) +export class Author { + + [EntityRepositoryType]?: AuthorRepository; + +} + +const repo = em.getRepository(Author); // repo has type AuthorRepository +``` + +> You can also register custom base repository (for all entities where you do not specify +> `customRepository`) globally, via `MikroORM.init({ entityRepository: CustomBaseRepository })`. + +> Note that you cannot use both `@Repository(Author)` on the repository and `{ customRepository: () => AuthorRepository }` on the entity at the same time. This will cause a circular dependency and throws an error. Either one of options achieves the same goal. + +For more examples, take a look at +[`tests/EntityManager.mongo.test.ts`](https://github.com/mikro-orm/mikro-orm/blob/master/tests/EntityManager.mongo.test.ts) +or [`tests/EntityManager.mysql.test.ts`](https://github.com/mikro-orm/mikro-orm/blob/master/tests/EntityManager.mysql.test.ts). diff --git a/schema-generator.md b/schema-generator.md index d16d42f..aa0df22 100644 --- a/schema-generator.md +++ b/schema-generator.md @@ -0,0 +1,92 @@ +--- +title: Schema Generator +--- + +> SchemaGenerator can do harm to your database. It will drop or alter tables, indexes, +> sequences and such. Please use this tool with caution in development and not on a +> production server. It is meant for helping you develop your Database Schema, but NOT +> with migrating schema from A to B in production. A safe approach would be generating +> the SQL on development server and saving it into SQL Migration files that are executed +> manually on the production server. + +> SchemaTool assumes your project uses the given database on its own. Update and Drop +> commands will mess with other tables if they are not related to the current project +> that is using MikroORM. Please be careful! + +To generate schema from your entity metadata, you can use `SchemaGenerator` helper. + +You can use it via CLI: + +```sh +npx mikro-orm schema:create --dump # Dumps create schema SQL +npx mikro-orm schema:update --dump # Dumps update schema SQL +npx mikro-orm schema:drop --dump # Dumps drop schema SQL +``` + +> You can also use `--run` flag to fire all queries, but be careful as it might break your +> database. Be sure to always check the generated SQL first before executing. Do not use +> `--run` flag in production! + +`schema:create` will automatically create the database if it does not exist. + +`schema:update` drops all unknown tables by default, you can use `--no-drop-tables` +to get around it. There is also `--safe` flag that will disable both table dropping as +well as column dropping. + +`schema:drop` will by default drop all database tables. You can use `--drop-db` flag to drop +the whole database instead. + +## Using SchemaGenerator programmatically + +Or you can create simple script where you initialize MikroORM like this: + +```typescript title="./create-schema.ts" +import { MikroORM } from '@mikro-orm/core'; + +(async () => { + const orm = await MikroORM.init({ + entities: [Author, Book, ...], + dbName: 'your-db-name', + // ... + }); + const generator = orm.getSchemaGenerator(); + + const dropDump = await generator.getDropSchemaSQL(); + console.log(dropDump); + + const createDump = await generator.getCreateSchemaSQL(); + console.log(createDump); + + const updateDump = await generator.getUpdateSchemaSQL(); + console.log(updateDump); + + // there is also `generate()` method that returns drop + create queries + const dropAndCreateDump = await generator.generate(); + console.log(dropAndCreateDump); + + // or you can run those queries directly, but be sure to check them first! + await generator.dropSchema(); + await generator.createSchema(); + await generator.updateSchema(); + + await orm.close(true); +})(); +``` + +Then run this script via `ts-node` (or compile it to plain JS and use `node`): + +```sh +$ ts-node create-schema +``` + +## Limitations of SQLite + +There are limitations of SQLite database because of which it behaves differently +than other SQL drivers. Namely, it is not possible to: + +- create foreign key constraints when altering columns +- create empty tables without columns +- alter column requires nullability + +Because of this, you can end up with different schema with SQLite, so it is not +suggested to use SQLite for integration tests of your application. diff --git a/serializing.md b/serializing.md index 292b00c..2272009 100644 --- a/serializing.md +++ b/serializing.md @@ -0,0 +1,102 @@ +--- +title: Serializing +--- + +By default, all entities are monkey patched with `toObject()` and `toJSON` methods: + +```typescript +export interface AnyEntity<K = number \| string> { + toObject(parent?: AnyEntity, isCollection?: boolean): Record<string, any>; + toJSON(...args: any[]): Record<string, any>; + // ... +} +``` + +When you serialize your entity via `JSON.stringify(entity)`, its `toJSON` method will be +called automatically. You can provide custom implementation for `toJSON`, while using +`toObject` for initial serialization: + +```typescript +@Entity() +export class Book { + + // ... + + toJSON(strict = true, strip = ['id', 'email'], ...args: any[]): { [p: string]: any } { + const o = wrap(this, true).toObject(...args); // do not forget to pass rest params here + + if (strict) { + strip.forEach(k => delete o[k]); + } + + return o; + } + +} +``` + +> Do not forget to pass rest params when calling `toObject(...args)`, otherwise the results +> might not be stable. + +## Hidden Properties + +If you want to omit some properties from serialized result, you can mark them with `hidden` +flag on `@Property()` decorator: + +```typescript +@Entity() +export class Book { + + @Property({ hidden: true }) + hiddenField = Date.now(); + +} + +const book = new Book(...); +console.log(wrap(book).toObject().hiddenField); // undefined +console.log(wrap(book).toJSON().hiddenField); // undefined +``` + +## Shadow Properties + +The opposite situation where you want to define a property that lives only in memory (is +not persisted into database) can be solved by defining your property as `persist: false`. +Such property can be assigned via one of `Entity.assign()`, `em.create()` and +`em.merge()`. It will be also part of serialized result. + +This can be handle when dealing with additional values selected via `QueryBuilder` or +MongoDB's aggregations. + +```typescript +@Entity() +export class Book { + + @Property({ persist: false }) + count?: number; + +} + +const book = new Book(...); +wrap(book).assign({ count: 123 }); +console.log(wrap(book).toObject().count); // 123 +console.log(wrap(book).toJSON().count); // 123 +``` + +## Property Serializers + +As an alternative to custom `toJSON()` method, we can also use property serializers. +They allow to specify a callback that will be used when serializing a property: + +```typescript +@Entity() +export class Book { + + @ManyToOne({ serializer: value => value.name, serializedName: 'authorName' }) + author: Author; + +} + +const author = new Author('God') +const book = new Book(author); +console.log(wrap(book).toJSON().authorName); // 'God' +``` diff --git a/transactions.md b/transactions.md index bdb8237..8e92bb1 100644 --- a/transactions.md +++ b/transactions.md @@ -0,0 +1,296 @@ +--- +title: Transactions and Concurrency +--- + +> Starting v3.4, transactions are also supported in [MongoDB driver](usage-with-mongo.md). + +## Transaction Demarcation + +Transaction demarcation is the task of defining your transaction boundaries. Proper +transaction demarcation is very important because if not done properly it can negatively +affect the performance of your application. Many databases and database abstraction +layers by default operate in auto-commit mode, which means that every single SQL statement +is wrapped in a small transaction. Without any explicit transaction demarcation from your +side, this quickly results in poor performance because transactions are not cheap. + +For the most part, MikroORM already takes care of proper transaction demarcation for you: +All the write operations (INSERT/UPDATE/DELETE) are queued until `em.flush()` +is invoked which wraps all of these changes in a single transaction. + +However, MikroORM also allows (and encourages) you to take over and control transaction +demarcation yourself. + +These are two ways to deal with transactions when using the MikroORM and are now described +in more detail. + +### Approach 1: Implicitly + +The first approach is to use the implicit transaction handling provided by the MikroORM +`EntityManager`. Given the following code snippet, without any explicit transaction +demarcation: + +```typescript +const user = new User(...); +user.name = 'George'; +await orm.em.persistAndFlush(user); +``` + +Since we do not do any custom transaction demarcation in the above code, `em.flush()` +will begin and commit/rollback a transaction. This behavior is made possible by the +aggregation of the DML operations by the MikroORM and is sufficient if all the data +manipulation that is part of a unit of work happens through the domain model and thus +the ORM. + +### Approach 2: Explicitly + +The explicit alternative is to use the transactions API directly to control the boundaries. +The code then looks like this: + +```typescript +await orm.em.transactional(em => { + //... do some work + const user = new User(...); + user.name = 'George'; + em.persist(user); +}); +``` + +Or you can use `begin/commit/rollback` methods explicitly. Following example is +equivalent to the previous one: + +```typescript +const em = orm.em.fork(false); +await em.begin(); + +try { + //... do some work + const user = new User(...); + user.name = 'George'; + em.persist(user); + await em.commit(); // will flush before making the actual commit query +} catch (e) { + await em.rollback(); + throw e; +} +``` + +Explicit transaction demarcation is required when you want to include custom DBAL operations +in a unit of work or when you want to make use of some methods of the EntityManager API +that require an active transaction. Such methods will throw a `ValidationError` to inform +you of that requirement. + +`em.transactional(cb)` will flush the inner `EntityManager` prior to transaction commit. + +### Exception Handling + +When using implicit transaction demarcation and an exception occurs during +`em.flush()`, the transaction is automatically rolled back. + +When using explicit transaction demarcation and an exception occurs, the transaction should +be rolled back immediately as demonstrated in the example above. This can be handled elegantly +by the control abstractions shown earlier. Note that when catching Exception you should +generally re-throw the exception. If you intend to recover from some exceptions, catch them +explicitly in earlier catch blocks (but do not forget to rollback the transaction). All +other best practices of exception handling apply similarly (i.e. either log or re-throw, +not both, etc.). + +As a result of this procedure, all previously managed or removed instances of the `EntityManager` +become detached. The state of the detached objects will be the state at the point at which the +transaction was rolled back. The state of the objects is in no way rolled back and thus the +objects are now out of sync with the database. The application can continue to use the detached +objects, knowing that their state is potentially no longer accurate. + +If you intend to start another unit of work after an exception has occurred you should do +that with a new `EntityManager`. Simply use `em.fork()` to obtain fresh copy +with cleared identity map. + +## Locking Support + +### Why we need concurrency control? + +If transactions are executed serially (one at a time), no transaction concurrency exists. +However, if concurrent transactions with interleaving operations are allowed, you may easily +run into one of those problems: + +1. The lost update problem +2. The dirty read problem +3. The incorrect summary problem + +To mitigate those problems, MikroORM offers support for Pessimistic and Optimistic locking +strategies natively. This allows you to take very fine-grained control over what kind of +locking is required for your entities in your application. + +### Optimistic Locking + +Database transactions are fine for concurrency control during a single request. However, a +database transaction should not span across requests, the so-called "user think time". Therefore +a long-running "business transaction" that spans multiple requests needs to involve several +database transactions. Thus, database transactions alone can no longer control concurrency +during such a long-running business transaction. Concurrency control becomes the partial +responsibility of the application itself. + +MikroORM has integrated support for automatic optimistic locking via a version field. In +this approach any entity that should be protected against concurrent modifications during +long-running business transactions gets a version field that is either a simple number +(mapping type: integer) or a timestamp (mapping type: datetime). When changes to such an +entity are persisted at the end of a long-running conversation the version of the entity +is compared to the version in the database and if they don't match, a `ValidationError` +is thrown, indicating that the entity has been modified by someone else already. + +You designate a version field in an entity as follows. In this example we'll use an integer. + +```typescript +export class User { + // ... + @Property({ version: true }) + version!: number; + // ... +} +``` + +Alternatively a datetime type can be used (which maps to a SQL timestamp or datetime): + +```typescript +export class User { + // ... + @Property({ version: true }) + version!: Date; + // ... +} +``` + +Version numbers (not timestamps) should however be preferred as they can not potentially +conflict in a highly concurrent environment, unlike timestamps where this is a possibility, +depending on the resolution of the timestamp on the particular database platform. + +When a version conflict is encountered during `em.flush()`, a `ValidationError` +is thrown and the active transaction rolled back (or marked for rollback). This exception +can be caught and handled. Potential responses to a `ValidationError` are to present the +conflict to the user or to refresh or reload objects in a new transaction and then retrying +the transaction. + +The time between showing an update form and actually modifying the entity can in the worst +scenario be as long as your applications session timeout. If changes happen to the entity +in that time frame you want to know directly when retrieving the entity that you will hit +an optimistic locking exception: + +You can always verify the version of an entity during a request either when calling +`em.findOne()`: + +```typescript +const theEntityId = 1; +const expectedVersion = 184; + +try { + const entity = await orm.em.findOne(User, theEntityId, { lockMode: LockMode.OPTIMISTIC, lockVersion: expectedVersion }); + + // do the work + + await orm.em.flush(); +} catch (e) { + console.log('Sorry, but someone else has already changed this entity. Please apply the changes again!'); +} +``` + +Or you can use `em.lock()` to find out: + +```typescript +const theEntityId = 1; +const expectedVersion = 184; +const entity = await orm.em.findOne(User, theEntityId); + +try { + // assert version + await orm.em.lock(entity, LockMode.OPTIMISTIC, expectedVersion); +} catch (e) { + console.log('Sorry, but someone else has already changed this entity. Please apply the changes again!'); +} +``` + +#### Important Implementation Notes + +You can easily get the optimistic locking workflow wrong if you compare the wrong versions. +Say you have Alice and Bob editing a hypothetical blog post: + +- Alice reads the headline of the blog post being "Foo", at optimistic lock version 1 (GET Request) +- Bob reads the headline of the blog post being "Foo", at optimistic lock version 1 (GET Request) +- Bob updates the headline to "Bar", upgrading the optimistic lock version to 2 (POST Request of a Form) +- Alice updates the headline to "Baz", ... (POST Request of a Form) + +Now at the last stage of this scenario the blog post has to be read again from the database +before Alice's headline can be applied. At this point you will want to check if the blog +post is still at version 1 (which it is not in this scenario). + +Using optimistic locking correctly, you have to add the version as an additional hidden +field (or into the session for more safety). Otherwise you cannot verify the version is still +the one being originally read from the database when Alice performed her GET request for the +blog post. If this happens you might see lost updates you wanted to prevent with Optimistic +Locking. + +See the example code (frontend): + +```typescript +const res = await fetch('api.example.com/book/123'); +const book = res.json(); +console.log(book.version); // prints the current version + +// user does some changes and calls the PUT handler +const changes = { title: 'new title' }; +await fetch('api.example.com/book/123', { + method: 'PUT', + body: { + ...changes, + version: book.version, + }, +}); +``` + +And the corresponding API endpoints: + +```typescript +// GET /book/:id +async findOne(req, res) { + const book = await this.em.findOne(Book, +req.query.id); + res.json(book); +} + +// PUT /book/:id +async update(req, res) { + const book = await this.em.findOne(Book, +req.query.id, { lockMode: LockMode.OPTIMISTIC, lockVersion: req.body.version }); + wrap(book).assign(req.body); + await this.em.flush(); + + res.json(book); +} +``` + +Your frontend app loads an entity from API, the response includes the version property. +User makes some changes and fires PUT request back to the API, with version field included +in the payload. The PUT handler of the API then reads the version and passes it to the +`em.findOne()` call. + +### Pessimistic Locking + +MikroORM supports Pessimistic Locking at the database level. No attempt is being made to implement +pessimistic locking inside MikroORM, rather vendor-specific and ANSI-SQL commands are used to +acquire row-level locks. Every Entity can be part of a pessimistic lock, there is no special +metadata required to use this feature. + +However for Pessimistic Locking to work you have to disable the Auto-Commit Mode of your Database +and start a transaction around your pessimistic lock use-case using the "Approach 2: Explicit +Transaction Demarcation" described above. MikroORM will throw an Exception if you attempt to +acquire an pessimistic lock and no transaction is running. + +MikroORM currently supports two pessimistic lock modes: + +- Pessimistic Write (`LockMode.PESSIMISTIC_WRITE`), locks the underlying database rows for concurrent Read and Write Operations. +- Pessimistic Read (`LockMode.PESSIMISTIC_READ`), locks other concurrent requests that attempt to update or lock rows in write mode. + +You can use pessimistic locks in three different scenarios: + +1. Using `em.findOne(className, id, { lockMode: LockMode.PESSIMISTIC_WRITE })` or `em.findOne(className, id, { lockMode: LockMode.PESSIMISTIC_READ })` +2. Using `em.lock(entity, LockMode.PESSIMISTIC_WRITE)` or `em.lock(entity, LockMode.PESSIMISTIC_READ)` +3. Using `QueryBuilder.setLockMode(LockMode.PESSIMISTIC_WRITE)` or `QueryBuilder.setLockMode(LockMode.PESSIMISTIC_READ)` + +> This part of documentation is highly inspired by [doctrine internals docs](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/transactions-and-concurrency.html) +> as the behaviour here is pretty much the same. diff --git a/unit-of-work.md b/unit-of-work.md index ae110b5..100dc54 100644 --- a/unit-of-work.md +++ b/unit-of-work.md @@ -0,0 +1,104 @@ +--- +title: Unit of Work and Transactions +sidebar_label: Unit of Work +--- + +MikroORM uses the Identity Map pattern to track objects. Whenever you fetch an object from +the database, MikroORM will keep a reference to this object inside its `UnitOfWork`. + +This allows MikroORM room for optimizations. If you call the EntityManager and ask for an +entity with a specific ID twice, it will return the same instance: + +```typescript +const authorRepository = orm.em.getRepository(Author); +const jon1 = await authorRepository.findOne(1); +const jon2 = await authorRepository.findOne(1); + +// identity map in action +console.log(jon1 === jon2); // true +``` + +Only one SELECT query will be fired against the database here. In the second `findOne()` +call MikroORM will check the identity map first and will skip the database round trip as +it will find the entity already loaded. + +The identity map being indexed by primary keys only allows shortcuts when you ask for objects +by primary key. When you query by other properties, you will still get the same reference, +but two separate database calls will be made: + +```typescript +const authorRepository = orm.em.getRepository(Author); +const jon1 = await authorRepository.findOne({ name: 'Jon Snow' }); +const jon2 = await authorRepository.findOne({ name: 'Jon Snow' }); + +// identity map in action +console.log(jon1 === jon2); // true +``` + +MikroORM only knows objects by id, so a query for different criteria has to go to the database, +even if it was executed just before. But instead of creating a second `Author` object MikroORM +first gets the primary key from the row and checks if it already has an object inside the +`UnitOfWork` with that primary key. + +## Persisting Managed Entities + +The identity map has a second use-case. When you call `em.flush()`, MikroORM will +ask the identity map for all objects that are currently managed. This means you don't have to +call `em.persist()` over and over again to pass known objects to the +`EntityManager`. This is a NO-OP for known entities, but leads to much code written that is +confusing to other developers. + +The following code WILL update your database with the changes made to the `Author` object, +even if you did not call `em.persist()`: + +```typescript +const authorRepository = orm.em.getRepository(Author); +const jon = await authorRepository.findOne(1); +jon.email = '[email protected]'; +await authorRepository.flush(); // calling orm.em.flush() has same effect +``` + +## How MikroORM Detects Changes + +MikroORM is a data-mapper that tries to achieve persistence-ignorance (PI). This means you +map JS objects into a relational database that do not necessarily know about the database at +all. A natural question would now be, "how does MikroORM even detect objects have changed?". + +For this MikroORM keeps a second map inside the `UnitOfWork`. Whenever you fetch an object +from the database MikroORM will keep a copy of all the properties and associations inside +the `UnitOfWork`. + +Now whenever you call `em.flush()` MikroORM will iterate over all entities you +previously marked for persisting via `em.persist()`. For each object it will +compare the original property and association values with the values that are currently set +on the object. If changes are detected then the object is queued for a UPDATE operation. +Only the fields that actually changed are updated. + +## Implicit Transactions + +First and most important implication of having Unit of Work is that it allows handling +transactions automatically. + +When you call `em.flush()`, all computed changes are queried inside a database +transaction (if supported by given driver). This means that you can control the boundaries +of transactions simply by calling `em.persist()` and once all your changes +are ready, simply calling `flush()` will run them inside a transaction. + +> You can also control the transaction boundaries manually via `em.transactional(cb)`. + +```typescript +const user = await em.findOne(User, 1); +user.email = '[email protected]'; +const car = new Car(); +user.cars.add(car); + +// thanks to bi-directional cascading we only need to persist user entity +// flushing will create a transaction, insert new car and update user with new email +await em.persistAndFlush(user); +``` + +You can find more information about transactions in [Transactions and concurrency](transactions.md) +page. + +> This part of documentation is highly inspired by [doctrine internals docs](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/unitofwork.html) +> as the behaviour here is pretty much the same. diff --git a/upgrading-v2-to-v3.md b/upgrading-v2-to-v3.md index 066ba4d..aab8072 100644 --- a/upgrading-v2-to-v3.md +++ b/upgrading-v2-to-v3.md @@ -0,0 +1,158 @@ +--- +title: Upgrading from v2 to v3 +--- + +Following sections describe (hopefully) all breaking changes, most of them might be not valid +for you, like if you do not use custom `NamingStrategy` implementation, you do not care about +the interface being changed. + +## Default value of autoFlush has changed to false + +> If you had `autoFlush: false` in your ORM configuration before, you can now remove +> this line, no changes are needed in your app. + +Default value for `autoFlush` is now `false`. That means you need to call +`em.flush()` yourself to persist changes into database. You can still change this via ORM's +options to ease the transition but generally it is not recommended as it can cause unwanted +small transactions being created around each `persist`. + +```typescript +orm.em.persist(new Entity()); // no auto-flushing by default +await orm.em.flush(); +await orm.em.persist(new Entity(), true); // you can still use second parameter to auto-flush +``` + +## Reworked entity definition + +> Implementing those interfaces is optional. + +Now it is no longer needed to merge entities with `IEntity` interface, that was polluting entity's +interface with internal methods. New interfaces `IdentifiedEntity<T>`, `UuidEntity<T>` and `MongoEntity<T>` +are introduced, that can be implemented by entities. They are not adding any new properties or methods, +keeping the entity's interface clean. This is also the reason why they can be omitted. + +`IEntity` interface has been renamed to `AnyEntity<T, PK>` and it no longer has public methods +like `toJSON()`, `toObject()` or `init()`. One can use `wrap()` method provided by ORM that +will enhance property type when needed with those methods (`await wrap(book.author).init()`). +To keep all methods available on the entity, you can still use interface merging with +`WrappedEntity<T, PK>` that both extends `AnyEntity<T, PK>` and defines all those methods. + +You can mark the entity by implementing one of `Entity` interfaces: + +- `IdEntity<T>` for numeric/string PK on `id` property (`id: number`) +- `UuidEntity<T>` for string PK on `uuid` property (`uuid: string`) +- `MongoEntity<T>` for mongo, where `id: string` and `_id: ObjectId` are required +- `AnyEntity<T, PK>` for other possible properties (fill the PK property name to `PK` +parameter, e.g.: `AnyEntity<Book, 'myPrimaryProperty'>'`) + +To keep all public methods that were part of `IEntity` interface in v2, you can use +`WrappedEntity<T, PK>` via interface merging: + +```typescript +@Entity() +export class Book { ... } +export interface Book extends WrappedEntity<Book, 'id'> { } +``` + +For more examples, take a look at [defining entities section](defining-entities.md). + +## Integrated Knex.js as query builder and runner + +`QueryBuilder` now internally uses knex to run all queries. As knex already supports connection +pooling, this feature comes without any effort. New configuration for pooling is now available + +Transactions now require using `em.transactional()` method, previous helpers +`beginTransaction`/`commit`/`rollback` are now removed. + +All transaction management has been removed from `IDatabaseDriver` interface, now EM handles +this, passing the transaction context (carried by EM, and created by `Connection`) to all +driver methods. New methods on EM exists: `isInTransaction()` and `getTransactionContext()`. + +In postgres driver, it used to be required to pass parameters as indexed dollar sign +($1, $2, ...), while now knex requires the placeholder to be simple question mark (`?`), +like in other dialects, so this is now unified with other drivers. + +## ManyToMany now uses composite primary key + +Previously it was required to have autoincrement primary key for m:n pivot tables. Now this +has changed. By default, only foreign columns are required and composite key over both of them +is used as primary key. + +To preserve stable order of collections, you can force previous behaviour by defining the +m:n property as `fixedOrder: true`, which will start ordering by `id` column. You can also +override the order column name via `fixedOrderColumn: 'order'`. + +You can also specify default ordering via `orderBy: { ... }` attribute. + +## Entity references now don't have instantiated collections + +Previously all entity instances, including entity references (not fully loaded entities where +we know only the primary key), had instantiated collection classes. Now only initialized entities +have them. + +```typescript +const book = em.getReference(Book, 1); +console.log(book.tags); // undefined +await book.init(); +console.log(book.tags); // instance of Collection (not initialized) +``` + +## EntityAssigner.assign() requires EM for new entities + +Previously all entities had internal reference to the root EM - the one created when +initializing the ORM. Now only managed entities (those merged to the EM, e.g. loaded +from the database) have this internal reference. + +To use `assign()` method on new (not managed) entities, you need to provide the `em` +parameter: + +```typescript +const book = new Book(); +wrap(book).assign(data, { em: orm.em }); +``` + +## Strict FilterQuery and smart query conditions + +`FilterQuery` now does not allow using smart query operators. You can either cast your condition +as any or use object syntax instead (instead of `{ 'age:gte': 18 }` use `{ age: { $gte: 18 } }`). + +## Logging configuration + +Previously to start logging it was required to provide your custom logger. Logger now defaults +to `console.log()`, and users can specify what namespaces are they interested in via `debug` +option. `true`/`false` will enable/disable all namespaces. + +Available logger namespaces: `'query' \| 'query-params' \| 'discovery' \| 'info'`. + +## Removed deprecated fk option from 1:m and m:1 decorators + +Use `mappedBy`/`inversedBy` instead. + +## SchemaGenerator.generate() is now async + +If you used `SchemaGenerator`, now there is CLI tool you can use instead. Learn more +in [SchemaGenerator docs](schema-generator.md). To setup CLI, take a look at +[installation section](installation.md). + +## New method on NamingStrategy interface + +`getClassName()` is used to find entity class name based on its file name. Now users can +override the default implementation to accommodate their specific needs. + +If you used custom naming strategy, you will either need to implement this method yourself, +or extend `AbstractNamingStrategy`. + +## TypescriptMetadataProvider has been renamed + +The name is now `TsMorphMetadataProvider`, there is also newly added `ReflectMetadataProvider` +that uses `reflect-metadata` instead. As `TypescriptMetadataProvider` was the default, no +changes should be required. + +## Updated mongodb driver + +MongoDB driver version 3.3.4 or higher is now required. + +## EntityManager.find() now requires where parameter +`EntityManager` has now same `find` method interface aligned with `EntityRepository`, +`where` parameter is now required. To select all entities, use `em.find(Entity, {})` +as value. diff --git a/upgrading-v3-to-v4.md b/upgrading-v3-to-v4.md index ac9c231..3f91448 100644 --- a/upgrading-v3-to-v4.md +++ b/upgrading-v3-to-v4.md @@ -0,0 +1,275 @@ +--- +title: Upgrading from v3 to v4 +--- + +> Following sections describe (hopefully) all breaking changes, most of them might be not valid +> for you, like if you do not use custom `NamingStrategy` implementation, you do not care about +> the interface being changed. + +## Node 10.13.0+ required + +Support for older node versions was dropped. + +## TypeScript 3.7+ required + +Support for older TypeScript versions was dropped. + +## Monorepo + +The ORM has been split into several packages. In v4 one needs to require +`@mikro-orm/core` and a driver package, e.g. `@mikro-orm/mysql`. This driver +package already contains the `mysql2` dependency, so you can remove that from +your `package.json`. + +- `@mikro-orm/core` +- `@mikro-orm/reflection` - `TsMorphMetadataProvider` +- `@mikro-orm/cli` - CLI support, requires entity-generator, migrator and knex +- `@mikro-orm/knex` - SQL support +- `@mikro-orm/entity-generator` +- `@mikro-orm/migrations` +- `@mikro-orm/mysql` +- `@mikro-orm/mariadb` +- `@mikro-orm/mysql-base` - Common implementation for mysql and mariadb (internal) +- `@mikro-orm/sqlite` +- `@mikro-orm/postgresql` +- `@mikro-orm/mongodb` + +> For easier transition, meta package mikro-orm is still present, reexporting +> core, reflection, migrations, entity-generator and cli packages. You should +> not* install both `mikro-orm` and `@mikro-orm/core` packages together. + +> You should prefer the `@mikro-orm/core` over `mikro-orm` package, there were +> weird dependency issues reported with the `mikro-orm` meta-package. + +## Default metadata provider is now `ReflectMetadataProvider` + +If you want to use ts-morph, you need to install `@mikro-orm/reflection` package +and enable the provider explicitly in the ORM config, as described [here](./metadata-providers.md#tsmorphmetadataprovider). + +```typescript +import { TsMorphMetadataProvider } from '@mikro-orm/reflection'; + +await MikroORM.init({ + metadataProvider: TsMorphMetadataProvider, + // ... +}); +``` + +Using `ReflectMetadataProvider` has some limitations, so be sure to read +about them [here](./metadata-providers.md#limitations-and-requirements). + +One common gotcha with `reflect-metadata` is that you need to explicitly +state the property type when using property initializer: + +```ts +@Property() +createdAt: Date = new Date(); +``` + +Without the explicit type, we would infer `Object` instead of `Date`, +which would be most probably mapped to JSON column type (depends on driver). + +## SqlEntityManager and MongoEntityManager + +In v4 the `core` package, where `EntityManager` and `EntityRepository` are +defined, is not dependent on knex, and therefore it cannot have a method +returning a `QueryBuilder`. You need to import the SQL flavour of the EM +from the driver package to access the `createQueryBuilder()` method. + +> The SQL flavour of EM is actually called `SqlEntityManager`, it is exported both under +> this name and under `EntityManager` alias, so you can just change the +> location from where you import. + +```typescript +import { EntityManager } from '@mikro-orm/mysql'; // or any other SQL driver package + +const em: EntityManager; +const qb = await em.createQueryBuilder(...); +``` + +Same applies for the `aggregate()` method in mongo driver: + +```typescript +import { EntityManager } from '@mikro-orm/mongodb'; + +const em: EntityManager; +const ret = await em.aggregate(...); +``` + +> The mongo flavour of EM is actually called `MongoEntityManager`, it is exported both under +> this name and under `EntityManager` alias, so you can just change the +> location from where you import. + +## Different default `pivotTable` + +Implementation of `UnderscoreNamingStrategy` and `EntityCaseNamingStrategy` +`joinTableName()` method has changed. You can use `pivotTable` on the owning side +of M:N relation to specify the table name manually. + +Previously the table name did not respect property name, if one defined multiple +M:N relations between same entities, there were conflicts and one would have to +specify `pivotTable` name manually at least on one of them. With the new way, +we can be sure that the table name won't conflict with other pivot tables. + +Previously the name was constructed from 2 entity names as `entity_a_to_entity_b`, +ignoring the actual property name. In v4 the name will be `entity_a_coll_name` in +case of the collection property on the owning side being named `collName`. + +## Changes in folder-based discovery (`entitiesDirs` removed) + +`entitiesDirs` and `entitiesDirsTs` were removed in favour of `entities` and `entitiesTs`, +`entities` will be used as a default for `entitiesTs` (that is used when we detect `ts-node`). + +`entities` can now contain mixture of paths to directories, globs pointing to entities, +or references to the entities or instances of `EntitySchema`. + +This basically means that all you need to change is renaming `entitiesDirs` to `entities`. + +```typescript +MikroORM.init({ + entities: ['dist//entities', 'dist//.entity.js', FooBar, FooBaz], + entitiesTs: ['src//entities', 'src//.entity.ts', FooBar, FooBaz], +}); +``` + +## Changes in `wrap()` helper, `WrappedEntity` interface and `Reference` wrapper + +Previously all the methods and properties of `WrappedEntity` interface were +added to the entity prototype during discovery. In v4 there is only one property +added: `__helper: WrappedEntity`. `WrappedEntity` has been converted to actual class. + +`wrap(entity)` no longer returns the entity, now the `WrappedEntity` instance is +being returned. It contains only public methods (`init`, `assign`, `isInitialized`, ...), +if you want to access internal properties like `__meta` or `__em`, you need to explicitly +ask for the helper via `wrap(entity, true)`. + +Internal methods (with `__` prefix) were also removed from the `Reference` class, +use `wrap(ref, true)` to access them. + +Instead of interface merging with `WrappedEntity`, one can now use classic inheritance, +by extending `BaseEntity` exported from `@mikro-orm/core`. If you do so, `wrap(entity)` +will return your entity. + +## Removed `flush` parameter from `persist()` and `remove()` methods + +`flush` param is removed, both `persist` and `remove` methods are synchronous and +require explicit flushing, possibly via fluent interface call. + +```typescript +// before +await em.persist(jon, true); +await em.remove(Author, jon, true); + +// after +await em.persist(jon).flush(); +await em.remove(jon).flush(); +``` + +## `remove()` method requires entity instances + +The `em.remove()` method originally allowed to pass either entity instance, or +a condition. When one passed a condition, it was firing a native delete query, +without handling transactions or hooks. + +In v4, the method is now simplified and works only with entity instances. Use +`em.nativeDelete()` explicitly if you want to fire a delete query instead of +letting the `UnitOfWork` doing its job. + +```typescript +// before +await em.remove(Author, 1); // fires query directly + +// after +await em.nativeDelete(Author, 1); +``` + +> `em.removeEntity()` has been removed in favour of `em.remove()` (that now has almost the same signature). + +## Type safe references + +EM now returns `Loaded<T, P>` instead of the entity (`T`). This type automatically +adds synchronous method `get()` that returns the entity (for references) or array +of entities (for collections). + +`Reference.get()` is now available only with correct `Loaded` type hint and is used +as a sync getter for the entity, just like `unwrap()`. You can use `Reference.load(prop)` +for the original `get()` method functionality. + +`em.find()` and similar methods now have two type arguments, due to TypeScript not supporting partial +type inference, when you specify the `T` explicitly (without also explicitly +specifying the load hint), the inference will not work. This use case was mainly +for usage without classes (interfaces + `EntitySchema`) - in that case it is now +supported to pass actual instance of `EntitySchema` as the first parameter to these +methods, that will allow correct type inference: + +```typescript +const author = await em.findOne(AuthorSchema, { ... }, ['books']); +console.log(author.books.get()); // `get()` is now inferred correctly +``` + +## Custom types are now type safe + +Generic `Type` class has now two type arguments - the input and output types. +Input type defaults to `string`, output type defaults to the input type. + +You might need to explicitly provide the types if your methods are strictly typed. + +## Custom type serialization + +Custom types used to be serialized to the database value. In v4, the runtime +value is used by default. Implement custom `toJSON()` method if you need to +customize this. + +## Property `default` and `defaultRaw` + +Previously the `default` option of properties was used as is, so we had to wrap +strings in quotes (e.g. `@Property({ default: "'foo bar'" })`). + +In v4 the `default` is typed as `string \| number \| boolean \| null` and when used +with string value, it will be automatically quoted. + +To use SQL functions we now need to use `defaultRaw`: `@Property({ defaultRaw: 'now()' })`. + +## `autoFlush` option has been removed + +Also `persistLater()` and `removeLater()` methods are deprecated. Use `persist()` or +`remove` respectively. + +## `IdEntity`, `UuidEntity` and `MongoEntity` interfaces are removed + +They were actually never needed. + +## MongoDB driver is no longer the default + +You need to specify the platform type either via `type` option or provide the driver +implementation via `driver` option. + +Available platforms types: `[ 'mongo', 'mysql', 'mariadb', 'postgresql', 'sqlite' ]` + +## Removed configuration `discovery.tsConfigPath` + +Removed as it is no longer needed, it was used only for `TsMorphMetadataProvider`, +when the `entitiesDirsTs` were not explicitly provided. In v4, this is no longer +needed, as ts-morph discovery will use `d.ts` files instead, that should be located +next to the compiled entities. + +## Changes in query highlighting + +Previously Highlight.js was used to highlight various things in the CLI, +like SQL and mongo queries, or migrations or entities generated via CLI. +While the library worked fine, it was causing performance issues mainly +for those bundling via webpack and using lambdas, as the library was huge. + +In v4 highlighting is disabled by default, and there are 2 highlighters +you can optionally use (you need to install them first). + +```typescript +import { SqlHighlighter } from '@mikro-orm/sql-highlighter'; + +MikroORM.init({ + highlighter: new SqlHighlighter(), + // ... +}); +``` + +For MongoDB you can use `@mikro-orm/mongo-highlighter`. diff --git a/usage-with-babel.md b/usage-with-babel.md index fcbd444..a9249f7 100644 --- a/usage-with-babel.md +++ b/usage-with-babel.md @@ -0,0 +1,26 @@ +--- +title: Usage with Babel +--- + +When compiling TS via babel, decorators are by default handled different implementation +than what `tsc` uses. To make the metadata extraction from decorators via Babel work, +we need to do use following plugins: + +```json +{ + "plugins": [ + "babel-plugin-transform-typescript-metadata", + ["@babel/plugin-proposal-decorators", { "legacy": true }], + ["@babel/plugin-proposal-class-properties", { "loose": true }] + ] +} +``` + +> Make sure to install the plugins first: `yarn add -D babel-plugin-transform-typescript-metadata @babel/plugin-proposal-decorators @babel/plugin-proposal-class-properties` + +Lastly we need to set the `BABEL_DECORATORS_COMPAT` environment variable to `true` to +adjust the return value of decorators. + +More information about this topic can be found here: +- https://github.com/mikro-orm/mikro-orm/issues/840 +- https://jonahallibonetech.medium.com/next-js-9-mikroorm-eb6f6e08e1a1 diff --git a/usage-with-js.md b/usage-with-js.md index 2267e3c..924a4f8 100644 --- a/usage-with-js.md +++ b/usage-with-js.md @@ -0,0 +1,98 @@ +--- +title: Usage with JavaScript +sidebar_label: Usage with Vanilla JS +--- + +Since MikroORM 3.2, we can use `EntitySchema` helper to define own entities without +decorators, which works also for Vanilla JavaScript. + +> Read more about `EntitySchema` in [this section](entity-schema.md). + +Here is an example of such entity: + +```javascript title="./entities/Author.js" +const { Collection, EntitySchema } = require('@mikro-orm/core'); +const { Book } = require('./Book'); +const { BaseEntity } = require('./BaseEntity'); + +/** + * @property {number} id + * @property {Date} createdAt + * @property {Date} updatedAt + * @property {string} name + * @property {string} email + * @property {number} age + * @property {boolean} termsAccepted + * @property {string[]} identities + * @property {Date} born + * @property {Collection<Book>} books + * @property {Book} favouriteBook + * @property {number} version + * @property {string} versionAsString + / +class Author extends BaseEntity { + + /* + * @param {string} name + * @param {string} email + / + constructor(name, email) { + super(); + this.name = name; + this.email = email; + this.books = new Collection(this); + this.createdAt = new Date(); + this.updatedAt = new Date(); + this.termsAccepted = false; + } + +} + +export const schema = new EntitySchema({ + class: Author, + properties: { + name: { type: 'string' }, + email: { type: 'string', unique: true }, + age: { type: 'number', nullable: true }, + termsAccepted: { type: 'boolean', default: 0, onCreate: () => false }, + identities: { type: 'string[]', nullable: true }, + born: { type: DateType, nullable: true, length: 3 }, + books: { reference: '1:m', entity: () => 'Book', mappedBy: book => book.author }, + favouriteBook: { reference: 'm:1', type: 'Book' }, + version: { type: 'number', persist: false }, + }, +}); + +module.exports.Author = Author; +module.exports.entity = Author; +module.exports.schema = schema; +``` + +> Do not forget to provide `name` and `path` schema parameters as well as `entity` +> and `schema` exports. + +Reference parameter can be one of (where `SCALAR` is the default one): + +```typescript +export enum ReferenceType { + SCALAR = 'scalar', + ONE_TO_ONE = '1:1', + MANY_TO_ONE = 'm:1', + ONE_TO_MANY = '1:m', + MANY_TO_MANY = 'm:n', + EMBEDDED = 'embedded', +} +``` + +You can register your entities as usual. + +```javascript +const orm = await MikroORM.init({ + entities: [Author, Book, BookTag, BaseEntity], + dbName: 'my-db-name', + type: 'mysql', +}); +``` + +For more examples of plain JavaScript entity definitions take a look +[Express JavaScript example](https://github.com/mikro-orm/express-js-example-app). diff --git a/usage-with-mongo.md b/usage-with-mongo.md index 5a3d3e4..e3bc3e8 100644 --- a/usage-with-mongo.md +++ b/usage-with-mongo.md @@ -0,0 +1,163 @@ +--- +title: Usage with MongoDB +--- + +To use `mikro-orm` with mongo database, do not forget to install `mongodb` dependency. As `MongoDriver` +is the default one, you do not need to provide it. + +Then call `MikroORM.init` as part of bootstrapping your app: + +```typescript +const orm = await MikroORM.init({ + entities: [Author, Book, ...], + dbName: 'my-db-name', + clientUrl: '...', + type: 'mongo', +}); +``` + +## Defining entity + +When defining entity, do not forget to define primary key like this: + +```typescript +@PrimaryKey() +_id: ObjectId; + +@SerializedPrimaryKey() +id!: string; // won't be saved in the database +``` + +> Only `_id: ObjectId` will be saved in the database. `id: string` is virtual and is +> also optional. + +## ObjectId and string id duality + +Every entity has both `ObjectId` and `string` id available, also all methods of `EntityManager` +and `EntityRepository` supports querying by both of them. + +```typescript +const author = orm.em.getReference('...id...'); +console.log(author.id); // returns '...id...' +console.log(author._id); // returns ObjectId('...id...') + +// all of those will return the same results +const article = '...article id...'; // string id +const book = '...book id...'; // string id +const repo = orm.em.getRepository(Author); +const foo1 = await repo.find({ id: { $in: [article] }, favouriteBook: book }); +const bar1 = await repo.find({ id: { $in: [new ObjectId(article)] }, favouriteBook: new ObjectId(book) }); +const foo2 = await repo.find({ _id: { $in: [article] }, favouriteBook: book }); +const bar2 = await repo.find({ _id: { $in: [new ObjectId(article)] }, favouriteBook: new ObjectId(book) }); +``` + +## ManyToMany collections with inlined pivot array + +As opposed to SQL drivers that use pivot tables, in mongo we can leverage available array type +to store array of collection items (identifiers). This approach has two main benefits: + +1. Collection is stored on owning side entity, so we know how many items are there even before +initializing the collection. +2. As there are no pivot tables, resulting database queries are much simpler. + +## Transactions + +Starting with v3.4, MongoDB driver supports transactions. To use transactions, there +are several things you need to respect: + +- you need to use replica set (see [run-rs](https://github.com/vkarpov15/run-rs)) +- implicit transactions are disabled by default + - use `implicitTransactions: true` to enable them globally + - or use explicit transaction demarcation via `em.transactional()` +- you need to explicitly create all collections before working with them + - use `em.getDriver().createCollections()` method to do so + +```sh +# first create replica set +$ run-rs -v 4.2.3 +``` + +```typescript +import { MikroORM } from '@mikro-orm/core'; +import { MongoDriver } from '@mikro-orm/mongodb'; + +// make sure to provide the MongoDriver type hint +const orm = await MikroORM.init<MongoDriver>({ + entities: [Author, Book, ...], + clientUrl: 'mongodb://localhost:27017,localhost:27018,localhost:27019/my-db-name?replicaSet=rs0', + type: 'mongo', + implicitTransactions: true, // defaults to false +}); + +await orm.em.getDriver().createCollections(); +``` + +> The `createCollections` method is present on the `MongoDriver` class only. You need +> to have the entity manager correctly typed (as `EntityManager<MongoDriver>`). + +## Indexes + +Starting with v3.4, MongoDB driver supports indexes and unique constraints. You can +use `@Index()` and `@Unique()` as described in [Defining Entities section](defining-entities.md#indexes). +To automatically create new indexes when initializing the ORM, you need to enable +`ensureIndexes` option. + +```typescript +const orm = await MikroORM.init({ + entities: [Author, Book, ...], + dbName: 'my-db-name', + type: 'mongo', + ensureIndexes: true, // defaults to false +}); +``` + +Alternatively you can call `ensureIndexes()` method on the `MongoDriver`: + +```typescript +await orm.em.getDriver().ensureIndexes(); +``` + +> You can pass additional index/unique options via `options` parameter: +> +> `@Unique({ options: { partialFilterExpression: { name: { $exists: true } } }})` + +> You can also create text indexes by passing `type` parameter: +> +> `@Index({ properties: ['name', 'caption'], type: 'text' })` + +> If you provide only `options` in the index definition, it will be used as is, +> this allows to define any kind of index: +> +> `@Index({ options: { point: '2dsphere', title: -1 } })` + +## Native collection methods + +Sometimes you need to perform some bulk operation, or you just want to populate your +database with initial fixtures. Using ORM for such operations can bring unnecessary +boilerplate code. In this case, you can use one of `nativeInsert/nativeUpdate/nativeDelete` +methods: + +```typescript +em.nativeInsert<T extends AnyEntity>(entityName: string, data: any): Promise<IPrimaryKey>; +em.nativeUpdate<T extends AnyEntity>(entityName: string, where: FilterQuery<T>, data: any): Promise<number>; +em.nativeDelete<T extends AnyEntity>(entityName: string, where: FilterQuery<T> \| any): Promise<number>; +``` + +Those methods execute native driver methods like Mongo's `insertOne/updateMany/deleteMany` collection methods respectively. +This is common interface for all drivers, so for MySQL driver, it will fire native SQL queries. +Keep in mind that they do not hydrate results to entities, and they do not trigger lifecycle hooks. + +They are also available as `EntityRepository` shortcuts: + +```typescript +EntityRepository.nativeInsert(data: any): Promise<IPrimaryKey>; +EntityRepository.nativeUpdate(where: FilterQuery<T>, data: any): Promise<number>; +EntityRepository.nativeDelete(where: FilterQuery<T> \| any): Promise<number>; +``` + +There is also shortcut for calling `aggregate` method: + +```typescript +em.aggregate(entityName: string, pipeline: any[]): Promise<any[]>; +EntityRepository.aggregate(pipeline: any[]): Promise<any[]>; +``` diff --git a/usage-with-nestjs.md b/usage-with-nestjs.md index bc85e80..2f329db 100644 --- a/usage-with-nestjs.md +++ b/usage-with-nestjs.md @@ -0,0 +1,287 @@ +--- +title: Using MikroORM with NestJS framework +sidebar_label: Usage with NestJS +--- + +## Installation + +Easiest way to integrate MikroORM to Nest is via [`@mikro-orm/nestjs` module](https://github.com/mikro-orm/nestjs). +Simply install it next to Nest, MikroORM and underlying driver: + +```bash +$ yarn add @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mongodb # for mongo +$ yarn add @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mysql # for mysql/mariadb +$ yarn add @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mariadb # for mysql/mariadb +$ yarn add @mikro-orm/core @mikro-orm/nestjs @mikro-orm/postgresql # for postgresql +$ yarn add @mikro-orm/core @mikro-orm/nestjs @mikro-orm/sqlite # for sqlite +``` + +or + +```bash +$ npm i -s @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mongodb # for mongo +$ npm i -s @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mysql # for mysql/mariadb +$ npm i -s @mikro-orm/core @mikro-orm/nestjs @mikro-orm/mariadb # for mysql/mariadb +$ npm i -s @mikro-orm/core @mikro-orm/nestjs @mikro-orm/postgresql # for postgresql +$ npm i -s @mikro-orm/core @mikro-orm/nestjs @mikro-orm/sqlite # for sqlite +``` + +Once the installation process is completed, we can import the `MikroOrmModule` into the root `AppModule`. + +```typescript +@Module({ + imports: [ + MikroOrmModule.forRoot({ + entities: ['./dist/entities'], + entitiesTs: ['./src/entities'], + dbName: 'my-db-name.sqlite3', + type: 'sqlite', + }), + ], + controllers: [AppController], + providers: [AppService], +}) +export class AppModule {} +``` + +The `forRoot()` method accepts the same configuration object as `init()` from the MikroORM package. Check [this page](configuration.md) for the complete configuration documentation. + +Alternatively we can [configure the CLI](installation.md#setting-up-the-commandline-tool) by creating a configuration file `mikro-orm.config.ts` and then call the `forRoot()` without any arguments. This won't work when you use a build tools that use tree shaking. + +```typescript +@Module({ + imports: [ + MikroOrmModule.forRoot(), + ], + ... +}) +export class AppModule {} +``` + +Afterward, the `EntityManager` will be available to inject across entire project (without importing any module elsewhere). + +```ts +import { MikroORM } from '@mikro-orm/core'; +import { EntityManager } from '@mikro-orm/mysql'; // Import EntityManager from your driver package or `@mikro-orm/knex` + +@Injectable() +export class MyService { + + constructor(private readonly orm: MikroORM, + private readonly em: EntityManager) { + } + +} +``` + +> Notice that the `EntityManager` is imported from the `@mikro-orm/driver` package, where driver is `mysql`, `sqlite`, `postgres` or what driver you are using. +> +> In case you have `@mikro-orm/knex` installed as a dependency, you can also import the `EntityManager` from there. + +## Repositories +MikroORM supports the repository design pattern. For every entity we can create a repository. Read the complete [documentation on repositories here](repositories.md). To define which repositories shall be registered in the current scope you can use the `forFeature()` method. For example, in this way: + +> You should not* register your base entities via `forFeature()`, as there are no +> repositories for those. On the other hand, base entities need to be part of the list +> in `forRoot()` (or in the ORM config in general). + +```typescript +// photo.module.ts + +@Module({ + imports: [MikroOrmModule.forFeature([Photo])], + providers: [PhotoService], + controllers: [PhotoController], +}) +export class PhotoModule {} +``` + +and import it into the root `AppModule`: + +```typescript +// app.module.ts +@Module({ + imports: [MikroOrmModule.forRoot(...), PhotoModule], +}) +export class AppModule {} +``` + +In this way we can inject the `PhotoRepository` to the `PhotoService` using the `@InjectRepository()` decorator: + +```typescript +@Injectable() +export class PhotoService { + constructor( + @InjectRepository(Photo) + private readonly photoRepository: EntityRepository<Photo> + ) {} + + // ... +} +``` + +## Using custom repositories + +When using custom repositories, we can get around the need for `@InjectRepository()` +decorator by naming our repositories the same way as `getRepositoryToken()` method do: + +```ts +export const getRepositoryToken = <T> (entity: EntityName<T>) => `${Utils.className(entity)}Repository`; +``` + +In other words, as long as we name the repository same was as the entity is called, +appending `Repository` suffix, the repository will be registered automatically in +the Nest.js DI container. + +`./author.entity.ts` + +```ts +@Entity() +export class Author { + + // to allow inference in `em.getRepository()` + [EntityRepositoryType]?: AuthorRepository; + +} +``` + +`./author.repository.ts` + +```ts +@Repository(Author) +export class AuthorRepository extends EntityRepository<Author> { + + // your custom methods... + +} +``` + +As the custom repository name is the same as what `getRepositoryToken()` would +return, we do not need the `@InjectRepository()` decorator anymore: + +```ts +@Injectable() +export class MyService { + + constructor(private readonly repo: AuthorRepository) { } + +} +``` + +## Load entities automatically + +> `autoLoadEntities` option was added in v4.1.0 + +Manually adding entities to the entities array of the connection options can be +tedious. In addition, referencing entities from the root module breaks application +domain boundaries and causes leaking implementation details to other parts of the +application. To solve this issue, static glob paths can be used. + +Note, however, that glob paths are not supported by webpack, so if you are building +your application within a monorepo, you won't be able to use them. To address this +issue, an alternative solution is provided. To automatically load entities, set the +`autoLoadEntities` property of the configuration object (passed into the `forRoot()` +method) to `true`, as shown below: + +```ts +@Module({ + imports: [ + MikroOrmModule.forRoot({ + ... + autoLoadEntities: true, + }), + ], +}) +export class AppModule {} +``` + +With that option specified, every entity registered through the `forFeature()` +method will be automatically added to the entities array of the configuration +object. + +> Note that entities that aren't registered through the `forFeature()` method, but +> are only referenced from the entity (via a relationship), won't be included by +> way of the `autoLoadEntities` setting. + +> Using `autoLoadEntities` also has no effect on the MikroORM CLI - for that we +> still need CLI config with the full list of entities. On the other hand, we can +> use globs there, as the CLI won't go thru webpack. + +## Request scoped handlers in queues + +> `@UseRequestContext()` decorator was added in v4.1.0 + +As mentioned in the [docs](identity-map.md), we need a clean state for each request. That is handled automatically thanks to the `RequestContext` helper registered via middleware. + +But middlewares are executed only for regular HTTP request handles, what if we need +a request scoped method outside of that? One example of that is queue handlers or +scheduled tasks. + +We can use the `@UseRequestContext()` decorator. It requires you to first inject the +`MikroORM` instance to current context, it will be then used to create the context +for you. Under the hood, the decorator will register new request context for your +method and execute it inside the context. + +```ts +@Injectable() +export class MyService { + + constructor(private readonly orm: MikroORM) { } + + @UseRequestContext() + async doSomething() { + // this will be executed in a separate context + } + +} +``` + +## Using `AsyncLocalStorage` for request context + +By default, `domain` api use used in the `RequestContext` helper. Since `@mikro-orm/[email protected]`, +you can use the new `AsyncLocalStorage` too, if you are on up to date node version: + +```typescript +// create new (global) storage instance +const storage = new AsyncLocalStorage<EntityManager>(); + +@Module({ + imports: [ + MikroOrmModule.forRoot({ + // ... + registerRequestContext: false, // disable automatatic middleware + context: () => storage.getStore(), // use our AsyncLocalStorage instance + }), + ], + controllers: [AppController], + providers: [AppService], +}) +export class AppModule {} + +// register the request context middleware +const app = await NestFactory.create(AppModule, { ... }); + +app.use((req, res, next) => { + storage.run(orm.em.fork(true, true), next); +}); +``` + +## Testing + +The `@mikro-orm/nestjs` package exposes `getRepositoryToken()` function that returns prepared token based on a given entity to allow mocking the repository. + +```typescript +@Module({ + providers: [ + PhotoService, + { + provide: getRepositoryToken(Photo), + useValue: mockedRepository, + }, + ], +}) +export class PhotoModule {} +``` + +## Example +A real world example of NestJS with MikroORM can be found [here](https://github.com/mikro-orm/nestjs-realworld-example-app) diff --git a/usage-with-sql.md b/usage-with-sql.md index 43fb375..9fde964 100644 --- a/usage-with-sql.md +++ b/usage-with-sql.md @@ -0,0 +1,199 @@ +--- +title: Usage with MySQL, MariaDB, PostgreSQL or SQLite +sidebar_label: Usage with SQL Drivers +--- + +To use `mikro-orm` with MySQL database, simply install the `@mikro-orm/mysql` dependency and set +the type option to `mysql` when initializing ORM. Since v4 it is no longer needed to install the `mysql2` package manually. + +```sh +yarn add @mikro-orm/core @mikro-orm/mongodb # for mongo +yarn add @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +yarn add @mikro-orm/core @mikro-orm/postgresql # for postgresql +yarn add @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +or + +```sh +npm i -s @mikro-orm/core @mikro-orm/mongodb # for mongo +npm i -s @mikro-orm/core @mikro-orm/mysql # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/mariadb # for mysql/mariadb +npm i -s @mikro-orm/core @mikro-orm/postgresql # for postgresql +npm i -s @mikro-orm/core @mikro-orm/sqlite # for sqlite +``` + +Then call `MikroORM.init` as part of bootstrapping your app: + +```typescript +const orm = await MikroORM.init({ + entities: [Author, Book, ...], + dbName: 'my-db-name', + type: 'mysql', // or 'sqlite' or 'postgresql' or 'mariadb' +}); +``` + +## Custom driver + +If you want to use database that is not currently supported, you can implement your own driver. +More information about how to create one can be [found here](custom-driver.md). Then provide the +driver class via `driver` configuration option: + +```typescript +import { MyCustomDriver } from './MyCustomDriver.ts'; + +const orm = await MikroORM.init({ + entities: [Author, Book, ...], + dbName: 'my-db-name', + driver: MyCustomDriver, // provide the class, not just its name +}); +``` + +## Schema + +Currently you will need to maintain the database schema yourself. For initial dump, you can +use [`SchemaGenerator` helper](schema-generator.md). + +## ManyToMany collections with pivot tables + +As opposed to `MongoDriver`, in MySQL we use pivot tables to handle `ManyToMany` relations: + +```sql +CREATE TABLE `publisher_to_test` ( + `id` int(11) unsigned NOT NULL AUTO_INCREMENT, + `publisher_id` int(11) DEFAULT NULL, + `test_id` int(11) DEFAULT NULL, + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; +``` + +You can adjust the name of pivot table via `pivotTable` option in `@ManyToMany` decorator +defined on owning side: + +```typescript +// for unidirectional +@ManyToMany({ entity: () => Test, owner: true, pivotTable: 'publisher2test' }) +tests = new Collection<Test>(this); + +// for bidirectional +@ManyToMany({ entity: () => BookTag, inversedBy: 'books', pivotTable: 'book2tag' }) +tags = new Collection<BookTag>(this); +``` + +## Using QueryBuilder to execute native SQL queries + +When you need to execute some SQL query without all the ORM stuff involved, you can either +compose the query yourself, or use the `QueryBuilder` helper to construct the query for you: + +```typescript +const qb = orm.em.createQueryBuilder(Author); +qb.update({ name: 'test 123', type: PublisherType.GLOBAL }).where({ id: 123, type: PublisherType.LOCAL }); + +console.log(qb.getQuery()); +// 'UPDATE `publisher2` SET `name` = ?, `type` = ? WHERE `id` = ? AND `type` = ?' + +console.log(qb.getParams()); +// ['test 123', PublisherType.GLOBAL, 123, PublisherType.LOCAL] + +// run the query +const res1 = await qb.execute(); + +// or run query without using QueryBuilder +const driver = orm.em.getDriver(); +const res2 = await driver.execute('SELECT ? + ?', [1, 2]); +``` + +`QueryBuilder` provides fluent interface with these methods: + +```typescript +QueryBuilder.select(fields: string \| string[], distinct?: boolean): QueryBuilder; +QueryBuilder.insert(data: any): QueryBuilder; +QueryBuilder.update(data: any): QueryBuilder; +QueryBuilder.delete(cond: any): QueryBuilder; +QueryBuilder.count(fields: string \| string[], distinct?: boolean): QueryBuilder; +QueryBuilder.join(field: string, alias?: string): QueryBuilder; +QueryBuilder.leftJoin(field: string, alias?: string): QueryBuilder; +QueryBuilder.where(cond: any, operator: '$and' \| '$or'): QueryBuilder; +QueryBuilder.andWhere(cond: any): QueryBuilder; +QueryBuilder.orWhere(cond: any): QueryBuilder; +QueryBuilder.groupBy(fields: string \| string[]): QueryBuilder; +QueryBuilder.having(cond: any): QueryBuilder; +QueryBuilder.populate(populate: string[]): QueryBuilder; +QueryBuilder.limit(limit: number, offset?: number): QueryBuilder; +QueryBuilder.offset(offset: number): QueryBuilder; +QueryBuilder.getQuery(): string; +QueryBuilder.getParams(): any; +QueryBuilder.clone(): QueryBuilder; +``` + +For more examples of how to work with `QueryBuilder`, take a look at `QueryBuilder` tests in +[`tests/QueryBuilder.test.ts`](https://github.com/mikro-orm/mikro-orm/blob/master/tests/QueryBuilder.test.ts). + +## Transactions + +When you call `em.flush()`, all computed changes are queried [inside a database +transaction](unit-of-work.md) by default, so you do not have to handle transactions manually. + +When you need to explicitly handle the transaction, you can use `em.transactional(cb)` +to run callback in transaction. It will provide forked `EntityManager` as a parameter +with clear isolated identity map - please use that to make changes. + +```typescript +// if an error occurs inside the callback, all db queries from inside the callback will be rolled back +await orm.em.transactional(async (em: EntityManager) => { + const god = new Author('God', '[email protected]'); + await em.persistAndFlush(god); +}); +``` + +## LIKE Queries + +SQL supports LIKE queries via native JS regular expressions: + +```typescript +const author1 = new Author2('Author 1', '[email protected]'); +const author2 = new Author2('Author 2', '[email protected]'); +const author3 = new Author2('Author 3', '[email protected]'); +await orm.em.persistAndFlush([author1, author2, author3]); + +// finds authors with email like '%exa%le.c_m' +const authors = await orm.em.find(Author2, { email: /exa.le\\.c.m$/ }); +console.log(authors); // all 3 authors found +``` + +## Native Collection Methods + +Sometimes you need to perform some bulk operation, or you just want to populate your +database with initial fixtures. Using ORM for such operations can bring unnecessary +boilerplate code. In this case, you can use one of `nativeInsert/nativeUpdate/nativeDelete` +methods: + +```typescript +em.nativeInsert<T extends AnyEntity>(entityName: string, data: any): Promise<IPrimaryKey>; +em.nativeUpdate<T extends AnyEntity>(entityName: string, where: FilterQuery<T>, data: any): Promise<number>; +em.nativeDelete<T extends AnyEntity>(entityName: string, where: FilterQuery<T> \| any): Promise<number>; +``` + +Those methods execute native SQL queries generated via `QueryBuilder` based on entity +metadata. Keep in mind that they do not hydrate results to entities, and they do not +trigger lifecycle hooks. + +They are also available as `EntityRepository` shortcuts: + +```typescript +EntityRepository.nativeInsert(data: any): Promise<IPrimaryKey>; +EntityRepository.nativeUpdate(where: FilterQuery<T>, data: any): Promise<number>; +EntityRepository.nativeDelete(where: FilterQuery<T> \| any): Promise<number>; +``` + +Additionally there is `execute()` method that supports executing raw SQL queries or `QueryBuilder` +instances. To create `QueryBuilder`, you can use `createQueryBuilder()` factory method on both +`EntityManager` and `EntityRepository` classes: + +```typescript +const qb = em.createQueryBuilder('Author'); +qb.select('').where({ id: { $in: [...] } }); +const res = await em.getDriver().execute(qb); +console.log(res); // unprocessed result of underlying database driver +``` diff --git a/using-bigint-pks.md b/using-bigint-pks.md index 8088580..ae7311a 100644 --- a/using-bigint-pks.md +++ b/using-bigint-pks.md @@ -0,0 +1,41 @@ +--- +title: Using native BigInt PKs (MySQL and PostgreSQL) +--- + +You can use `BigIntType` to support `bigint`s. By default it will represent the value as +a `string`. + +```typescript +@Entity() +export class Book { + + @PrimaryKey({ type: BigIntType }) + id: string; + +} +``` + +If you want to use native `bigint` type, you will need to create new type based on the +`BigIntType`: + +```typescript +export class NativeBigIntType extends BigIntType { + + convertToJSValue(value: any): any { + if (!value) { + return value; + } + + return BigInt(value); + } + +} + +@Entity() +export class Book { + + @PrimaryKey({ type: NativeBigIntType }) + id: bigint; + +} +``` diff --git a/version-4.4-sidebars.json b/version-4.4-sidebars.json index edb3c7f..9e29646 100644 --- a/version-4.4-sidebars.json +++ b/version-4.4-sidebars.json @@ -301,1075 +301,5 @@ } ] } - ], - "version-4.4/API": [ - { - "type": "doc", - "id": "version-4.4/api/index" - }, - { - "collapsed": true, - "type": "category", - "label": "Namespaces", - "items": [ - { - "type": "doc", - "id": "version-4.4/api/modules/knex.knex-1" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Enumerations", - "items": [ - { - "type": "doc", - "id": "version-4.4/api/enums/core.cascade" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.changesettype" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.eventtype" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.groupoperator" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.loadstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.lockmode" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.nodestate" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.queryflag" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.queryoperator" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.queryorder" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.queryordernumeric" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/core.referencetype" - }, - { - "type": "doc", - "id": "version-4.4/api/enums/knex.querytype" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Classes", - "items": [ - { - "type": "doc", - "id": "version-4.4/api/classes/cli.cliconfigurator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/cli.clihelper" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.abstractnamingstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.arraycollection" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.arraytype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.baseentity" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.biginttype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.blobtype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.changeset" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.changesetcomputer" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.changesetpersister" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.collection" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.commitordercalculator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.configuration" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.configurationloader" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.connection" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.connectionexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.constraintviolationexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.databasedriver" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.databaseobjectexistsexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.databaseobjectnotfoundexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.datetype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.deadlockexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.driverexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityassigner" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entitycasenamingstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entitycomparator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityfactory" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityhelper" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityidentifier" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityloader" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entitymanager" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entitymetadata" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityrepository" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityschema" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entitytransformer" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.entityvalidator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.enumarraytype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.eventmanager" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.exceptionconverter" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.filecacheadapter" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.foreignkeyconstraintviolationexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.hydrator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.identitymap" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.invalidfieldnameexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.javascriptmetadataprovider" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.jsontype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.lockwaittimeoutexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.logger" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.memorycacheadapter" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.metadatadiscovery" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.metadataerror" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.metadataprovider" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.metadatastorage" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.metadatavalidator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.mikroorm" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.mongonamingstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.nonuniquefieldnameexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.notfounderror" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.notnullconstraintviolationexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.nullcacheadapter" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.nullhighlighter" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.objecthydrator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.optimisticlockerror" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.platform" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.queryhelper" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.readonlyexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.reference" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.reflectmetadataprovider" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.requestcontext" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.serializationcontext" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.serverexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.syntaxerrorexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.tableexistsexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.tablenotfoundexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.timetype" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.transactioncontext" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.transactioneventbroadcaster" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.type" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.underscorenamingstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.uniqueconstraintviolationexception" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.unitofwork" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.utils" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.validationerror" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/core.wrappedentity" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/entity-generator.entitygenerator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.knex.client" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.knex.knextimeouterror" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.knex.querybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.knex.seeder" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.abstractsqlconnection" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.abstractsqldriver" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.abstractsqlplatform" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.arraycriterianode" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.criterianode" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.criterianodefactory" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.databaseschema" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.databasetable" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.entitymanager" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.entityrepository" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.objectcriterianode" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.querybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.querybuilderhelper" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.scalarcriterianode" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.schemagenerator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.schemahelper" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.sqlentitymanager" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/knex.sqlentityrepository" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/migrations.migration" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/migrations.migrationgenerator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/migrations.migrationrunner" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/migrations.migrationstorage" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/migrations.migrator" - }, - { - "type": "doc", - "id": "version-4.4/api/classes/reflection.tsmorphmetadataprovider" - } - ] - }, - { - "collapsed": true, - "type": "category", - "label": "Interfaces", - "items": [ - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.assignoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.cacheadapter" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.connectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.connectionoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.countoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.deleteoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.edge" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.entityproperty" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.enumoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.eventargs" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.eventsubscriber" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.factoryoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.findoneoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.findoneorfailoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.findoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.flatqueryordermap" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.flusheventargs" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.formulaoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.highlighter" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.iconfiguration" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.idatabasedriver" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.iwrappedentity" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.indexoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.initoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.loadedcollection" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.loadedreference" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.manytomanyoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.manytooneoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.migrationobject" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.mikroormoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.namingstrategy" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.node" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.onetooneoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.poolconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.primarykeyoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.queryordermap" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.queryresult" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.referenceoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.serializedprimarykeyoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.settings" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.transactioneventargs" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.uniqueoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/core.updateoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.aliasdict" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.aliasquerybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.altercolumnbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.altertablebuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.as" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.asymmetricaggregation" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.batchinsertbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.chainableinterface" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.columnbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.columninfo" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.columnnamequerybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.config" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.connectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.createtablebuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.distinct" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.distincton" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.enumoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.foreignconstraintbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.functionhelper" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.groupby" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.having" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.havingrange" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.intersect" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.join" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.joincallback" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.joinclause" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.joinraw" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.logger" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mariasqlconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mariasslconfiguration" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.migration" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.migrationsource" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.migrator" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.migratorconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mssqlconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.multikeyforeignconstraintbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mysql2connectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mysqlaltercolumnbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.mysqlconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.onconflictquerybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.oracledbconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.orderby" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.pgconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.poolconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.postgresqlcolumnbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.queryinterface" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.raw" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.rawbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.rawquerybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.ref" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.refbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.referencingcolumnbuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.schemabuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.seederconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.select" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.socketconnectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.sql" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.sqlnative" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.sqlite3connectionconfig" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.stringtagsupport" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.table" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.tablebuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.transaction" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.typepreservingaggregation" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.union" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.valuedict" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.where" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.wherebetween" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.whereexists" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.wherein" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.wherenull" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.whereraw" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.wherewrapped" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.with" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.withraw" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.withschema" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex.withwrapped" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.column" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.foreignkey" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.icriterianode" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.iquerybuilder" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.index" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.indexdef" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.issame" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.joinoptions" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.knex-2" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.table" - }, - { - "type": "doc", - "id": "version-4.4/api/interfaces/knex.tabledifference" - } - ] - } ] } diff --git a/version-4.5-sidebars.json b/version-4.5-sidebars.json index eceae38..281f11f 100644 --- a/version-4.5-sidebars.json +++ b/version-4.5-sidebars.json @@ -0,0 +1,1414 @@ +{ + "version-4.5/docs": [ + { + "collapsed": true, + "type": "category", + "label": "Overview", + "items": [ + { + "type": "doc", + "id": "version-4.5/installation" + }, + { + "type": "doc", + "id": "version-4.5/defining-entities" + }, + { + "type": "doc", + "id": "version-4.5/relationships" + }, + { + "type": "doc", + "id": "version-4.5/entity-manager" + }, + { + "type": "doc", + "id": "version-4.5/unit-of-work" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Fundamentals", + "items": [ + { + "type": "doc", + "id": "version-4.5/identity-map" + }, + { + "type": "doc", + "id": "version-4.5/entity-references" + }, + { + "type": "doc", + "id": "version-4.5/collections" + }, + { + "type": "doc", + "id": "version-4.5/repositories" + }, + { + "type": "doc", + "id": "version-4.5/transactions" + }, + { + "type": "doc", + "id": "version-4.5/inheritance-mapping" + }, + { + "type": "doc", + "id": "version-4.5/cascading" + }, + { + "type": "doc", + "id": "version-4.5/filters" + }, + { + "type": "doc", + "id": "version-4.5/deployment" + }, + { + "type": "doc", + "id": "version-4.5/query-builder" + }, + { + "type": "doc", + "id": "version-4.5/caching" + }, + { + "type": "doc", + "id": "version-4.5/debugging" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Advanced Features", + "items": [ + { + "type": "doc", + "id": "version-4.5/nested-populate" + }, + { + "type": "doc", + "id": "version-4.5/query-conditions" + }, + { + "type": "doc", + "id": "version-4.5/propagation" + }, + { + "type": "doc", + "id": "version-4.5/loading-strategies" + }, + { + "type": "doc", + "id": "version-4.5/serializing" + }, + { + "type": "doc", + "id": "version-4.5/entity-helper" + }, + { + "type": "doc", + "id": "version-4.5/lifecycle-hooks" + }, + { + "type": "doc", + "id": "version-4.5/composite-keys" + }, + { + "type": "doc", + "id": "version-4.5/custom-types" + }, + { + "type": "doc", + "id": "version-4.5/embeddables" + }, + { + "type": "doc", + "id": "version-4.5/entity-schema" + }, + { + "type": "doc", + "id": "version-4.5/json-properties" + }, + { + "type": "doc", + "id": "version-4.5/metadata-providers" + }, + { + "type": "doc", + "id": "version-4.5/metadata-cache" + }, + { + "type": "doc", + "id": "version-4.5/schema-generator" + }, + { + "type": "doc", + "id": "version-4.5/entity-generator" + }, + { + "type": "doc", + "id": "version-4.5/naming-strategy" + }, + { + "type": "doc", + "id": "version-4.5/property-validation" + }, + { + "type": "doc", + "id": "version-4.5/migrations" + }, + { + "type": "doc", + "id": "version-4.5/read-connections" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Reference", + "items": [ + { + "type": "doc", + "id": "version-4.5/entity-manager-api" + }, + { + "type": "doc", + "id": "version-4.5/repositories-api" + }, + { + "type": "doc", + "id": "version-4.5/query-builder-api" + }, + { + "type": "doc", + "id": "version-4.5/decorators" + }, + { + "type": "doc", + "id": "version-4.5/configuration" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Usage with Different Drivers", + "items": [ + { + "type": "doc", + "id": "version-4.5/usage-with-sql" + }, + { + "type": "doc", + "id": "version-4.5/usage-with-mongo" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Recipes", + "items": [ + { + "type": "doc", + "id": "version-4.5/quick-start" + }, + { + "type": "doc", + "id": "version-4.5/usage-with-nestjs" + }, + { + "type": "doc", + "id": "version-4.5/usage-with-js" + }, + { + "type": "doc", + "id": "version-4.5/usage-with-babel" + }, + { + "type": "doc", + "id": "version-4.5/entity-constructors" + }, + { + "type": "doc", + "id": "version-4.5/multiple-schemas" + }, + { + "type": "doc", + "id": "version-4.5/using-bigint-pks" + }, + { + "type": "doc", + "id": "version-4.5/async-local-storage" + }, + { + "type": "doc", + "id": "version-4.5/custom-driver" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Example Integrations", + "items": [ + { + "type": "link", + "label": "Express + MongoDB + TypeScript", + "href": "https://github.com/mikro-orm/express-ts-example-app" + }, + { + "type": "link", + "label": "NestJS + MySQL + TypeScript", + "href": "https://github.com/mikro-orm/nestjs-example-app" + }, + { + "type": "link", + "label": "RealWorld example app (Nest + MySQL)", + "href": "https://github.com/mikro-orm/nestjs-realworld-example-app" + }, + { + "type": "link", + "label": "Express + MongoDB + JavaScript", + "href": "https://github.com/mikro-orm/express-js-example-app" + }, + { + "type": "link", + "label": "Koa + SQLite + TypeScript", + "href": "https://github.com/mikro-orm/koa-ts-example-app" + }, + { + "type": "link", + "label": "Inversify + PostgreSQL", + "href": "https://github.com/PodaruDragos/inversify-example-app" + }, + { + "type": "link", + "label": "NextJS + MySQL", + "href": "https://github.com/jonahallibone/mikro-orm-nextjs" + }, + { + "type": "link", + "label": "GraphQL + PostgreSQL + TypeScript", + "href": "https://github.com/driescroons/mikro-orm-graphql-example" + } + ] + } + ], + "version-4.5/API": [ + { + "type": "doc", + "id": "version-4.5/api/index" + }, + { + "collapsed": true, + "type": "category", + "label": "Modules", + "items": [ + { + "type": "doc", + "id": "version-4.5/api/modules/cli" + }, + { + "type": "doc", + "id": "version-4.5/api/modules/core" + }, + { + "type": "doc", + "id": "version-4.5/api/modules/entity_generator" + }, + { + "type": "doc", + "id": "version-4.5/api/modules/knex" + }, + { + "type": "doc", + "id": "version-4.5/api/modules/migrations" + }, + { + "type": "doc", + "id": "version-4.5/api/modules/reflection" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Namespaces", + "items": [ + { + "type": "doc", + "id": "version-4.5/api/modules/knex.knex-1" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Enumerations", + "items": [ + { + "type": "doc", + "id": "version-4.5/api/enums/core.cascade" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.changesettype" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.eventtype" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.groupoperator" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.loadstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.lockmode" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.nodestate" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.queryflag" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.queryoperator" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.queryorder" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.queryordernumeric" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/core.referencetype" + }, + { + "type": "doc", + "id": "version-4.5/api/enums/knex.querytype" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Classes", + "items": [ + { + "type": "doc", + "id": "version-4.5/api/classes/cli.cliconfigurator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/cli.clihelper" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.abstractnamingstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.arraycollection" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.arraytype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.baseentity" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.biginttype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.blobtype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.changeset" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.changesetcomputer" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.changesetpersister" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.collection" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.commitordercalculator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.configuration" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.configurationloader" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.connection" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.connectionexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.constraintviolationexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.databasedriver" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.databaseobjectexistsexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.databaseobjectnotfoundexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.datetype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.deadlockexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.driverexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityassigner" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entitycasenamingstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entitycomparator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityfactory" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityhelper" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityidentifier" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityloader" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entitymanager" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entitymetadata" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityrepository" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityschema" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entitytransformer" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.entityvalidator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.enumarraytype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.eventmanager" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.exceptionconverter" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.filecacheadapter" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.foreignkeyconstraintviolationexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.hydrator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.identitymap" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.invalidfieldnameexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.javascriptmetadataprovider" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.jsontype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.lockwaittimeoutexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.logger" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.memorycacheadapter" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.metadatadiscovery" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.metadataerror" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.metadataprovider" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.metadatastorage" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.metadatavalidator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.mikroorm" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.mongonamingstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.nonuniquefieldnameexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.notfounderror" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.notnullconstraintviolationexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.nullcacheadapter" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.nullhighlighter" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.objecthydrator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.optimisticlockerror" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.platform" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.queryhelper" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.readonlyexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.reference" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.reflectmetadataprovider" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.requestcontext" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.serializationcontext" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.serverexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.syntaxerrorexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.tableexistsexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.tablenotfoundexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.timetype" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.transactioncontext" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.transactioneventbroadcaster" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.type" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.underscorenamingstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.uniqueconstraintviolationexception" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.unitofwork" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.utils" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.validationerror" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/core.wrappedentity" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/entity_generator.entitygenerator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.knex-1.client" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.knex-1.knextimeouterror" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.knex-1.querybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.knex-1.seeder" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.abstractsqlconnection" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.abstractsqldriver" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.abstractsqlplatform" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.arraycriterianode" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.criterianode" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.criterianodefactory" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.databaseschema" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.databasetable" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.entitymanager" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.entityrepository" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.objectcriterianode" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.querybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.querybuilderhelper" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.scalarcriterianode" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.schemagenerator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.schemahelper" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.sqlentitymanager" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/knex.sqlentityrepository" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/migrations.migration" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/migrations.migrationgenerator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/migrations.migrationrunner" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/migrations.migrationstorage" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/migrations.migrator" + }, + { + "type": "doc", + "id": "version-4.5/api/classes/reflection.tsmorphmetadataprovider" + } + ] + }, + { + "collapsed": true, + "type": "category", + "label": "Interfaces", + "items": [ + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.assignoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.cacheadapter" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.connectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.connectionoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.countoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.deleteoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.edge" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.entityproperty" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.enumoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.eventargs" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.eventsubscriber" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.factoryoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.findoneoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.findoneorfailoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.findoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.flatqueryordermap" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.flusheventargs" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.formulaoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.highlighter" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.iconfiguration" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.idatabasedriver" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.iwrappedentity" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.indexoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.initoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.loadedcollection" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.loadedreference" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.manytomanyoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.manytooneoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.matchingoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.migrationobject" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.mikroormoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.namingstrategy" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.node" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.onetooneoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.poolconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.primarykeyoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.queryordermap" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.queryresult" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.referenceoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.serializedprimarykeyoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.settings" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.transactioneventargs" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.uniqueoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/core.updateoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.aliasdict" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.aliasquerybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.altercolumnbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.altertablebuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.as" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.asymmetricaggregation" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.batchinsertbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.chainableinterface" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.columnbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.columninfo" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.columnnamequerybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.config" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.connectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.createtablebuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.distinct" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.distincton" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.enumoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.foreignconstraintbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.functionhelper" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.groupby" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.having" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.havingrange" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.hintcomment" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.intersect" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.join" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.joincallback" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.joinclause" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.joinraw" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.logger" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mariasqlconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mariasslconfiguration" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.migration" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.migrationsource" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.migrator" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.migratorconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mssqlconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.multikeyforeignconstraintbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mysql2connectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mysqlaltercolumnbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.mysqlconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.onconflictquerybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.oracledbconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.orderby" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.pgconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.poolconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.postgresqlcolumnbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.queryinterface" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.raw" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.rawbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.rawquerybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.ref" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.refbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.referencingcolumnbuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.schemabuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.seederconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.select" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.socketconnectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.sql" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.sqlnative" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.sqlite3connectionconfig" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.stringtagsupport" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.table" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.tablebuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.transaction" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.typepreservingaggregation" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.union" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.valuedict" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.where" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.wherebetween" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.whereexists" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.wherein" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.wherenull" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.whereraw" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.wherewrapped" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.with" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.withraw" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.withschema" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-1.withwrapped" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.column" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.foreignkey" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.icriterianode" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.iquerybuilder" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.index" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.indexdef" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.issame" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.joinoptions" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.knex-2" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.table" + }, + { + "type": "doc", + "id": "version-4.5/api/interfaces/knex.tabledifference" + } + ] + } + ] +} diff --git a/versions.json b/versions.json index 8fe395a..40c25f7 100644 --- a/versions.json +++ b/versions.json @@ -1,4 +1,5 @@ [ + "4.5", "4.4", "4.3", "4.2",
build: update version (v0.6.7)	86eaba395f8f2683a17e2adac34d855cb46e9036	build	https://github.com/erg-lang/erg/commit/86eaba395f8f2683a17e2adac34d855cb46e9036	update version (v0.6.7)	[email protected]	diff --git a/Cargo.lock b/Cargo.lock index 511d1a1..dafe419 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -94,7 +94,7 @@ dependencies = [ [[package]] name = "els" -version = "0.1.19-nightly.2" +version = "0.1.19" dependencies = [ "erg_common", "erg_compiler", @@ -105,7 +105,7 @@ dependencies = [ [[package]] name = "erg" -version = "0.6.7-nightly.2" +version = "0.6.7" dependencies = [ "els", "erg_common", @@ -115,7 +115,7 @@ dependencies = [ [[package]] name = "erg_common" -version = "0.6.7-nightly.2" +version = "0.6.7" dependencies = [ "backtrace-on-stack-overflow", "crossterm", @@ -126,7 +126,7 @@ dependencies = [ [[package]] name = "erg_compiler" -version = "0.6.7-nightly.2" +version = "0.6.7" dependencies = [ "erg_common", "erg_parser", @@ -134,7 +134,7 @@ dependencies = [ [[package]] name = "erg_parser" -version = "0.6.7-nightly.2" +version = "0.6.7" dependencies = [ "erg_common", "unicode-xid", diff --git a/Cargo.toml b/Cargo.toml index b440bed..3a907b7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "els" description = "An Erg compiler frontend for IDEs, implements LSP." documentation = "http://docs.rs/els" -version = "0.1.19-nightly.2" +version = "0.1.19" authors.workspace = true license.workspace = true edition.workspace = true
fix: `Context::fields` with module types	f00ee2dc747bf2b05dfdd0fbc97c1614ee471834	fix	https://github.com/erg-lang/erg/commit/f00ee2dc747bf2b05dfdd0fbc97c1614ee471834	`Context::fields` with module types	[email protected]	diff --git a/compare.rs b/compare.rs index ccde977..371f875 100644 --- a/compare.rs +++ b/compare.rs @@ -720,8 +720,20 @@ impl Context { let Some((_, ctx)) = self.get_nominal_type_ctx(other) else { return Dict::new(); }; + let mod_fields = if other.is_module() { + if let Ok(ValueObj::Str(mod_name)) = + ValueObj::try_from(other.typarams()[0].clone()) + { + self.get_mod(&mod_name).unwrap().local_dir() + } else { + Dict::new() + } + } else { + Dict::new() + }; ctx.type_dir(self) .into_iter() + .chain(mod_fields.into_iter()) .map(\|(name, vi)\| { ( Field::new(vi.vis.modifier.clone(), name.inspect().clone()),
build: small refactoring	1e2241981f040808097e02433331d12f1c1d0535	build	https://github.com/tsparticles/tsparticles/commit/1e2241981f040808097e02433331d12f1c1d0535	small refactoring	[email protected]	diff --git a/gifs.ts b/gifs.ts index a963f68..ec6c342 100644 --- a/gifs.ts +++ b/gifs.ts @@ -51,7 +51,6 @@ const options: ISourceOptions = { }, }, }, - detectRetina: true, }; export default options;
fix(core): ignore null values of unknown properties in `assign()` Closes #4566	a600f55c0c75400c33dffd845feb4938f256a86e	fix	https://github.com/mikro-orm/mikro-orm/commit/a600f55c0c75400c33dffd845feb4938f256a86e	ignore null values of unknown properties in `assign()` Closes #4566	[email protected]	diff --git a/EntityAssigner.ts b/EntityAssigner.ts index 85c8074..2f06cd9 100644 --- a/EntityAssigner.ts +++ b/EntityAssigner.ts @@ -52,7 +52,7 @@ export class EntityAssigner { let value = data[propName]; const prop = { ...props[propName], name: propName } as EntityProperty<T>; - if (prop && !prop.nullable && value == null) { + if (propName in props && !prop.nullable && value == null) { throw new Error(`You must pass a non-${value} value to the property ${propName} of entity ${(entity as Dictionary).constructor.name}.`); } @@ -271,7 +271,6 @@ export interface AssignOptions { merge?: boolean; schema?: string; em?: EntityManager; - /** @internal */ } interface InternalAssignOptions extends AssignOptions { diff --git a/EntityAssigner.mongo.test.ts b/EntityAssigner.mongo.test.ts index aa96081..9133b57 100644 --- a/EntityAssigner.mongo.test.ts +++ b/EntityAssigner.mongo.test.ts @@ -63,6 +63,19 @@ describe('EntityAssignerMongo', () => { expect((jon as any).unknown).toBeUndefined(); }); + test('#assign() should ignore undefined properties in nullability validation (#4566)', async () => { + const jon = new Author('Jon Snow', '[email protected]'); + assign<any>(jon, { name: 'test', emptyUnknown1: null, emptyUnknown2: undefined }, { onlyProperties: true }); + expect('emptyUnknown1' in jon).toBe(false); + expect('emptyUnknown2' in jon).toBe(false); + + assign<any>(jon, { name: 'test', emptyUnknown1: null, emptyUnknown2: undefined }); + expect('emptyUnknown1' in jon).toBe(true); + expect('emptyUnknown2' in jon).toBe(true); + expect((jon as any).emptyUnknown1).toBeNull(); + expect((jon as any).emptyUnknown2).toBeUndefined(); + }); + test('#assign() should merge references', async () => { const jon = new Author('Jon Snow', '[email protected]'); orm.em.assign(jon, { favouriteBook: { _id: ObjectId.createFromTime(1), title: 'b1' } }, { merge: false });
chore: generate the name so we can have a single place to adjust it	45fc0ac3368617cd315f308d806fcbc068ed5594	chore	https://github.com/ibis-project/ibis/commit/45fc0ac3368617cd315f308d806fcbc068ed5594	generate the name so we can have a single place to adjust it	[email protected]	diff --git a/values.py b/values.py index 47d1acf..a690930 100644 --- a/values.py +++ b/values.py @@ -958,8 +958,8 @@ def _array_string_join(op, , arg, sep, _): @translate_val.register(ops.Argument) -def _argument(op, , name, _): - return sg.to_identifier(name) +def _argument(op, _): + return sg.to_identifier(op.param) @translate_val.register(ops.ArrayMap) diff --git a/registry.py b/registry.py index 0409444..e8f55c0 100644 --- a/registry.py +++ b/registry.py @@ -318,13 +318,13 @@ def _array_filter(t, op): def _array_intersect(t, op): - name = "__array_filter_param__" + name = "x" parameter = ops.Argument( name=name, shape=op.left.shape, dtype=op.left.dtype.value_type ) return t.translate( ops.ArrayFilter( - op.left, param=name, body=ops.ArrayContains(op.right, parameter) + op.left, param=parameter.param, body=ops.ArrayContains(op.right, parameter) ) ) @@ -371,6 +371,15 @@ def _to_json_collection(t, op): return try_cast(t.translate(op.arg), typ, type_=typ) +def _array_remove(t, op): + arg = op.arg + param = ops.Argument(name="x", shape=arg.shape, dtype=arg.dtype.value_type) + return _array_filter( + t, + ops.ArrayFilter(arg, param=param.param, body=ops.NotEquals(param, op.other)), + ) + + operation_registry.update( { ops.ArrayColumn: ( @@ -419,21 +428,7 @@ operation_registry.update( 1, ), ops.ArraySort: fixed_arity(sa.func.list_sort, 1), - ops.ArrayRemove: lambda t, op: _array_filter( - t, - ops.ArrayFilter( - op.arg, - param="__array_filter_param__", - body=ops.NotEquals( - ops.Argument( - name="__array_filter_param__", - shape=op.arg.shape, - dtype=op.arg.dtype.value_type, - ), - op.other, - ), - ), - ), + ops.ArrayRemove: _array_remove, ops.ArrayUnion: lambda t, op: t.translate( ops.ArrayDistinct(ops.ArrayConcat((op.left, op.right))) ), @@ -496,7 +491,7 @@ operation_registry.update( ), ops.StartsWith: fixed_arity(sa.func.prefix, 2), ops.EndsWith: fixed_arity(sa.func.suffix, 2), - ops.Argument: lambda _, op: sa.literal_column(op.name), + ops.Argument: lambda _, op: sa.literal_column(op.param), ops.Unnest: unary(sa.func.unnest), ops.MapGet: fixed_arity( lambda arg, key, default: sa.func.coalesce( diff --git a/core.py b/core.py index c133b44..0949855 100644 --- a/core.py +++ b/core.py @@ -10,6 +10,7 @@ import ibis.expr.datashape as ds import ibis.expr.datatypes as dt import ibis.expr.rules as rlz from ibis import util +from ibis.common.annotations import attribute from ibis.common.bases import Abstract from ibis.common.graph import Node as Traversable from ibis.common.grounds import Concrete @@ -183,5 +184,9 @@ class Argument(Value): shape: ds.DataShape dtype: dt.DataType + @attribute + def param(self) -> str: + return f"__ibis_param_{self.name}__" + public(ValueOp=Value, UnaryOp=Unary, BinaryOp=Binary, Scalar=Scalar, Column=Column) diff --git a/arrays.py b/arrays.py index 0f7f803..09e4226 100644 --- a/arrays.py +++ b/arrays.py @@ -426,11 +426,12 @@ class ArrayValue(Value): └────────────────────────┘ """ name = next(iter(inspect.signature(func).parameters.keys())) - param = f"__array_map_param_{name}__" parameter = ops.Argument( - name=param, shape=self.op().shape, dtype=self.type().value_type + name=name, shape=self.op().shape, dtype=self.type().value_type + ) + return ops.ArrayMap( + self, param=parameter.param, body=func(parameter.to_expr()) ).to_expr() - return ops.ArrayMap(self, param=param, body=func(parameter)).to_expr() def filter( self, predicate: Callable[[ir.Value], bool \| ir.BooleanValue] @@ -504,13 +505,14 @@ class ArrayValue(Value): └───────────────────────────────┘ """ name = next(iter(inspect.signature(predicate).parameters.keys())) - param = f"__array_filter_param_{name}__" parameter = ops.Argument( - name=param, + name=name, shape=self.op().shape, dtype=self.type().value_type, + ) + return ops.ArrayFilter( + self, param=parameter.param, body=predicate(parameter.to_expr()) ).to_expr() - return ops.ArrayFilter(self, param=param, body=predicate(parameter)).to_expr() def contains(self, other: ir.Value) -> ir.BooleanValue: """Return whether the array contains `other`.
refactor: make some config helpers synchronous where possible	fab757d6376fb65901cd77c48c88d60814ad8034	refactor	https://github.com/mikro-orm/mikro-orm/commit/fab757d6376fb65901cd77c48c88d60814ad8034	make some config helpers synchronous where possible	[email protected]	diff --git a/CLIConfigurator.ts b/CLIConfigurator.ts index 254348d..dba2d69 100644 --- a/CLIConfigurator.ts +++ b/CLIConfigurator.ts @@ -18,12 +18,12 @@ import { CreateDatabaseCommand } from './commands/CreateDatabaseCommand'; export class CLIConfigurator { static async configure(): Promise<Argv> { - await ConfigurationLoader.checkPackageVersion(); - const settings = await ConfigurationLoader.getSettings(); + ConfigurationLoader.checkPackageVersion(); + const settings = ConfigurationLoader.getSettings(); const version = Utils.getORMVersion(); if (settings.useTsNode) { - const tsNode = await ConfigurationLoader.registerTsNode(settings.tsConfigPath); + const tsNode = ConfigurationLoader.registerTsNode(settings.tsConfigPath); /* istanbul ignore if / if (!tsNode) { diff --git a/CLIHelper.ts b/CLIHelper.ts index 6828f42..c52e330 100644 --- a/CLIHelper.ts +++ b/CLIHelper.ts @@ -1,4 +1,4 @@ -import { pathExists } from 'fs-extra'; +import { pathExistsSync } from 'fs-extra'; import yargs from 'yargs'; import { colors, ConfigurationLoader, MikroORM, Utils, type Configuration, type IDatabaseDriver, type Options } from '@mikro-orm/core'; @@ -8,7 +8,7 @@ import { colors, ConfigurationLoader, MikroORM, Utils, type Configuration, type export class CLIHelper { static async getConfiguration<D extends IDatabaseDriver = IDatabaseDriver>(validate = true, options: Partial<Options> = {}): Promise<Configuration<D>> { - const deps = await ConfigurationLoader.getORMPackages(); + const deps = ConfigurationLoader.getORMPackages(); if (!deps.has('@mikro-orm/cli') && !process.env.MIKRO_ORM_ALLOW_GLOBAL_CLI) { throw new Error('@mikro-orm/cli needs to be installed as a local dependency!'); @@ -19,7 +19,7 @@ export class CLIHelper { static async getORM(warnWhenNoEntities?: boolean, opts: Partial<Options> = {}): Promise<MikroORM> { const options = await CLIHelper.getConfiguration(warnWhenNoEntities, opts); - const settings = await ConfigurationLoader.getSettings(); + const settings = ConfigurationLoader.getSettings(); options.set('allowGlobalContext', true); options.set('debug', !!settings.verbose); options.getLogger().setDebugMode(!!settings.verbose); @@ -69,7 +69,7 @@ export class CLIHelper { console.log(text); } - static async getConfigPaths(): Promise<string[]> { + static getConfigPaths(): string[] { return ConfigurationLoader.getConfigPaths(); } @@ -79,7 +79,7 @@ export class CLIHelper { CLIHelper.dump(` - mikro-orm ${colors.green(version)}`); CLIHelper.dump(` - node ${colors.green(CLIHelper.getNodeVersion())}`); - if (await pathExists(process.cwd() + '/package.json')) { + if (pathExistsSync(process.cwd() + '/package.json')) { const drivers = await CLIHelper.getDriverDependencies(); for (const driver of drivers) { diff --git a/DebugCommand.ts b/DebugCommand.ts index be288ba..2574383 100644 --- a/DebugCommand.ts +++ b/DebugCommand.ts @@ -14,13 +14,13 @@ export class DebugCommand implements CommandModule { async handler() { CLIHelper.dump(`Current ${colors.cyan('MikroORM')} CLI configuration`); await CLIHelper.dumpDependencies(); - const settings = await ConfigurationLoader.getSettings(); + const settings = ConfigurationLoader.getSettings(); if (settings.useTsNode) { CLIHelper.dump(' - ts-node ' + colors.green('enabled')); } - const configPaths = await CLIHelper.getConfigPaths(); + const configPaths = CLIHelper.getConfigPaths(); CLIHelper.dump(' - searched config paths:'); await DebugCommand.checkPaths(configPaths, 'yellow'); diff --git a/Configuration.ts b/Configuration.ts index 4468fa6..8656428 100644 --- a/Configuration.ts +++ b/Configuration.ts @@ -149,8 +149,8 @@ export class Configuration<D extends IDatabaseDriver = IDatabaseDriver, EM exten private readonly options: MikroORMOptions<D, EM>; private readonly logger: Logger; - private readonly driver: D; - private readonly platform: Platform; + private readonly driver!: D; + private readonly platform!: Platform; private readonly cache = new Map<string, any>(); private readonly extensions = new Map<string, () => unknown>(); @@ -173,11 +173,14 @@ export class Configuration<D extends IDatabaseDriver = IDatabaseDriver, EM exten highlighter: this.options.highlighter, writer: this.options.logger, }); - this.driver = new this.options.driver!(this); - this.platform = this.driver.getPlatform(); - this.platform.setConfig(this); - this.detectSourceFolder(options); - this.init(); + + if (this.options.driver) { + this.driver = new this.options.driver!(this); + this.platform = this.driver.getPlatform(); + this.platform.setConfig(this); + this.detectSourceFolder(options); + this.init(); + } } /* @@ -519,6 +522,7 @@ export interface MetadataDiscoveryOptions { checkDuplicateEntities?: boolean; onMetadata?: (meta: EntityMetadata, platform: Platform) => MaybePromise<void>; afterDiscovered?: (storage: MetadataStorage, platform: Platform) => MaybePromise<void>; + tsConfigPath?: string; } export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager = EntityManager> extends ConnectionOptions { diff --git a/ConfigurationLoader.ts b/ConfigurationLoader.ts index 66aa7cf..6a6b8b8 100644 --- a/ConfigurationLoader.ts +++ b/ConfigurationLoader.ts @@ -1,5 +1,5 @@ import dotenv from 'dotenv'; -import { pathExists, pathExistsSync, realpath } from 'fs-extra'; +import { pathExistsSync, readJSONSync, realpathSync } from 'fs-extra'; import { isAbsolute, join } from 'path'; import { platform } from 'os'; import { fileURLToPath } from 'url'; @@ -16,16 +16,16 @@ import type { EntityManager } from '../EntityManager'; export class ConfigurationLoader { static async getConfiguration<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = EntityManager>(validate = true, options: Partial<Options> = {}): Promise<Configuration<D, EM>> { - await this.commonJSCompat(options); + this.commonJSCompat(options); this.registerDotenv(options); - const paths = await this.getConfigPaths(); + const paths = this.getConfigPaths(); const env = this.loadEnvironmentVars(); for (let path of paths) { path = Utils.absolutePath(path); path = Utils.normalizePath(path); - if (await pathExists(path)) { + if (pathExistsSync(path)) { const config = await Utils.dynamicImport(path); /* istanbul ignore next / let tmp = config.default ?? config; @@ -38,7 +38,7 @@ export class ConfigurationLoader { tmp = await tmp; } - const esmConfigOptions = await this.isESM() ? { entityGenerator: { esmImport: true } } : {}; + const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {}; return new Configuration(Utils.mergeConfig({}, esmConfigOptions, tmp, options, env), validate); } @@ -51,17 +51,17 @@ export class ConfigurationLoader { throw new Error(`MikroORM config file not found in ['${paths.join(`', '`)}']`); } - static async getPackageConfig(basePath = process.cwd()): Promise<Dictionary> { - if (await pathExists(`${basePath}/package.json`)) { + static getPackageConfig(basePath = process.cwd()): Dictionary { + if (pathExistsSync(`${basePath}/package.json`)) { / istanbul ignore next / try { - return await Utils.dynamicImport(`${basePath}/package.json`); + return readJSONSync(`${basePath}/package.json`); } catch { return {}; } } - const parentFolder = await realpath(`${basePath}/..`); + const parentFolder = realpathSync(`${basePath}/..`); // we reached the root folder if (basePath === parentFolder) { @@ -71,8 +71,8 @@ export class ConfigurationLoader { return this.getPackageConfig(parentFolder); } - static async getSettings(): Promise<Settings> { - const config = await ConfigurationLoader.getPackageConfig(); + static getSettings(): Settings { + const config = ConfigurationLoader.getPackageConfig(); const settings = { ...config['mikro-orm'] }; const bool = (v: string) => ['true', 't', '1'].includes(v.toLowerCase()); settings.useTsNode = process.env.MIKRO_ORM_CLI_USE_TS_NODE != null ? bool(process.env.MIKRO_ORM_CLI_USE_TS_NODE) : settings.useTsNode; @@ -87,7 +87,7 @@ export class ConfigurationLoader { return settings; } - static async getConfigPaths(): Promise<string[]> { + static getConfigPaths(): string[] { const options = Utils.parseArgs(); if (options.config) { @@ -95,7 +95,7 @@ export class ConfigurationLoader { } const paths: string[] = []; - const settings = await ConfigurationLoader.getSettings(); + const settings = ConfigurationLoader.getSettings(); if (process.env.MIKRO_ORM_CLI_CONFIG) { paths.push(process.env.MIKRO_ORM_CLI_CONFIG); @@ -119,14 +119,14 @@ export class ConfigurationLoader { return Utils.unique(paths).filter(p => p.endsWith('.js') \|\| tsNode \|\| settings.alwaysAllowTs); } - static async isESM(): Promise<boolean> { - const config = await ConfigurationLoader.getPackageConfig(); + static isESM(): boolean { + const config = ConfigurationLoader.getPackageConfig(); const type = config?.type ?? ''; return type === 'module'; } - static async registerTsNode(configPath = 'tsconfig.json'): Promise<boolean> { + static registerTsNode(configPath = 'tsconfig.json'): boolean { const tsConfigPath = isAbsolute(configPath) ? configPath : join(process.cwd(), configPath); const tsNode = Utils.tryRequire({ @@ -264,8 +264,8 @@ export class ConfigurationLoader { return ret; } - static async getORMPackages(): Promise<Set<string>> { - const pkg = await this.getPackageConfig(); + static getORMPackages(): Set<string> { + const pkg = this.getPackageConfig(); return new Set([ ...Object.keys(pkg.dependencies ?? {}), ...Object.keys(pkg.devDependencies ?? {}), @@ -273,8 +273,8 @@ export class ConfigurationLoader { } /* @internal / - static async commonJSCompat(options: Partial<Options>): Promise<void> { - if (await this.isESM()) { + static commonJSCompat(options: Partial<Options>): void { + if (this.isESM()) { return; } @@ -294,7 +294,7 @@ export class ConfigurationLoader { Utils.setDynamicImportProvider(options.dynamicImportProvider); } - static async getORMPackageVersion(name: string): Promise<string \| undefined> { + static getORMPackageVersion(name: string): string \| undefined { / istanbul ignore next / try { const pkg = Utils.requireFrom(`${name}/package.json`); @@ -305,19 +305,19 @@ export class ConfigurationLoader { } // inspired by https://github.com/facebook/mikro-orm/pull/3386 - static async checkPackageVersion(): Promise<string> { + static checkPackageVersion(): string { const coreVersion = Utils.getORMVersion(); if (process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH) { return coreVersion; } - const deps = await this.getORMPackages(); + const deps = this.getORMPackages(); const exceptions = new Set(['nestjs', 'sql-highlighter', 'mongo-highlighter']); const ormPackages = [...deps].filter(d => d.startsWith('@mikro-orm/') && d !== '@mikro-orm/core' && !exceptions.has(d.substring('@mikro-orm/'.length))); for (const ormPackage of ormPackages) { - const version = await this.getORMPackageVersion(ormPackage); + const version = this.getORMPackageVersion(ormPackage); if (version != null && version !== coreVersion) { throw new Error( diff --git a/Utils.ts b/Utils.ts index 21eb89c..8c8d1dc 100644 --- a/Utils.ts +++ b/Utils.ts @@ -3,7 +3,7 @@ import globby, { type GlobbyOptions } from 'globby'; import { extname, isAbsolute, join, normalize, relative, resolve } from 'path'; import { platform } from 'os'; import { fileURLToPath, pathToFileURL, type URL } from 'url'; -import { pathExists } from 'fs-extra'; +import { pathExistsSync } from 'fs-extra'; import { createHash } from 'crypto'; import { tokenize } from 'esprima'; import { clone } from './clone'; @@ -970,7 +970,7 @@ export class Utils { return found.length > 0; } - return pathExists(path); + return pathExistsSync(path); } /* diff --git a/Migrator.ts b/Migrator.ts index 0effde3..283f708 100644 --- a/Migrator.ts +++ b/Migrator.ts @@ -1,6 +1,6 @@ import { Umzug, type InputMigrations, type MigrateDownOptions, type MigrateUpOptions, type MigrationParams, type RunnableMigration } from 'umzug'; import { basename, join } from 'path'; -import { ensureDir, pathExists, writeJSON } from 'fs-extra'; +import { ensureDir, pathExistsSync, writeJSON } from 'fs-extra'; import { t, Type, @@ -262,7 +262,7 @@ export class Migrator implements IMigrator { } protected async getSchemaFromSnapshot() { - if (!this.options.snapshot \|\| !await pathExists(this.snapshotPath)) { + if (!this.options.snapshot \|\| !pathExistsSync(this.snapshotPath)) { return undefined; } diff --git a/MikroORM.test.ts b/MikroORM.test.ts index dc9eea7..e7fd5d0 100644 --- a/MikroORM.test.ts +++ b/MikroORM.test.ts @@ -86,18 +86,18 @@ describe('MikroORM', () => { entities: [Test], driver: MongoDriver, dbName: 'mikro-orm-test', - discovery: { tsConfigPath: BASE_DIR + '/tsconfig.test.json', alwaysAnalyseProperties: false }, + discovery: { alwaysAnalyseProperties: false }, connect: false, }; - const pathExistsMock = jest.spyOn(fs as any, 'pathExists'); - pathExistsMock.mockImplementation(async path => { - const str = path as string; - return str.endsWith('.json') \|\| (str.endsWith('/mikro-orm.config.ts') && !str.endsWith('/src/mikro-orm.config.ts')); + const pathExistsMock = jest.spyOn(fs, 'pathExistsSync'); + pathExistsMock.mockImplementation(path => { + return path.endsWith('.json') \|\| (path.endsWith('/mikro-orm.config.ts') && !path.endsWith('/src/mikro-orm.config.ts')); }); jest.mock('../mikro-orm.config.ts', () => options, { virtual: true }); jest.mock(Utils.normalizePath(process.cwd()) + '/mikro-orm.config.ts', () => options, { virtual: true }); const pkg = { 'mikro-orm': { useTsNode: true } } as any; - jest.mock('../package.json', () => pkg, { virtual: true }); + jest.spyOn(require('fs-extra'), 'readJSONSync').mockImplementation(() => pkg); + jest.spyOn(Utils, 'dynamicImport').mockImplementation(async () => options); const orm = await MikroORM.init(); @@ -117,6 +117,7 @@ describe('MikroORM', () => { expect(await orm.isConnected()).toBe(false); pathExistsMock.mockRestore(); + jest.restoreAllMocks(); }); test('CLI config can export async function', async () => { diff --git a/CLIHelper.test.ts b/CLIHelper.test.ts index c89808b..9302ad6 100644 --- a/CLIHelper.test.ts +++ b/CLIHelper.test.ts @@ -44,10 +44,25 @@ process.env.FORCE_COLOR = '0'; describe('CLIHelper', () => { let pathExistsMock: jest.SpyInstance; + let readJSONMock: jest.SpyInstance; + let dynamicImportMock: jest.SpyInstance; let requireFromMock: jest.SpyInstance; beforeEach(() => { - pathExistsMock = jest.spyOn(require('fs-extra'), 'pathExists'); + const config = { driver: MongoDriver, dbName: 'foo_bar', entities: ['tests/foo'] }; + pathExistsMock = jest.spyOn(require('fs-extra'), 'pathExistsSync'); + const resolve = (path: any) => { + switch (path.substring(path.lastIndexOf('/') + 1)) { + case 'package.json': return pkg; + case 'mikro-orm.config.js': return config; + case 'mikro-orm.config.ts': return config; + case 'mikro-orm-async.config.js': return Promise.resolve(config); + case 'mikro-orm-async-catch.config.js': return Promise.reject('FooError'); + default: return undefined; + } + }; + readJSONMock = jest.spyOn(require('fs-extra'), 'readJSONSync').mockImplementation(resolve); + dynamicImportMock = jest.spyOn(Utils, 'dynamicImport').mockImplementation(resolve); requireFromMock = jest.spyOn(Utils, 'requireFrom'); }); @@ -58,6 +73,8 @@ describe('CLIHelper', () => { process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH = '1'; pathExistsMock.mockRestore(); + readJSONMock.mockRestore(); + dynamicImportMock.mockRestore(); requireFromMock.mockRestore(); }); @@ -96,7 +113,7 @@ describe('CLIHelper', () => { }); test('configures yargs instance [ts-node] without paths', async () => { - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); pkg['mikro-orm'].useTsNode = true; delete tsc.compilerOptions.paths; const registerSpy = jest.spyOn(require('ts-node'), 'register'); @@ -108,7 +125,7 @@ describe('CLIHelper', () => { }); test('configures yargs instance [ts-node and ts-paths and tsconfig.extends]', async () => { - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); pkg['mikro-orm'].useTsNode = true; pkg['mikro-orm'].tsConfigPath = './tsconfig.extended-abs.json'; const registerMock = jest.fn(); @@ -147,7 +164,7 @@ describe('CLIHelper', () => { }); test('configures yargs instance [ts-node and ts-paths] without baseUrl', async () => { - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); pkg['mikro-orm'].useTsNode = true; pkg['mikro-orm'].tsConfigPath = './tsconfig.without-baseurl.json'; delete tsc.compilerOptions.baseUrl; @@ -203,22 +220,22 @@ describe('CLIHelper', () => { test('disallows version mismatch of ORM packages', async () => { delete process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH; const spy = jest.spyOn(ConfigurationLoader, 'getORMPackages'); - spy.mockResolvedValueOnce(new Set(['@mikro-orm/weird-package'])); + spy.mockReturnValueOnce(new Set(['@mikro-orm/weird-package'])); const spy3 = jest.spyOn(Utils, 'getORMVersion'); spy3.mockReturnValue('5.0.0'); - await expect(ConfigurationLoader.checkPackageVersion()).resolves.toMatch(/^\\d+\\.\\d+\\.\\d+/); + expect(ConfigurationLoader.checkPackageVersion()).toMatch(/^\\d+\\.\\d+\\.\\d+/); - spy.mockResolvedValueOnce(new Set(['@mikro-orm/weird-package'])); + spy.mockReturnValueOnce(new Set(['@mikro-orm/weird-package'])); const spy2 = jest.spyOn(ConfigurationLoader, 'getORMPackageVersion'); - spy2.mockResolvedValueOnce('1.2.3'); + spy2.mockReturnValueOnce('1.2.3'); - await expect(ConfigurationLoader.checkPackageVersion()).rejects.toThrow(`Bad @mikro-orm/weird-package version 1.2.3. + expect(() => ConfigurationLoader.checkPackageVersion()).toThrow(`Bad @mikro-orm/weird-package version 1.2.3. All official @mikro-orm/* packages need to have the exact same version as @mikro-orm/core (5.0.0). Only exceptions are packages that don't live in the 'mikro-orm' repository: nestjs, sql-highlighter, mongo-highlighter. Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?`); - await expect(ConfigurationLoader.checkPackageVersion()).resolves.toMatch(/^\\d+\\.\\d+\\.\\d+/); + expect(ConfigurationLoader.checkPackageVersion()).toMatch(/^\\d+\\.\\d+\\.\\d+/); spy.mockRestore(); spy2.mockRestore(); spy3.mockRestore(); @@ -228,15 +245,15 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? const register = jest.fn(); register.mockReturnValueOnce({ config: { options: {} } }); requireFromMock.mockImplementation(() => ({ register })); - await expect(ConfigurationLoader.registerTsNode(__dirname + '/../tsconfig.json')).resolves.toBe(true); + expect(ConfigurationLoader.registerTsNode(__dirname + '/../tsconfig.json')).toBe(true); register.mockReturnValue({ config: {} }); - await expect(ConfigurationLoader.registerTsNode(__dirname + '/../tsconfig.json')).resolves.toBe(true); - await expect(ConfigurationLoader.registerTsNode('./tests/tsconfig.json')).resolves.toBe(true); + expect(ConfigurationLoader.registerTsNode(__dirname + '/../tsconfig.json')).toBe(true); + expect(ConfigurationLoader.registerTsNode('./tests/tsconfig.json')).toBe(true); register.mockRestore(); }); test('gets ORM configuration [no package.json]', async () => { - pathExistsMock.mockImplementation(async path => { + pathExistsMock.mockImplementation(path => { const str = path as string; return str.includes('/mikro-orm.config.js') && !str.includes('/src/mikro-orm.config.js'); }); @@ -247,7 +264,7 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? }); test('gets ORM configuration [from package.json] with promise', async () => { - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); pkg['mikro-orm'].configPaths = [`${Utils.normalizePath(process.cwd())}/mikro-orm-async.config.js`]; const conf = await CLIHelper.getConfiguration(); expect(conf).toBeInstanceOf(Configuration); @@ -258,7 +275,7 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? test('gets ORM configuration [from package.json] with rejected promise', async () => { expect.assertions(1); - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); pkg['mikro-orm'].configPaths = [`${Utils.normalizePath(process.cwd())}/mikro-orm-async-catch.config.js`]; await expect(CLIHelper.getConfiguration()).rejects.toEqual('FooError'); delete pkg['mikro-orm'].configPaths; @@ -375,7 +392,7 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? }); test('getModuleVersion', async () => { - pathExistsMock.mockResolvedValue(false); + pathExistsMock.mockReturnValue(false); await expect(CLIHelper.getModuleVersion('pg')).resolves.not.toBe('not-found'); await expect(CLIHelper.getModuleVersion('does-not-exist')).resolves.toBe('not-found'); }); @@ -402,7 +419,7 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? (global as any).process.cwd = cwd; logSpy.mock.calls.length = 0; - pathExistsMock.mockResolvedValue(true); + pathExistsMock.mockReturnValue(true); const getDriverDependencies = CLIHelper.getDriverDependencies; CLIHelper.getDriverDependencies = async () => ['mongodb']; await CLIHelper.dumpDependencies(); @@ -423,13 +440,13 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? }); pkg['mikro-orm'] = undefined; - await expect(ConfigurationLoader.getSettings()).resolves.toEqual({}); + expect(ConfigurationLoader.getSettings()).toEqual({}); await expect(ConfigurationLoader.getConfiguration()).resolves.toBeInstanceOf(Configuration); process.env.MIKRO_ORM_CLI_USE_TS_NODE = '1'; process.env.MIKRO_ORM_CLI_TS_CONFIG_PATH = 'foo/tsconfig.json'; process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS = '1'; - await expect(ConfigurationLoader.getSettings()).resolves.toEqual({ + expect(ConfigurationLoader.getSettings()).toEqual({ useTsNode: true, alwaysAllowTs: true, tsConfigPath: 'foo/tsconfig.json', @@ -450,44 +467,12 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? pkg['mikro-orm'] = undefined; }); - test('getConfigPaths', async () => { - (global as any).process.argv = ['node', 'start.js', '--config', './override1/orm-config.ts']; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./override1/orm-config.ts']); - (global as any).process.argv = ['node', 'start.js', '--config=./override2/orm-config.ts']; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./override2/orm-config.ts']); - (global as any).process.argv = ['npx', 'mikro-orm', 'debug', '--config', './override3/orm-config.ts']; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./override3/orm-config.ts']); - (global as any).process.argv = ['node', 'start.js']; - (global as any).process.env.MIKRO_ORM_CLI_CONFIG = './override/orm-config.ts'; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./override/orm-config.ts', './src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); - delete (global as any).process.env.MIKRO_ORM_CLI_CONFIG; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./src/mikro-orm.config.js', './mikro-orm.config.js']); - - (global as any).process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS = '1'; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); - delete (global as any).process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS; - - pkg['mikro-orm'] = { alwaysAllowTs: true }; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); - pkg['mikro-orm'] = undefined; - - pathExistsMock.mockResolvedValue(true); - pkg['mikro-orm'] = { configPaths: ['orm-config'] }; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['orm-config', './src/mikro-orm.config.js', './mikro-orm.config.js']); - - pkg['mikro-orm'].useTsNode = true; - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['orm-config', './src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); - - pathExistsMock.mockResolvedValue(false); - await expect(CLIHelper.getConfigPaths()).resolves.toEqual(['./src/mikro-orm.config.js', './mikro-orm.config.js']); - }); - test('isESM', async () => { - await expect(ConfigurationLoader.isESM()).resolves.toEqual(false); + expect(ConfigurationLoader.isESM()).toBe(false); const packageSpy = jest.spyOn(ConfigurationLoader, 'getPackageConfig'); - packageSpy.mockResolvedValue({ type: 'module' }); - await expect(ConfigurationLoader.isESM()).resolves.toEqual(true); + packageSpy.mockReturnValue({ type: 'module' }); + expect(ConfigurationLoader.isESM()).toBe(true); pathExistsMock.mockImplementation(async path => { const str = path as string; return str.includes('/mikro-orm.config.js') && !str.includes('/src/mikro-orm.config.js'); @@ -524,4 +509,36 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file? }); await expect(CLIHelper.isDBConnected()).resolves.toEqual(true); }); + + test('getConfigPaths', async () => { + (global as any).process.argv = ['node', 'start.js', '--config', './override1/orm-config.ts']; + expect(CLIHelper.getConfigPaths()).toEqual(['./override1/orm-config.ts']); + (global as any).process.argv = ['node', 'start.js', '--config=./override2/orm-config.ts']; + expect(CLIHelper.getConfigPaths()).toEqual(['./override2/orm-config.ts']); + (global as any).process.argv = ['npx', 'mikro-orm', 'debug', '--config', './override3/orm-config.ts']; + expect(CLIHelper.getConfigPaths()).toEqual(['./override3/orm-config.ts']); + (global as any).process.argv = ['node', 'start.js']; + (global as any).process.env.MIKRO_ORM_CLI_CONFIG = './override/orm-config.ts'; + expect(CLIHelper.getConfigPaths()).toEqual(['./override/orm-config.ts', './src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); + delete (global as any).process.env.MIKRO_ORM_CLI_CONFIG; + expect(CLIHelper.getConfigPaths()).toEqual(['./src/mikro-orm.config.js', './mikro-orm.config.js']); + + (global as any).process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS = '1'; + expect(CLIHelper.getConfigPaths()).toEqual(['./src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); + delete (global as any).process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS; + + pkg['mikro-orm'] = { alwaysAllowTs: true }; + expect(CLIHelper.getConfigPaths()).toEqual(['./src/mikro-orm.config.ts', './mikro-orm.config.ts', './src/mikro-orm.config.js', './mikro-orm.config.js']); + pkg['mikro-orm'] = undefined; + + pathExistsMock.mockReturnValue(true); + pkg['mikro-orm'] = { configPaths: ['orm-config'] }; + expect(CLIHelper.getConfigPaths()).toEqual(['orm-config', './dist/mikro-orm.config.js', './mikro-orm.config.js']); + + pkg['mikro-orm'].useTsNode = true; + expect(CLIHelper.getConfigPaths()).toEqual(['orm-config', './src/mikro-orm.config.ts', './mikro-orm.config.ts', './dist/mikro-orm.config.js', './mikro-orm.config.js']); + + pathExistsMock.mockReturnValue(false); + expect(CLIHelper.getConfigPaths()).toEqual(['./src/mikro-orm.config.js', './mikro-orm.config.js']); + }); }); diff --git a/DebugCommand.test.ts b/DebugCommand.test.ts index 9f51625..afdfb45 100644 --- a/DebugCommand.test.ts +++ b/DebugCommand.test.ts @@ -27,9 +27,9 @@ describe('DebugCommand', () => { const globbyMock = jest.spyOn(Utils, 'pathExists'); globbyMock.mockResolvedValue(true); - getSettings.mockResolvedValue({}); + getSettings.mockReturnValue({}); getConfiguration.mockResolvedValue(new Configuration({ driver: MongoDriver } as any, false)); - getConfigPaths.mockResolvedValue(['./path/orm-config.ts']); + getConfigPaths.mockReturnValue(['./path/orm-config.ts']); await expect(cmd.handler()).resolves.toBeUndefined(); expect(dumpDependencies).toHaveBeenCalledTimes(1); expect(dump.mock.calls).toEqual([ @@ -40,7 +40,7 @@ describe('DebugCommand', () => { [' - database connection succesful'], ]); - getSettings.mockResolvedValue({ useTsNode: true }); + getSettings.mockReturnValue({ useTsNode: true }); globbyMock.mockImplementation(async (path: string) => path.endsWith('entities-1') \|\| path.endsWith('orm-config.ts')); getConfiguration.mockResolvedValue(new Configuration({ driver: MongoDriver, tsNode: true, entities: ['./dist/entities-1', './dist/entities-2'], entitiesTs: ['./src/entities-1', './src/entities-2'] } as any, false)); dump.mock.calls.length = 0; @@ -106,9 +106,9 @@ describe('DebugCommand', () => { globbyMock.mockResolvedValue(false); dump.mock.calls.length = 0; - getSettings.mockResolvedValue({}); + getSettings.mockReturnValue({}); getConfiguration.mockResolvedValue(new Configuration({ driver: MongoDriver } as any, false)); - getConfigPaths.mockResolvedValue(['./path/orm-config.ts']); + getConfigPaths.mockReturnValue(['./path/orm-config.ts']); const connectionMock = jest.spyOn(CLIHelper, 'isDBConnected'); connectionMock.mockImplementation(async () => false); await expect(cmd.handler()).resolves.toBeUndefined();
refactor: tweak jsdom settings a bit 3	643f01b67a2c1faf57f42b0c71b461873e7c009d	refactor	https://github.com/Hardeepex/crawlee/commit/643f01b67a2c1faf57f42b0c71b461873e7c009d	tweak jsdom settings a bit 3	[email protected]	diff --git a/jsdom-crawler.ts b/jsdom-crawler.ts index 859bc43..d1bdf41 100644 --- a/jsdom-crawler.ts +++ b/jsdom-crawler.ts @@ -233,7 +233,7 @@ export class JSDOMCrawler extends HttpCrawler<JSDOMCrawlingContext> { }), }); window.document.createRange = () => { - const range = new Range(); + const range = new window.Range(); range.getBoundingClientRect = () => ({} as any); range.getClientRects = () => ({ item: () => null as any, length: 0 }) as any; return range;
fix(native): force render when "children" is animated Fixes #758	85e9bf1c562b9a44859595cb557373eb8874bd0a	fix	https://github.com/pmndrs/react-spring/commit/85e9bf1c562b9a44859595cb557373eb8874bd0a	force render when "children" is animated Fixes #758	[email protected]	diff --git a/index.ts b/index.ts index d6d3f20..d043740 100644 --- a/index.ts +++ b/index.ts @@ -9,8 +9,13 @@ Globals.assign({ defaultElement: View, colorNames, createStringInterpolator, - applyAnimatedValues: (instance, props) => - instance.setNativeProps ? instance.setNativeProps(props) : false, + applyAnimatedValues(instance, props) { + if (is.und(props.children) && instance.setNativeProps) { + instance.setNativeProps(props) + return true + } + return false + }, createAnimatedTransform: transform => new AnimatedTransform(transform), createAnimatedStyle(styles) { styles = StyleSheet.flatten(styles)
fix(core): allow populating FK as PK in `toJSON()` Previously when entity was used as PK, it was always serialized to that entity PK. With this fix, it will respect the populate parameter.	e05d780e8d1cb5a6506aaf12f4c7faec559dbff6	fix	https://github.com/mikro-orm/mikro-orm/commit/e05d780e8d1cb5a6506aaf12f4c7faec559dbff6	allow populating FK as PK in `toJSON()` Previously when entity was used as PK, it was always serialized to that entity PK. With this fix, it will respect the populate parameter.	[email protected]	diff --git a/EntityTransformer.ts b/EntityTransformer.ts index cd67c8f..a5f5429 100644 --- a/EntityTransformer.ts +++ b/EntityTransformer.ts @@ -15,8 +15,18 @@ export class EntityTransformer { meta.primaryKeys .filter(pk => !Utils.isDefined(entity[pk], true) \|\| !(meta.properties[pk].hidden \|\| ignoreFields.includes(pk))) - .map(pk => [pk, Utils.getPrimaryKeyValue<T>(entity, [pk])] as [string, string]) - .forEach(([pk, value]) => ret[platform.getSerializedPrimaryKeyField(pk) as keyof T] = platform.normalizePrimaryKey(value)); + .map(pk => { + let value: unknown; + + if (Utils.isEntity(entity[pk], true)) { + value = EntityTransformer.processEntity(pk, entity, ignoreFields, visited); + } else { + value = platform.normalizePrimaryKey(Utils.getPrimaryKeyValue<T>(entity, [pk])); + } + + return [pk, value] as [string, string]; + }) + .forEach(([pk, value]) => ret[platform.getSerializedPrimaryKeyField(pk) as keyof T] = value as unknown as T[keyof T]); if ((!wrapped.isInitialized() && Utils.isDefined(wrapped.__primaryKey, true)) \|\| visited.includes(wrapped.__uuid)) { return ret; @@ -63,7 +73,7 @@ export class EntityTransformer { return EntityTransformer.processCollection(prop, entity); } - if (Utils.isEntity(entity[prop]) \|\| entity[prop] as unknown instanceof Reference) { + if (Utils.isEntity(entity[prop], true)) { return EntityTransformer.processEntity(prop, entity, ignoreFields, visited); } diff --git a/wrap.ts b/wrap.ts index 9c0ec15..d20c9ef 100644 --- a/wrap.ts +++ b/wrap.ts @@ -1,6 +1,5 @@ import { Dictionary, IWrappedEntity, IWrappedEntityInternal } from '../typings'; import { ArrayCollection } from './ArrayCollection'; -import { WrappedEntity } from './WrappedEntity'; import { BaseEntity } from './BaseEntity'; /** diff --git a/composite-keys.mysql.test.ts b/composite-keys.mysql.test.ts index ad3c6fe..c9d71fa 100644 --- a/composite-keys.mysql.test.ts +++ b/composite-keys.mysql.test.ts @@ -35,7 +35,11 @@ describe('composite keys in mysql', () => { await orm.em.persistAndFlush(param); orm.em.clear(); - const p1 = await orm.em.findOneOrFail(FooParam2, [param.bar.id, param.baz.id]); + // test populating a PK + const p1 = await orm.em.findOneOrFail(FooParam2, [param.bar.id, param.baz.id], ['bar']); + expect(wrap(p1).toJSON().bar).toMatchObject(wrap(p1.bar).toJSON()); + expect(wrap(p1).toJSON().baz).toBe(p1.baz.id); + expect(p1.bar.id).toBe(bar.id); expect(p1.baz.id).toBe(baz.id); expect(p1.value).toBe('val');
build: added sort-imports to presets build: renamed main/tsParticles parameters to engine to match the type	7bc8a22b08683df17a046195171965554775e1ad	build	https://github.com/tsparticles/tsparticles/commit/7bc8a22b08683df17a046195171965554775e1ad	added sort-imports to presets build: renamed main/tsParticles parameters to engine to match the type	[email protected]	diff --git a/index.d.ts b/index.d.ts index 8dd8578..a247bdd 100644 --- a/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ export interface IParticlesProps { className?: string; canvasClassName?: string; container?: { current: Container; }; - init?: (tsParticles: Engine) => Promise<void>; + init?: (engine: Engine) => Promise<void>; loaded?: (container: Container) => Promise<void>; } diff --git a/IParticlesProps.ts b/IParticlesProps.ts index 557d41d..6b6973b 100644 --- a/IParticlesProps.ts +++ b/IParticlesProps.ts @@ -12,6 +12,6 @@ export interface IParticlesProps { className?: string; canvasClassName?: string; container?: { current: Container }; - init?: (tsParticles: Engine) => Promise<void>; + init?: (engine: Engine) => Promise<void>; loaded?: (container: Container) => Promise<void>; } diff --git a/index.ts b/index.ts index b541f30..afeddb7 100644 --- a/index.ts +++ b/index.ts @@ -1,6 +1,6 @@ import type { Engine } from "tsparticles"; import { OrbitUpdater } from "./OrbitUpdater"; -export function loadOrbitUpdater(tsParticles: Engine): void { - tsParticles.addParticleUpdater("orbit", (container) => new OrbitUpdater(container)); +export function loadOrbitUpdater(engine: Engine): void { + engine.addParticleUpdater("orbit", (container) => new OrbitUpdater(container)); } diff --git a/interaction.ts b/interaction.ts index 553a591..e10cf70 100644 --- a/interaction.ts +++ b/interaction.ts @@ -1,6 +1,6 @@ import type { Engine } from "../../../engine"; import { Linker } from "./Linker"; -export async function loadInteraction(tsParticles: Engine): Promise<void> { - await tsParticles.addInteractor("particlesLinks", (container) => new Linker(container)); +export async function loadInteraction(engine: Engine): Promise<void> { + await engine.addInteractor("particlesLinks", (container) => new Linker(container)); } diff --git a/plugin.ts b/plugin.ts index 84d4c39..90b63f2 100644 --- a/plugin.ts +++ b/plugin.ts @@ -22,8 +22,8 @@ class LinksPlugin implements IPlugin { } } -export async function loadPlugin(tsParticles: Engine): Promise<void> { +export async function loadPlugin(engine: Engine): Promise<void> { const plugin = new LinksPlugin(); - await tsParticles.addPlugin(plugin); + await engine.addPlugin(plugin); } diff --git a/.eslintrc.js b/.eslintrc.js index c7ececa..801636d 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -14,8 +14,15 @@ module.exports = { "@typescript-eslint/no-explicit-any": "warn", "@typescript-eslint/no-var-requires": "warn", "@typescript-eslint/ban-types": "warn", - "@typescript-eslint/explicit-member-accessibility": ["error", { + "@typescript-eslint/explicit-member-accessibility": [ "error", { "accessibility": "no-public" - }] + } ], + "sort-imports": [ "error", { + "ignoreCase": false, + "ignoreDeclarationSort": false, + "ignoreMemberSort": false, + "memberSyntaxSortOrder": [ "none", "all", "multiple", "single" ], + "allowSeparatedGroups": false + } ] } }; diff --git a/bundle.ts b/bundle.ts index ed035cf..22bf8c6 100644 --- a/bundle.ts +++ b/bundle.ts @@ -1,5 +1,5 @@ -import { tsParticles } from "tsparticles"; import { loadTrianglesPreset } from "."; +import { tsParticles } from "tsparticles"; loadTrianglesPreset(tsParticles); diff --git a/options.ts b/options.ts index 7d134a6..9d86d54 100644 --- a/options.ts +++ b/options.ts @@ -1,5 +1,5 @@ -import type { ISourceOptions } from "tsparticles"; import { DestroyMode, MoveDirection, OutMode } from "tsparticles"; +import type { ISourceOptions } from "tsparticles"; export const options: ISourceOptions = { fpsLimit: 60, diff --git a/ConfettiOptions.ts b/ConfettiOptions.ts index fee9112..acc618a 100644 --- a/ConfettiOptions.ts +++ b/ConfettiOptions.ts @@ -1,7 +1,7 @@ -import type { IConfettiOptions } from "./IConfettiOptions"; -import type { IOptionLoader } from "tsparticles/Options/Interfaces/IOptionLoader"; import type { RecursivePartial, SingleOrMultiple } from "tsparticles"; +import type { IConfettiOptions } from "./IConfettiOptions"; import type { ICoordinates } from "tsparticles/Core/Interfaces/ICoordinates"; +import type { IOptionLoader } from "tsparticles/Options/Interfaces/IOptionLoader"; export class ConfettiOptions implements IConfettiOptions, IOptionLoader<IConfettiOptions> { /** diff --git a/preset.ts b/preset.ts index 3c65b67..1625658 100644 --- a/preset.ts +++ b/preset.ts @@ -1,10 +1,10 @@ import type { Engine, RecursivePartial } from "tsparticles"; import { IConfettiOptions } from "./IConfettiOptions"; -import { tsParticles } from "tsparticles"; import { loadOptions } from "./options"; +import { tsParticles } from "tsparticles"; -function loadPreset(main: Engine, confettiOptions: RecursivePartial<IConfettiOptions>, override = false): void { - main.addPreset("confetti", loadOptions(confettiOptions), override); +function loadPreset(engine: Engine, confettiOptions: RecursivePartial<IConfettiOptions>, override = false): void { + engine.addPreset("confetti", loadOptions(confettiOptions), override); } export function loadConfettiPreset(main: Engine): void { diff --git a/shape.ts b/shape.ts index 9137099..c348345 100644 --- a/shape.ts +++ b/shape.ts @@ -1,6 +1,6 @@ import type { Engine } from "tsparticles"; import { SpiralDrawer } from "./SpiralDrawer"; -export function loadSpiralShape(tsParticles: Engine): void { - tsParticles.addShape("spiral", new SpiralDrawer()); +export function loadSpiralShape(engine: Engine): void { + engine.addShape("spiral", new SpiralDrawer()); }
feat: moved out click interactions to external packages, breaking	466973ddbcc382c27c03f7b3518dea99c5e1949c	feat	https://github.com/tsparticles/tsparticles/commit/466973ddbcc382c27c03f7b3518dea99c5e1949c	moved out click interactions to external packages, breaking	[email protected]	diff --git a/package.dist.json b/package.dist.json index 7768e32..c2807c5 100644 --- a/package.dist.json +++ b/package.dist.json @@ -45,6 +45,12 @@ "module": "index.js", "types": "index.d.ts", "dependencies": { - "tsparticles-engine": "^1.35.1" + "tsparticles-engine": "^1.35.1", + "tsparticles-interaction-external-push": "^1.35.1", + "tsparticles-shape-circle": "^1.20.1", + "tsparticles-updater-color": "^1.35.1", + "tsparticles-updater-opacity": "^1.35.1", + "tsparticles-updater-out-modes": "^1.35.1", + "tsparticles-updater-size": "^1.35.1" } } \\ No newline at end of file diff --git a/package.json b/package.json index 9394bcb..f59e883 100644 --- a/package.json +++ b/package.json @@ -71,6 +71,12 @@ "webpack-tsparticles-plugin": "^1.0.0" }, "dependencies": { - "tsparticles-engine": "^1.35.1" + "tsparticles-engine": "^1.35.1", + "tsparticles-interaction-external-push": "^1.35.1", + "tsparticles-shape-circle": "^1.20.1", + "tsparticles-updater-color": "^1.35.1", + "tsparticles-updater-opacity": "^1.35.1", + "tsparticles-updater-out-modes": "^1.35.1", + "tsparticles-updater-size": "^1.35.1" } } diff --git a/index.ts b/index.ts index 2d7375c..3134234 100644 --- a/index.ts +++ b/index.ts @@ -1,6 +1,19 @@ import type { Main } from "tsparticles-engine"; import { options } from "./options"; +import { loadColorUpdater } from "tsparticles-updater-color"; +import { loadOpacityUpdater } from "tsparticles-updater-opacity"; +import { loadSizeUpdater } from "tsparticles-updater-size"; +import { loadExternalPushInteraction } from "tsparticles-interaction-external-push"; +import { loadCircleShape } from "tsparticles-shape-circle"; +import { loadOutModesUpdater } from "tsparticles-updater-out-modes"; export function loadFirePreset(tsParticles: Main): void { + loadExternalPushInteraction(tsParticles); + loadCircleShape(tsParticles); + loadColorUpdater(tsParticles); + loadOpacityUpdater(tsParticles); + loadOutModesUpdater(tsParticles); + loadSizeUpdater(tsParticles); + tsParticles.addPreset("fire", options); } diff --git a/Container.ts b/Container.ts index 1b70972..f499bf9 100644 --- a/Container.ts +++ b/Container.ts @@ -23,6 +23,7 @@ import { IRgb, IShapeDrawer, } from "./Interfaces"; +import { ClickMode } from "../Enums"; /** * The object loaded into an HTML element, it'll contain options loaded and all data to let everything working @@ -550,6 +551,16 @@ export class Container { el.addEventListener("touchcancel", touchCancelHandler); } + handleClickMode(mode: ClickMode \| string) { + this.particles.handleClickMode(mode); + + for (const [, plugin] of this.plugins) { + if (plugin.handleClickMode) { + plugin.handleClickMode(mode); + } + } + } + updateActualOptions(): void { this.actualOptions.setResponsive(this.canvas.size.width, this.retina.pixelRatio, this._options); this.actualOptions.setTheme(this.currentTheme); diff --git a/ExternalInteractorBase.ts b/ExternalInteractorBase.ts index 15714d9..a822f39 100644 --- a/ExternalInteractorBase.ts +++ b/ExternalInteractorBase.ts @@ -1,7 +1,7 @@ import type { IDelta, IExternalInteractor } from "./Interfaces"; import type { Particle } from "./Particle"; import type { Container } from "./Container"; -import { InteractorType } from "../Enums"; +import { ClickMode, InteractorType } from "../Enums"; export abstract class ExternalInteractorBase implements IExternalInteractor { protected constructor(protected readonly container: Container) {} diff --git a/InteractionManager.ts b/InteractionManager.ts index f8b4624..3fdddb4 100644 --- a/InteractionManager.ts +++ b/InteractionManager.ts @@ -1,6 +1,7 @@ import type { Container } from "./Container"; import type { Particle } from "./Particle"; import type { IDelta, IExternalInteractor, IParticlesInteractor } from "./Interfaces"; +import type { ClickMode } from "../Enums"; import { Plugins } from "../Utils"; import { InteractorType } from "../Enums"; @@ -49,4 +50,12 @@ export class InteractionManager { } } } + + handleClickMode(mode: ClickMode \| string): void { + for (const interactor of this.externalInteractors) { + if (interactor.handleClickMode) { + interactor.handleClickMode(mode); + } + } + } } diff --git a/IExternalInteractor.ts b/IExternalInteractor.ts index 2f6f11e..d82517a 100644 --- a/IExternalInteractor.ts +++ b/IExternalInteractor.ts @@ -1,10 +1,13 @@ import type { IInteractor } from "./IInteractor"; import type { IDelta } from "./IDelta"; +import { ClickMode } from "../../Enums"; /** * @category Interfaces / export interface IExternalInteractor extends IInteractor { + handleClickMode?: (mode: ClickMode \| string) => void; + isEnabled(): boolean; interact(delta: IDelta): void; diff --git a/Particles.ts b/Particles.ts index 5e0ec26..b9a0c97 100644 --- a/Particles.ts +++ b/Particles.ts @@ -1,6 +1,15 @@ import type { Container } from "./Container"; import { Particle } from "./Particle"; -import { getRangeValue, Plugins, Point, QuadTree, randomInRange, Rectangle, setRangeValue } from "../Utils"; +import { + getRangeValue, + itemFromArray, + Plugins, + Point, + QuadTree, + randomInRange, + Rectangle, + setRangeValue, +} from "../Utils"; import type { RecursivePartial } from "../Types"; import type { IParticles } from "../Options/Interfaces/Particles/IParticles"; import { InteractionManager } from "./InteractionManager"; @@ -9,6 +18,7 @@ import { ParticlesOptions } from "../Options/Classes/Particles/ParticlesOptions" import type { ICoordinates, IDelta, IMouseData, IParticle, IRgb } from "./Interfaces"; import { Mover } from "./Particle/Mover"; import { IParticlesFrequencies } from "./Interfaces/IParticlesFrequencies"; +import { ClickMode } from "../Enums"; /* * Particles manager object @@ -425,6 +435,10 @@ export class Particles { this.applyDensity(options.particles, options.manualParticles.length); } + handleClickMode(mode: ClickMode \| string) { + this.interactionManager.handleClickMode(mode); + } + private applyDensity(options: IParticles, manualCount: number, group?: string) { if (!options.number.density?.enable) { return; diff --git a/EventListeners.ts b/EventListeners.ts index f63df7e..2bb09df 100644 --- a/EventListeners.ts +++ b/EventListeners.ts @@ -422,80 +422,6 @@ export class EventListeners { } private handleClickMode(mode: ClickMode \| string): void { - const container = this.container; - const options = container.actualOptions; - const pushNb = options.interactivity.modes.push.quantity; - const removeNb = options.interactivity.modes.remove.quantity; - - switch (mode) { - case ClickMode.push: { - if (pushNb > 0) { - const pushOptions = options.interactivity.modes.push; - const group = itemFromArray([undefined, ...pushOptions.groups]); - const groupOptions = - group !== undefined ? container.actualOptions.particles.groups[group] : undefined; - - container.particles.push(pushNb, container.interactivity.mouse, groupOptions, group); - } - - break; - } - case ClickMode.remove: - container.particles.removeQuantity(removeNb); - break; - case ClickMode.bubble: - container.bubble.clicking = true; - break; - case ClickMode.repulse: - container.repulse.clicking = true; - container.repulse.count = 0; - - for (const particle of container.repulse.particles) { - particle.velocity.setTo(particle.initialVelocity); - } - - container.repulse.particles = []; - container.repulse.finish = false; - - setTimeout(() => { - if (!container.destroyed) { - container.repulse.clicking = false; - } - }, options.interactivity.modes.repulse.duration * 1000); - - break; - case ClickMode.attract: - container.attract.clicking = true; - container.attract.count = 0; - - for (const particle of container.attract.particles) { - particle.velocity.setTo(particle.initialVelocity); - } - - container.attract.particles = []; - container.attract.finish = false; - - setTimeout(() => { - if (!container.destroyed) { - container.attract.clicking = false; - } - }, options.interactivity.modes.attract.duration * 1000); - - break; - case ClickMode.pause: - if (container.getAnimationStatus()) { - container.pause(); - } else { - container.play(); - } - - break; - } - - for (const [, plugin] of container.plugins) { - if (plugin.handleClickMode) { - plugin.handleClickMode(mode); - } - } + this.container.handleClickMode(mode); } } diff --git a/Attractor.ts b/Attractor.ts index f961012..40b9231 100644 --- a/Attractor.ts +++ b/Attractor.ts @@ -18,8 +18,34 @@ import { * @category Interactions / export class Attractor extends ExternalInteractorBase { + handleClickMode: (mode: string) => void; + constructor(container: Container) { super(container); + + this.handleClickMode = (mode) => { + const options = this.container.actualOptions; + + if (mode !== ClickMode.attract) { + return; + } + + container.attract.clicking = true; + container.attract.count = 0; + + for (const particle of container.attract.particles) { + particle.velocity.setTo(particle.initialVelocity); + } + + container.attract.particles = []; + container.attract.finish = false; + + setTimeout(() => { + if (!container.destroyed) { + container.attract.clicking = false; + } + }, options.interactivity.modes.attract.duration 1000); + }; } isEnabled(): boolean { diff --git a/Bubbler.ts b/Bubbler.ts index 53e2539..f521693 100644 --- a/Bubbler.ts +++ b/Bubbler.ts @@ -47,8 +47,18 @@ function calculateBubbleValue( * @category Interactions / export class Bubbler extends ExternalInteractorBase { + handleClickMode: (mode: ClickMode \| string) => void; + constructor(container: Container) { super(container); + + this.handleClickMode = (mode) => { + if (mode !== ClickMode.bubble) { + return; + } + + container.bubble.clicking = true; + }; } isEnabled(): boolean { diff --git a/.eslintignore b/.eslintignore index 167c229..6cb1af2 100644 --- a/.eslintignore +++ b/.eslintignore @@ -0,0 +1,2 @@ +dist +node_modules \\ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index 63eb16d..a6cd15d 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -0,0 +1,18 @@ +module.exports = { + root: true, + parser: "@typescript-eslint/parser", + plugins: [ + "@typescript-eslint" + ], + extends: [ + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", + "plugin:@typescript-eslint/recommended", + "prettier" + ], + rules: { + "@typescript-eslint/no-explicit-any": 1, + "@typescript-eslint/no-var-requires": 1, + "@typescript-eslint/ban-types": 1 + } +}; \\ No newline at end of file diff --git a/.npmignore b/.npmignore index 226455d..b49d4f7 100644 --- a/.npmignore +++ b/.npmignore @@ -0,0 +1 @@ +report.html \\ No newline at end of file diff --git a/.prettierrc b/.prettierrc index caa2d57..cc77cfe 100644 --- a/.prettierrc +++ b/.prettierrc @@ -0,0 +1,12 @@ +{ + "printWidth": 120, + "endOfLine": "lf", + "overrides": [ + { + "files": ".ts", + "options": { + "tabWidth": 4 + } + } + ] +} \\ No newline at end of file diff --git a/LICENSE b/LICENSE index 7e03f4e..b2c5214 100644 --- a/LICENSE +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Matteo Bruni + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 373df17..b055162 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,5 @@ +[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org) + +# tsparticles-interaction-particles-remove + +tsParticles interaction particles remove diff --git a/distfiles.js b/distfiles.js index 871e203..9cebecb 100644 --- a/distfiles.js +++ b/distfiles.js @@ -0,0 +1,27 @@ +const fs = require("fs"); +const mainInfo = require("../package.json"); + +const libPackage = "./package.dist.json"; + +fs.readFile(libPackage, function (error, data) { + if (error) { + throw error; + } + + const text = data.toString(); + const libObj = JSON.parse(text); + + libObj.version = mainInfo.version; + libObj.dependencies = JSON.parse(JSON.stringify(mainInfo.dependencies)); + + fs.writeFileSync(libPackage, JSON.stringify(libObj, undefined, 2), "utf8"); + + console.log(`package.dist.json updated successfully to version ${mainInfo.version}`); + + fs.copyFileSync("./README.md", "./dist/README.md"); + fs.copyFileSync("./package.dist.json", "./dist/package.json"); + + if (!fs.existsSync("./dist/scripts")) { + fs.mkdirSync("./dist/scripts"); + } +}); diff --git a/Pauser.ts b/Pauser.ts index b3528f4..5e5cdd3 100644 --- a/Pauser.ts +++ b/Pauser.ts @@ -0,0 +1,40 @@ +import type { Container } from "tsparticles-engine"; +import { ExternalInteractorBase, ClickMode } from "tsparticles-engine"; + +/** + * Particle attract manager + * @category Interactions + / +export class Pauser extends ExternalInteractorBase { + handleClickMode: (mode: string) => void; + + constructor(container: Container) { + super(container); + + this.handleClickMode = (mode) => { + if (mode !== ClickMode.pause) { + return; + } + + const container = this.container; + + if (container.getAnimationStatus()) { + container.pause(); + } else { + container.play(); + } + }; + } + + isEnabled(): boolean { + return true; + } + + reset(): void { + // do nothing + } + + interact(): void { + // do nothing + } +} diff --git a/tsconfig.json b/tsconfig.json index 0a0296f..9197413 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -0,0 +1,88 @@ +{ + "compilerOptions": { + / Basic Options / + // "incremental": true, / Enable incremental compilation / + "target": "es6", + / Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. / + "module": "esnext", + / Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. / + "lib": [ + "ESNext", + "ES2020", + "ES2019", + "ES2018", + "ES2017", + "ES2016", + "ES2015", + "DOM" + ], + / Specify library files to be included in the compilation. / + // "allowJs": true, / Allow javascript files to be compiled. / + // "checkJs": true, / Report errors in .js files. / + // "jsx": "preserve", / Specify JSX code generation: 'preserve', 'react-native', or 'react'. / + "declaration": true, + / Generates corresponding '.d.ts' file. / + // "declarationMap": true, / Generates a sourcemap for each corresponding '.d.ts' file. / + // "sourceMap": true, / Generates corresponding '.map' file. / + // "outFile": "./", / Concatenate and emit output to single file. / + "outDir": "./dist", + / Redirect output structure to the directory. / + "rootDir": "./src", + / Specify the root directory of input files. Use to control the output directory structure with --outDir. / + // "composite": true, / Enable project compilation / + // "tsBuildInfoFile": "./", / Specify file to store incremental compilation information / + "removeComments": true, + / Do not emit comments to output. / + // "noEmit": true, / Do not emit outputs. / + "importHelpers": false, + / Import emit helpers from 'tslib'. / + // "downlevelIteration": true, / Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. / + // "isolatedModules": true, / Transpile each file as a separate module (similar to 'ts.transpileModule'). / + + / Strict Type-Checking Options / + "strict": true, + / Enable all strict type-checking options. / + "noImplicitAny": true, + / Raise error on expressions and declarations with an implied 'any' type. / + "strictNullChecks": true, + / Enable strict null checks. / + // "strictFunctionTypes": true, / Enable strict checking of function types. / + // "strictBindCallApply": true, / Enable strict 'bind', 'call', and 'apply' methods on functions. / + "strictPropertyInitialization": true, + / Enable strict checking of property initialization in classes. / + // "noImplicitThis": true, / Raise error on 'this' expressions with an implied 'any' type. / + "alwaysStrict": true, + / Parse in strict mode and emit "use strict" for each source file. / + + / Additional Checks / + // "noUnusedLocals": true, / Report errors on unused locals. / + // "noUnusedParameters": true, / Report errors on unused parameters. / + // "noImplicitReturns": true, / Report error when not all code paths in function return a value. / + "noFallthroughCasesInSwitch": true, + / Report errors for fallthrough cases in switch statement. / + + / Module Resolution Options / + "moduleResolution": "node", + / Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). / + // "baseUrl": "./", / Base directory to resolve non-absolute module names. / + // "paths": {}, / A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. / + // "rootDirs": [], / List of root folders whose combined content represents the structure of the project at runtime. / + // "typeRoots": [], / List of folders to include type definitions from. / + // "types": [], / Type declaration files to be included in compilation. / + // "allowSyntheticDefaultImports": true, / Allow default imports from modules with no default export. This does not affect code emit, just typechecking. / + "esModuleInterop": true + / Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. / + // "preserveSymlinks": true, / Do not resolve the real path of symlinks. / + // "allowUmdGlobalAccess": true, / Allow accessing UMD globals from modules. / + + / Source Map Options / + // "sourceRoot": "", / Specify the location where debugger should locate TypeScript files instead of source locations. / + // "mapRoot": "", / Specify the location where debugger should locate map files instead of generated locations. / + // "inlineSourceMap": true, / Emit a single file with source maps instead of having a separate file. / + // "inlineSources": true, / Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. / + + / Experimental Options / + // "experimentalDecorators": true, / Enables experimental support for ES7 decorators. / + // "emitDecoratorMetadata": true, / Enables experimental support for emitting type metadata for decorators. / + } +} diff --git a/webpack.config.js b/webpack.config.js index c0d2d52..5b0e5ec 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -0,0 +1,4 @@ +const {loadParticlesInteractionExternal} = require("webpack-tsparticles-plugin"); +const version = require("./package.json").version; + +module.exports = loadParticlesInteractionExternal("remove", "Remove", version, __dirname); diff --git a/yarn.lock b/yarn.lock index 3fd27b5..64538e3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -0,0 +1,2206 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@babel/[email protected]": + version "7.12.11" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.12.11.tgz#f4ad435aa263db935b8f10f2c552d23fb716a63f" + integrity sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw== + dependencies: + "@babel/highlight" "^7.10.4" + +"@babel/code-frame@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.14.5.tgz#23b08d740e83f49c5e59945fbf1b43e80bbf4edb" + integrity sha512-9pzDqyc6OLDaqe+zbACgFkb6fKMNG6CObKpnYXChRsvYGyEdc7CA2BaqeOM+vOtCS5ndmJicPJhKAwYRI6UfFw== + dependencies: + "@babel/highlight" "^7.14.5" + +"@babel/compat-data@^7.15.0": + version "7.15.0" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.15.0.tgz#2dbaf8b85334796cafbb0f5793a90a2fc010b176" + integrity sha512-0NqAC1IJE0S0+lL1SWFMxMkz1pKCNCjI4tr2Zx4LJSXxCLAdr6KyArnY+sno5m3yH9g737ygOyPABDsnXkpxiA== + +"@babel/core@^7.15.5": + version "7.15.5" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.15.5.tgz#f8ed9ace730722544609f90c9bb49162dc3bf5b9" + integrity sha512-pYgXxiwAgQpgM1bNkZsDEq85f0ggXMA5L7c+o3tskGMh2BunCI9QUwB9Z4jpvXUOuMdyGKiGKQiRe11VS6Jzvg== + dependencies: + "@babel/code-frame" "^7.14.5" + "@babel/generator" "^7.15.4" + "@babel/helper-compilation-targets" "^7.15.4" + "@babel/helper-module-transforms" "^7.15.4" + "@babel/helpers" "^7.15.4" + "@babel/parser" "^7.15.5" + "@babel/template" "^7.15.4" + "@babel/traverse" "^7.15.4" + "@babel/types" "^7.15.4" + convert-source-map "^1.7.0" + debug "^4.1.0" + gensync "^1.0.0-beta.2" + json5 "^2.1.2" + semver "^6.3.0" + source-map "^0.5.0" + +"@babel/generator@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.15.4.tgz#85acb159a267ca6324f9793986991ee2022a05b0" + integrity sha512-d3itta0tu+UayjEORPNz6e1T3FtvWlP5N4V5M+lhp/CxT4oAA7/NcScnpRyspUMLK6tu9MNHmQHxRykuN2R7hw== + dependencies: + "@babel/types" "^7.15.4" + jsesc "^2.5.1" + source-map "^0.5.0" + +"@babel/helper-compilation-targets@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.15.4.tgz#cf6d94f30fbefc139123e27dd6b02f65aeedb7b9" + integrity sha512-rMWPCirulnPSe4d+gwdWXLfAXTTBj8M3guAf5xFQJ0nvFY7tfNAFnWdqaHegHlgDZOCT4qvhF3BYlSJag8yhqQ== + dependencies: + "@babel/compat-data" "^7.15.0" + "@babel/helper-validator-option" "^7.14.5" + browserslist "^4.16.6" + semver "^6.3.0" + +"@babel/helper-function-name@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-function-name/-/helper-function-name-7.15.4.tgz#845744dafc4381a4a5fb6afa6c3d36f98a787ebc" + integrity sha512-Z91cOMM4DseLIGOnog+Z8OI6YseR9bua+HpvLAQ2XayUGU+neTtX+97caALaLdyu53I/fjhbeCnWnRH1O3jFOw== + dependencies: + "@babel/helper-get-function-arity" "^7.15.4" + "@babel/template" "^7.15.4" + "@babel/types" "^7.15.4" + +"@babel/helper-get-function-arity@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-get-function-arity/-/helper-get-function-arity-7.15.4.tgz#098818934a137fce78b536a3e015864be1e2879b" + integrity sha512-1/AlxSF92CmGZzHnC515hm4SirTxtpDnLEJ0UyEMgTMZN+6bxXKg04dKhiRx5Enel+SUA1G1t5Ed/yQia0efrA== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-hoist-variables@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-hoist-variables/-/helper-hoist-variables-7.15.4.tgz#09993a3259c0e918f99d104261dfdfc033f178df" + integrity sha512-VTy085egb3jUGVK9ycIxQiPbquesq0HUQ+tPO0uv5mPEBZipk+5FkRKiWq5apuyTE9FUrjENB0rCf8y+n+UuhA== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-member-expression-to-functions@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.15.4.tgz#bfd34dc9bba9824a4658b0317ec2fd571a51e6ef" + integrity sha512-cokOMkxC/BTyNP1AlY25HuBWM32iCEsLPI4BHDpJCHHm1FU2E7dKWWIXJgQgSFiu4lp8q3bL1BIKwqkSUviqtA== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-module-imports@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.15.4.tgz#e18007d230632dea19b47853b984476e7b4e103f" + integrity sha512-jeAHZbzUwdW/xHgHQ3QmWR4Jg6j15q4w/gCfwZvtqOxoo5DKtLHk8Bsf4c5RZRC7NmLEs+ohkdq8jFefuvIxAA== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-module-transforms@^7.15.4": + version "7.15.7" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.15.7.tgz#7da80c8cbc1f02655d83f8b79d25866afe50d226" + integrity sha512-ZNqjjQG/AuFfekFTY+7nY4RgBSklgTu970c7Rj3m/JOhIu5KPBUuTA9AY6zaKcUvk4g6EbDXdBnhi35FAssdSw== + dependencies: + "@babel/helper-module-imports" "^7.15.4" + "@babel/helper-replace-supers" "^7.15.4" + "@babel/helper-simple-access" "^7.15.4" + "@babel/helper-split-export-declaration" "^7.15.4" + "@babel/helper-validator-identifier" "^7.15.7" + "@babel/template" "^7.15.4" + "@babel/traverse" "^7.15.4" + "@babel/types" "^7.15.6" + +"@babel/helper-optimise-call-expression@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.15.4.tgz#f310a5121a3b9cc52d9ab19122bd729822dee171" + integrity sha512-E/z9rfbAOt1vDW1DR7k4SzhzotVV5+qMciWV6LaG1g4jeFrkDlJedjtV4h0i4Q/ITnUu+Pk08M7fczsB9GXBDw== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-replace-supers@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-replace-supers/-/helper-replace-supers-7.15.4.tgz#52a8ab26ba918c7f6dee28628b07071ac7b7347a" + integrity sha512-/ztT6khaXF37MS47fufrKvIsiQkx1LBRvSJNzRqmbyeZnTwU9qBxXYLaaT/6KaxfKhjs2Wy8kG8ZdsFUuWBjzw== + dependencies: + "@babel/helper-member-expression-to-functions" "^7.15.4" + "@babel/helper-optimise-call-expression" "^7.15.4" + "@babel/traverse" "^7.15.4" + "@babel/types" "^7.15.4" + +"@babel/helper-simple-access@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.15.4.tgz#ac368905abf1de8e9781434b635d8f8674bcc13b" + integrity sha512-UzazrDoIVOZZcTeHHEPYrr1MvTR/K+wgLg6MY6e1CJyaRhbibftF6fR2KU2sFRtI/nERUZR9fBd6aKgBlIBaPg== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-split-export-declaration@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.15.4.tgz#aecab92dcdbef6a10aa3b62ab204b085f776e257" + integrity sha512-HsFqhLDZ08DxCpBdEVtKmywj6PQbwnF6HHybur0MAnkAKnlS6uHkwnmRIkElB2Owpfb4xL4NwDmDLFubueDXsw== + dependencies: + "@babel/types" "^7.15.4" + +"@babel/helper-validator-identifier@^7.14.5", "@babel/helper-validator-identifier@^7.14.9", "@babel/helper-validator-identifier@^7.15.7": + version "7.15.7" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.15.7.tgz#220df993bfe904a4a6b02ab4f3385a5ebf6e2389" + integrity sha512-K4JvCtQqad9OY2+yTU8w+E82ywk/fe+ELNlt1G8z3bVGlZfn/hOcQQsUhGhW/N+tb3fxK800wLtKOE/aM0m72w== + +"@babel/helper-validator-option@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.14.5.tgz#6e72a1fff18d5dfcb878e1e62f1a021c4b72d5a3" + integrity sha512-OX8D5eeX4XwcroVW45NMvoYaIuFI+GQpA2a8Gi+X/U/cDUIRsV37qQfF905F0htTRCREQIB4KqPeaveRJUl3Ow== + +"@babel/helpers@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.15.4.tgz#5f40f02050a3027121a3cf48d497c05c555eaf43" + integrity sha512-V45u6dqEJ3w2rlryYYXf6i9rQ5YMNu4FLS6ngs8ikblhu2VdR1AqAd6aJjBzmf2Qzh6KOLqKHxEN9+TFbAkAVQ== + dependencies: + "@babel/template" "^7.15.4" + "@babel/traverse" "^7.15.4" + "@babel/types" "^7.15.4" + +"@babel/highlight@^7.10.4", "@babel/highlight@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.14.5.tgz#6861a52f03966405001f6aa534a01a24d99e8cd9" + integrity sha512-qf9u2WFWVV0MppaL877j2dBtQIDgmidgjGk5VIMw3OadXvYaXn66U1BFlH2t4+t3i+8PhedppRv+i40ABzd+gg== + dependencies: + "@babel/helper-validator-identifier" "^7.14.5" + chalk "^2.0.0" + js-tokens "^4.0.0" + +"@babel/parser@^7.15.4", "@babel/parser@^7.15.5": + version "7.15.7" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.15.7.tgz#0c3ed4a2eb07b165dfa85b3cc45c727334c4edae" + integrity sha512-rycZXvQ+xS9QyIcJ9HXeDWf1uxqlbVFAUq0Rq0dbc50Zb/+wUe/ehyfzGfm9KZZF0kBejYgxltBXocP+gKdL2g== + +"@babel/template@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.15.4.tgz#51898d35dcf3faa670c4ee6afcfd517ee139f194" + integrity sha512-UgBAfEa1oGuYgDIPM2G+aHa4Nlo9Lh6mGD2bDBGMTbYnc38vulXPuC1MGjYILIEmlwl6Rd+BPR9ee3gm20CBtg== + dependencies: + "@babel/code-frame" "^7.14.5" + "@babel/parser" "^7.15.4" + "@babel/types" "^7.15.4" + +"@babel/traverse@^7.15.4": + version "7.15.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.15.4.tgz#ff8510367a144bfbff552d9e18e28f3e2889c22d" + integrity sha512-W6lQD8l4rUbQR/vYgSuCAE75ADyyQvOpFVsvPPdkhf6lATXAsQIG9YdtOcu8BB1dZ0LKu+Zo3c1wEcbKeuhdlA== + dependencies: + "@babel/code-frame" "^7.14.5" + "@babel/generator" "^7.15.4" + "@babel/helper-function-name" "^7.15.4" + "@babel/helper-hoist-variables" "^7.15.4" + "@babel/helper-split-export-declaration" "^7.15.4" + "@babel/parser" "^7.15.4" + "@babel/types" "^7.15.4" + debug "^4.1.0" + globals "^11.1.0" + +"@babel/types@^7.15.4", "@babel/types@^7.15.6": + version "7.15.6" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.15.6.tgz#99abdc48218b2881c058dd0a7ab05b99c9be758f" + integrity sha512-BPU+7QhqNjmWyDO0/vitH/CuhpV8ZmK1wpKva8nuyNF5MJfuRNWMc+hc14+u9xT93kvykMdncrJT19h74uB1Ig== + dependencies: + "@babel/helper-validator-identifier" "^7.14.9" + to-fast-properties "^2.0.0" + +"@discoveryjs/json-ext@^0.5.0": + version "0.5.5" + resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.5.tgz#9283c9ce5b289a3c4f61c12757469e59377f81f3" + integrity sha512-6nFkfkmSeV/rqSaS4oWHgmpnYw194f6hmWF5is6b0J1naJZoiD0NTc9AiUwPHvWsowkjuHErCZT1wa0jg+BLIA== + +"@eslint/eslintrc@^0.4.3": + version "0.4.3" + resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-0.4.3.tgz#9e42981ef035beb3dd49add17acb96e8ff6f394c" + integrity sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw== + dependencies: + ajv "^6.12.4" + debug "^4.1.1" + espree "^7.3.0" + globals "^13.9.0" + ignore "^4.0.6" + import-fresh "^3.2.1" + js-yaml "^3.13.1" + minimatch "^3.0.4" + strip-json-comments "^3.1.1" + +"@humanwhocodes/config-array@^0.5.0": + version "0.5.0" + resolved "https://registry.yarnpkg.com/@humanwhocodes/config-array/-/config-array-0.5.0.tgz#1407967d4c6eecd7388f83acf1eaf4d0c6e58ef9" + integrity sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg== + dependencies: + "@humanwhocodes/object-schema" "^1.2.0" + debug "^4.1.1" + minimatch "^3.0.4" + +"@humanwhocodes/object-schema@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@humanwhocodes/object-schema/-/object-schema-1.2.0.tgz#87de7af9c231826fdd68ac7258f77c429e0e5fcf" + integrity sha512-wdppn25U8z/2yiaT6YGquE6X8sSv7hNMWSXYSSU1jGv/yd6XqjXgTDJ8KP4NgjTXfJ3GbRjeeb8RTV7a/VpM+w== + +"@nodelib/[email protected]": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/[email protected]", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@types/eslint-scope@^3.7.0": + version "3.7.1" + resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.1.tgz#8dc390a7b4f9dd9f1284629efce982e41612116e" + integrity sha512-SCFeogqiptms4Fg29WpOTk5nHIzfpKCemSN63ksBQYKTcXoJEmJagV+DhVmbapZzY4/5YaOV1nZwrsU79fFm1g== + dependencies: + "@types/eslint" "" + "@types/estree" "" + +"@types/eslint@": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-7.28.0.tgz#7e41f2481d301c68e14f483fe10b017753ce8d5a" + integrity sha512-07XlgzX0YJUn4iG1ocY4IX9DzKSmMGUs6ESKlxWhZRaa0fatIWaHWUVapcuGa8r5HFnTqzj+4OCjd5f7EZ/i/A== + dependencies: + "@types/estree" "" + "@types/json-schema" "" + +"@types/estree@", "@types/estree@^0.0.50": + version "0.0.50" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.50.tgz#1e0caa9364d3fccd2931c3ed96fdbeaa5d4cca83" + integrity sha512-C6N5s2ZFtuZRj54k2/zyRhNDjJwwcViAM3Nbm8zjBpbqAdZ00mr0CFxvSKeO8Y/e03WVFLpQMdHYVfUd6SB+Hw== + +"@types/json-schema@", "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.7", "@types/json-schema@^7.0.8": + version "7.0.9" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.9.tgz#97edc9037ea0c38585320b28964dde3b39e4660d" + integrity sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ== + +"@types/node@": + version "16.10.1" + resolved "https://registry.yarnpkg.com/@types/node/-/node-16.10.1.tgz#f3647623199ca920960006b3dccf633ea905f243" + integrity sha512-4/Z9DMPKFexZj/Gn3LylFgamNKHm4K3QDi0gz9B26Uk0c8izYf97B5fxfpspMNkWlFupblKM/nV8+NA9Ffvr+w== + +"@types/webpack-env@^1.16.2": + version "1.16.2" + resolved "https://registry.yarnpkg.com/@types/webpack-env/-/webpack-env-1.16.2.tgz#8db514b059c1b2ae14ce9d7bb325296de6a9a0fa" + integrity sha512-vKx7WNQNZDyJveYcHAm9ZxhqSGLYwoyLhrHjLBOkw3a7cT76sTdjgtwyijhk1MaHyRIuSztcVwrUOO/NEu68Dw== + +"@typescript-eslint/eslint-plugin@^4.31.2": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.31.2.tgz#9f41efaee32cdab7ace94b15bd19b756dd099b0a" + integrity sha512-w63SCQ4bIwWN/+3FxzpnWrDjQRXVEGiTt9tJTRptRXeFvdZc/wLiz3FQUwNQ2CVoRGI6KUWMNUj/pk63noUfcA== + dependencies: + "@typescript-eslint/experimental-utils" "4.31.2" + "@typescript-eslint/scope-manager" "4.31.2" + debug "^4.3.1" + functional-red-black-tree "^1.0.1" + regexpp "^3.1.0" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/[email protected]": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-4.31.2.tgz#98727a9c1e977dd5d20c8705e69cd3c2a86553fa" + integrity sha512-3tm2T4nyA970yQ6R3JZV9l0yilE2FedYg8dcXrTar34zC9r6JB7WyBQbpIVongKPlhEMjhQ01qkwrzWy38Bk1Q== + dependencies: + "@types/json-schema" "^7.0.7" + "@typescript-eslint/scope-manager" "4.31.2" + "@typescript-eslint/types" "4.31.2" + "@typescript-eslint/typescript-estree" "4.31.2" + eslint-scope "^5.1.1" + eslint-utils "^3.0.0" + +"@typescript-eslint/parser@^4.31.2": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-4.31.2.tgz#54aa75986e3302d91eff2bbbaa6ecfa8084e9c34" + integrity sha512-EcdO0E7M/sv23S/rLvenHkb58l3XhuSZzKf6DBvLgHqOYdL6YFMYVtreGFWirxaU2mS1GYDby3Lyxco7X5+Vjw== + dependencies: + "@typescript-eslint/scope-manager" "4.31.2" + "@typescript-eslint/types" "4.31.2" + "@typescript-eslint/typescript-estree" "4.31.2" + debug "^4.3.1" + +"@typescript-eslint/[email protected]": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-4.31.2.tgz#1d528cb3ed3bcd88019c20a57c18b897b073923a" + integrity sha512-2JGwudpFoR/3Czq6mPpE8zBPYdHWFGL6lUNIGolbKQeSNv4EAiHaR5GVDQaLA0FwgcdcMtRk+SBJbFGL7+La5w== + dependencies: + "@typescript-eslint/types" "4.31.2" + "@typescript-eslint/visitor-keys" "4.31.2" + +"@typescript-eslint/[email protected]": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.31.2.tgz#2aea7177d6d744521a168ed4668eddbd912dfadf" + integrity sha512-kWiTTBCTKEdBGrZKwFvOlGNcAsKGJSBc8xLvSjSppFO88AqGxGNYtF36EuEYG6XZ9vT0xX8RNiHbQUKglbSi1w== + +"@typescript-eslint/[email protected]": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-4.31.2.tgz#abfd50594d8056b37e7428df3b2d185ef2d0060c" + integrity sha512-ieBq8U9at6PvaC7/Z6oe8D3czeW5d//Fo1xkF/s9394VR0bg/UaMYPdARiWyKX+lLEjY3w/FNZJxitMsiWv+wA== + dependencies: + "@typescript-eslint/types" "4.31.2" + "@typescript-eslint/visitor-keys" "4.31.2" + debug "^4.3.1" + globby "^11.0.3" + is-glob "^4.0.1" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/[email protected]": + version "4.31.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.31.2.tgz#7d5b4a4705db7fe59ecffb273c1d082760f635cc" + integrity sha512-PrBId7EQq2Nibns7dd/ch6S6/M4/iwLM9McbgeEbCXfxdwRUNxJ4UNreJ6Gh3fI2GNKNrWnQxKL7oCPmngKBug== + dependencies: + "@typescript-eslint/types" "4.31.2" + eslint-visitor-keys "^2.0.0" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.11.1.tgz#2bfd767eae1a6996f432ff7e8d7fc75679c0b6a7" + integrity sha512-ukBh14qFLjxTQNTXocdyksN5QdM28S1CxHt2rdskFyL+xFV7VremuBLVbmCePj+URalXBENx/9Lm7lnhihtCSw== + dependencies: + "@webassemblyjs/helper-numbers" "1.11.1" + "@webassemblyjs/helper-wasm-bytecode" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.1.tgz#f6c61a705f0fd7a6aecaa4e8198f23d9dc179e4f" + integrity sha512-iGRfyc5Bq+NnNuX8b5hwBrRjzf0ocrJPI6GWFodBFzmFnyvrQ83SHKhmilCU/8Jv67i4GJZBMhEzltxzcNagtQ== + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.1.tgz#1a63192d8788e5c012800ba6a7a46c705288fd16" + integrity sha512-RlhS8CBCXfRUR/cwo2ho9bkheSXG0+NwooXcc3PAILALf2QLdFyj7KGsKRbVc95hZnhnERon4kW/D3SZpp6Tcg== + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.1.tgz#832a900eb444884cde9a7cad467f81500f5e5ab5" + integrity sha512-gwikF65aDNeeXa8JxXa2BAk+REjSyhrNC9ZwdT0f8jc4dQQeDQ7G4m0f2QCLPJiMTTO6wfDmRmj/pW0PsUvIcA== + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.1.tgz#64d81da219fbbba1e3bd1bfc74f6e8c4e10a62ae" + integrity sha512-vDkbxiB8zfnPdNK9Rajcey5C0w+QJugEglN0of+kmO8l7lDb77AnlKYQF7aarZuCrv+l0UvqL+68gSDr3k9LPQ== + dependencies: + "@webassemblyjs/floating-point-hex-parser" "1.11.1" + "@webassemblyjs/helper-api-error" "1.11.1" + "@xtuc/long" "4.2.2" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.1.tgz#f328241e41e7b199d0b20c18e88429c4433295e1" + integrity sha512-PvpoOGiJwXeTrSf/qfudJhwlvDQxFgelbMqtq52WWiXC6Xgg1IREdngmPN3bs4RoO83PnL/nFrxucXj1+BX62Q== + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.11.1.tgz#21ee065a7b635f319e738f0dd73bfbda281c097a" + integrity sha512-10P9No29rYX1j7F3EVPX3JvGPQPae+AomuSTPiF9eBQeChHI6iqjMIwR9JmOJXwpnn/oVGDk7I5IlskuMwU/pg== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/helper-buffer" "1.11.1" + "@webassemblyjs/helper-wasm-bytecode" "1.11.1" + "@webassemblyjs/wasm-gen" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/ieee754/-/ieee754-1.11.1.tgz#963929e9bbd05709e7e12243a099180812992614" + integrity sha512-hJ87QIPtAMKbFq6CGTkZYJivEwZDbQUgYd3qKSadTNOhVY7p+gfP6Sr0lLRVTaG1JjFj+r3YchoqRYxNH3M0GQ== + dependencies: + "@xtuc/ieee754" "^1.2.0" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/leb128/-/leb128-1.11.1.tgz#ce814b45574e93d76bae1fb2644ab9cdd9527aa5" + integrity sha512-BJ2P0hNZ0u+Th1YZXJpzW6miwqQUGcIHT1G/sf72gLVD9DZ5AdYTqPNbHZh6K1M5VmKvFXwGSWZADz+qBWxeRw== + dependencies: + "@xtuc/long" "4.2.2" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/utf8/-/utf8-1.11.1.tgz#d1f8b764369e7c6e6bae350e854dec9a59f0a3ff" + integrity sha512-9kqcxAEdMhiwQkHpkNiorZzqpGrodQQ2IGrHHxCy+Ozng0ofyMA0lTqiLkVs1uzTRejX+/O0EOT7KxqVPuXosQ== + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-edit/-/wasm-edit-1.11.1.tgz#ad206ebf4bf95a058ce9880a8c092c5dec8193d6" + integrity sha512-g+RsupUC1aTHfR8CDgnsVRVZFJqdkFHpsHMfJuWQzWU3tvnLC07UqHICfP+4XyL2tnr1amvl1Sdp06TnYCmVkA== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/helper-buffer" "1.11.1" + "@webassemblyjs/helper-wasm-bytecode" "1.11.1" + "@webassemblyjs/helper-wasm-section" "1.11.1" + "@webassemblyjs/wasm-gen" "1.11.1" + "@webassemblyjs/wasm-opt" "1.11.1" + "@webassemblyjs/wasm-parser" "1.11.1" + "@webassemblyjs/wast-printer" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-gen/-/wasm-gen-1.11.1.tgz#86c5ea304849759b7d88c47a32f4f039ae3c8f76" + integrity sha512-F7QqKXwwNlMmsulj6+O7r4mmtAlCWfO/0HdgOxSklZfQcDu0TpLiD1mRt/zF25Bk59FIjEuGAIyn5ei4yMfLhA== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/helper-wasm-bytecode" "1.11.1" + "@webassemblyjs/ieee754" "1.11.1" + "@webassemblyjs/leb128" "1.11.1" + "@webassemblyjs/utf8" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-opt/-/wasm-opt-1.11.1.tgz#657b4c2202f4cf3b345f8a4c6461c8c2418985f2" + integrity sha512-VqnkNqnZlU5EB64pp1l7hdm3hmQw7Vgqa0KF/KCNO9sIpI6Fk6brDEiX+iCOYrvMuBWDws0NkTOxYEb85XQHHw== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/helper-buffer" "1.11.1" + "@webassemblyjs/wasm-gen" "1.11.1" + "@webassemblyjs/wasm-parser" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wasm-parser/-/wasm-parser-1.11.1.tgz#86ca734534f417e9bd3c67c7a1c75d8be41fb199" + integrity sha512-rrBujw+dJu32gYB7/Lup6UhdkPx9S9SnobZzRVL7VcBH9Bt9bCBLEuX/YXOOtBsOZ4NQrRykKhffRWHvigQvOA== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/helper-api-error" "1.11.1" + "@webassemblyjs/helper-wasm-bytecode" "1.11.1" + "@webassemblyjs/ieee754" "1.11.1" + "@webassemblyjs/leb128" "1.11.1" + "@webassemblyjs/utf8" "1.11.1" + +"@webassemblyjs/[email protected]": + version "1.11.1" + resolved "https://registry.yarnpkg.com/@webassemblyjs/wast-printer/-/wast-printer-1.11.1.tgz#d0c73beda8eec5426f10ae8ef55cee5e7084c2f0" + integrity sha512-IQboUWM4eKzWW+N/jij2sRatKMh99QEelo3Eb2q0qXkvPRISAj8Qxtmw5itwqK+TTkBuUIE45AxYPToqPtL5gg== + dependencies: + "@webassemblyjs/ast" "1.11.1" + "@xtuc/long" "4.2.2" + +"@webpack-cli/configtest@^1.0.4": + version "1.0.4" + resolved "https://registry.yarnpkg.com/@webpack-cli/configtest/-/configtest-1.0.4.tgz#f03ce6311c0883a83d04569e2c03c6238316d2aa" + integrity sha512-cs3XLy+UcxiP6bj0A6u7MLLuwdXJ1c3Dtc0RkKg+wiI1g/Ti1om8+/2hc2A2B60NbBNAbMgyBMHvyymWm/j4wQ== + +"@webpack-cli/info@^1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@webpack-cli/info/-/info-1.3.0.tgz#9d78a31101a960997a4acd41ffd9b9300627fe2b" + integrity sha512-ASiVB3t9LOKHs5DyVUcxpraBXDOKubYu/ihHhU+t1UPpxsivg6Od2E2qU4gJCekfEddzRBzHhzA/Acyw/mlK/w== + dependencies: + envinfo "^7.7.3" + +"@webpack-cli/serve@^1.5.2": + version "1.5.2" + resolved "https://registry.yarnpkg.com/@webpack-cli/serve/-/serve-1.5.2.tgz#ea584b637ff63c5a477f6f21604b5a205b72c9ec" + integrity sha512-vgJ5OLWadI8aKjDlOH3rb+dYyPd2GTZuQC/Tihjct6F9GpXGZINo3Y/IVuZVTM1eDQB+/AOsjPUWH/WySDaXvw== + +"@xtuc/ieee754@^1.2.0": + version "1.2.0" + resolved "https://registry.yarnpkg.com/@xtuc/ieee754/-/ieee754-1.2.0.tgz#eef014a3145ae477a1cbc00cd1e552336dceb790" + integrity sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA== + +"@xtuc/[email protected]": + version "4.2.2" + resolved "https://registry.yarnpkg.com/@xtuc/long/-/long-4.2.2.tgz#d291c6a4e97989b5c61d9acf396ae4fe133a718d" + integrity sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ== + +acorn-import-assertions@^1.7.6: + version "1.7.6" + resolved "https://registry.yarnpkg.com/acorn-import-assertions/-/acorn-import-assertions-1.7.6.tgz#580e3ffcae6770eebeec76c3b9723201e9d01f78" + integrity sha512-FlVvVFA1TX6l3lp8VjDnYYq7R1nyW6x3svAt4nDgrWQ9SBaSh9CnbwgSUTasgfNfOG5HlM1ehugCvM+hjo56LA== + +acorn-jsx@^5.3.1: + version "5.3.2" + resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" + integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== + +acorn@^7.4.0: + version "7.4.1" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.4.1.tgz#feaed255973d2e77555b83dbc08851a6c63520fa" + integrity sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A== + +acorn@^8.4.1: + version "8.5.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.5.0.tgz#4512ccb99b3698c752591e9bb4472e38ad43cee2" + integrity sha512-yXbYeFy+jUuYd3/CDcg2NkIYE991XYX/bje7LmjJigUciaeO1JR4XxXgCIV1/Zc/dRuFEyw1L0pbA+qynJkW5Q== + +ajv-keywords@^3.5.2: + version "3.5.2" + resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-3.5.2.tgz#31f29da5ab6e00d1c2d329acf7b5929614d5014d" + integrity sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ== + +ajv@^6.10.0, ajv@^6.12.4, ajv@^6.12.5: + version "6.12.6" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ajv@^8.0.1: + version "8.6.3" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.6.3.tgz#11a66527761dc3e9a3845ea775d2d3c0414e8764" + integrity sha512-SMJOdDP6LqTkD0Uq8qLi+gMwSt0imXLSV080qFVwJCpH9U6Mb+SUGHAXM0KNbcBPguytWyvFxcHgMLe2D2XSpw== + dependencies: + fast-deep-equal "^3.1.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + uri-js "^4.2.2" + +ansi-colors@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/ansi-colors/-/ansi-colors-4.1.1.tgz#cbb9ae256bf750af1eab344f229aa27fe94ba348" + integrity sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA== + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +astral-regex@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/astral-regex/-/astral-regex-2.0.0.tgz#483143c567aeed4785759c0865786dc77d7d2e31" + integrity sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ== + +babel-loader@^8.2.2: + version "8.2.2" + resolved "https://registry.yarnpkg.com/babel-loader/-/babel-loader-8.2.2.tgz#9363ce84c10c9a40e6c753748e1441b60c8a0b81" + integrity sha512-JvTd0/D889PQBtUXJ2PXaKU/pjZDMtHA9V2ecm+eNRmmBCMR09a+fmpGTNwnJtFmFl5Ei7Vy47LjBb+L0wQ99g== + dependencies: + find-cache-dir "^3.3.1" + loader-utils "^1.4.0" + make-dir "^3.1.0" + schema-utils "^2.6.5" + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +big.js@^5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/big.js/-/big.js-5.2.2.tgz#65f0af382f578bcdc742bd9c281e9cb2d7768328" + integrity sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ== + +brace-expansion@^1.1.7: + version "1.1.11" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" + integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +braces@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +browserslist@^4.14.5, browserslist@^4.16.6: + version "4.17.1" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.17.1.tgz#a98d104f54af441290b7d592626dd541fa642eb9" + integrity sha512-aLD0ZMDSnF4lUt4ZDNgqi5BUn9BZ7YdQdI/cYlILrhdSSZJLU9aNZoD5/NBmM4SK34APB2e83MOsRt1EnkuyaQ== + dependencies: + caniuse-lite "^1.0.30001259" + electron-to-chromium "^1.3.846" + escalade "^3.1.1" + nanocolors "^0.1.5" + node-releases "^1.1.76" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +caniuse-lite@^1.0.30001259: + version "1.0.30001260" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001260.tgz#e3be3f34ddad735ca4a2736fa9e768ef34316270" + integrity sha512-Fhjc/k8725ItmrvW5QomzxLeojewxvqiYCKeFcfFEhut28IVLdpHU19dneOmltZQIE5HNbawj1HYD+1f2bM1Dg== + dependencies: + nanocolors "^0.1.0" + +chalk@^2.0.0: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +chalk@^4.0.0: + version "4.1.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +chrome-trace-event@^1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz#1015eced4741e15d06664a957dbbf50d041e26ac" + integrity sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg== + +cliui@^7.0.2: + version "7.0.4" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f" + integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^7.0.0" + +clone-deep@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/clone-deep/-/clone-deep-4.0.1.tgz#c19fd9bdbbf85942b4fd979c84dcf7d5f07c2387" + integrity sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ== + dependencies: + is-plain-object "^2.0.4" + kind-of "^6.0.2" + shallow-clone "^3.0.0" + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + [email protected]: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +colorette@^1.2.1: + version "1.4.0" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.4.0.tgz#5190fbb87276259a86ad700bff2c6d6faa3fca40" + integrity sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g== + +commander@^2.20.0: + version "2.20.3" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" + integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== + +commander@^7.0.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7" + integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw== + +commondir@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b" + integrity sha1-3dgA2gxmEnOTzKWVDqloo6rxJTs= + [email protected]: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= + +convert-source-map@^1.7.0: + version "1.8.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.8.0.tgz#f3373c32d21b4d780dd8004514684fb791ca4369" + integrity sha512-+OQdjP49zViI/6i7nIJpA8rAl4sV/JdPfU9nZs3VqOwGIgizICvuN2ru6fMd+4llL0tar18UYJXfZ/TWtmhUjA== + dependencies: + safe-buffer "~5.1.1" + +copyfiles@^2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/copyfiles/-/copyfiles-2.4.1.tgz#d2dcff60aaad1015f09d0b66e7f0f1c5cd3c5da5" + integrity sha512-fereAvAvxDrQDOXybk3Qu3dPbOoKoysFMWtkY3mv5BsL8//OSZVL5DCLYqgRfY5cWirgRzlC+WSrxp6Bo3eNZg== + dependencies: + glob "^7.0.5" + minimatch "^3.0.3" + mkdirp "^1.0.4" + noms "0.0.0" + through2 "^2.0.1" + untildify "^4.0.0" + yargs "^16.1.0" + +core-util-is@~1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" + integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== + +cross-spawn@^7.0.2, cross-spawn@^7.0.3: + version "7.0.3" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" + integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +debug@^4.0.1, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1: + version "4.3.2" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.2.tgz#f0a49c18ac8779e31d4a0c6029dfb76873c7428b" + integrity sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw== + dependencies: + ms "2.1.2" + +deep-is@^0.1.3: + version "0.1.4" + resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.4.tgz#a6f2dce612fadd2ef1f519b73551f17e85199831" + integrity sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ== + +dir-glob@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" + integrity sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== + dependencies: + path-type "^4.0.0" + +doctrine@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/doctrine/-/doctrine-3.0.0.tgz#addebead72a6574db783639dc87a121773973961" + integrity sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w== + dependencies: + esutils "^2.0.2" + +downlevel-dts@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/downlevel-dts/-/downlevel-dts-0.7.0.tgz#155c24310dad8a4820ad077e64b15a8c461aa932" + integrity sha512-tcjGqElN0/oad/LJBlaxmZ3zOYEQOBbGuirKzif8s1jeRiWBdNX9H6OBFlRjOQkosXgV+qSjs4osuGCivyZ4Jw== + dependencies: + semver "^7.3.2" + shelljs "^0.8.3" + typescript "^4.1.0-dev.20201026" + +electron-to-chromium@^1.3.846: + version "1.3.850" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.850.tgz#c56c72abfeab051b4b328beb894461c5912d0456" + integrity sha512-ZzkDcdzePeF4dhoGZQT77V2CyJOpwfTZEOg4h0x6R/jQhGt/rIRpbRyVreWLtD7B/WsVxo91URm2WxMKR9JQZA== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +emojis-list@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/emojis-list/-/emojis-list-3.0.0.tgz#5570662046ad29e2e916e71aae260abdff4f6a78" + integrity sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q== + +enhanced-resolve@^5.8.3: + version "5.8.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.8.3.tgz#6d552d465cce0423f5b3d718511ea53826a7b2f0" + integrity sha512-EGAbGvH7j7Xt2nc0E7D99La1OiEs8LnyimkRgwExpUMScN6O+3x9tIWs7PLQZVNx4YD+00skHXPXi1yQHpAmZA== + dependencies: + graceful-fs "^4.2.4" + tapable "^2.2.0" + +enquirer@^2.3.5: + version "2.3.6" + resolved "https://registry.yarnpkg.com/enquirer/-/enquirer-2.3.6.tgz#2a7fe5dd634a1e4125a975ec994ff5456dc3734d" + integrity sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg== + dependencies: + ansi-colors "^4.1.1" + +envinfo@^7.7.3: + version "7.8.1" + resolved "https://registry.yarnpkg.com/envinfo/-/envinfo-7.8.1.tgz#06377e3e5f4d379fea7ac592d5ad8927e0c4d475" + integrity sha512-/o+BXHmB7ocbHEAs6F2EnG0ogybVVUdkRunTT2glZU9XAaGmhqskrvKwqXuDfNjEO0LZKWdejEEpnq8aM0tOaw== + +es-module-lexer@^0.9.0: + version "0.9.0" + resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-0.9.0.tgz#fe4c4621977bc668e285c5f1f70ca3b451095fda" + integrity sha512-qU2eN/XHsrl3E4y7mK1wdWnyy5c8gXtCbfP6Xcsemm7fPUR1PIV1JhZfP7ojcN0Fzp69CfrS3u76h2tusvfKiQ== + +escalade@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40" + integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ= + +escape-string-regexp@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" + integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== + +eslint-config-prettier@^8.3.0: + version "8.3.0" + resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-8.3.0.tgz#f7471b20b6fe8a9a9254cc684454202886a2dd7a" + integrity sha512-BgZuLUSeKzvlL/VUjx/Yb787VQ26RU3gGjA3iiFvdsp/2bMfVIWUVP7tjxtjS0e+HP409cPlPvNkQloz8C91ew== + [email protected], eslint-scope@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" + integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== + dependencies: + esrecurse "^4.3.0" + estraverse "^4.1.1" + +eslint-utils@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/eslint-utils/-/eslint-utils-2.1.0.tgz#d2de5e03424e707dc10c74068ddedae708741b27" + integrity sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg== + dependencies: + eslint-visitor-keys "^1.1.0" + +eslint-utils@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/eslint-utils/-/eslint-utils-3.0.0.tgz#8aebaface7345bb33559db0a1f13a1d2d48c3672" + integrity sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA== + dependencies: + eslint-visitor-keys "^2.0.0" + +eslint-visitor-keys@^1.1.0, eslint-visitor-keys@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz#30ebd1ef7c2fdff01c3a4f151044af25fab0523e" + integrity sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ== + +eslint-visitor-keys@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz#f65328259305927392c938ed44eb0a5c9b2bd303" + integrity sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw== + +eslint@^7.32.0: + version "7.32.0" + resolved "https://registry.yarnpkg.com/eslint/-/eslint-7.32.0.tgz#c6d328a14be3fb08c8d1d21e12c02fdb7a2a812d" + integrity sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA== + dependencies: + "@babel/code-frame" "7.12.11" + "@eslint/eslintrc" "^0.4.3" + "@humanwhocodes/config-array" "^0.5.0" + ajv "^6.10.0" + chalk "^4.0.0" + cross-spawn "^7.0.2" + debug "^4.0.1" + doctrine "^3.0.0" + enquirer "^2.3.5" + escape-string-regexp "^4.0.0" + eslint-scope "^5.1.1" + eslint-utils "^2.1.0" + eslint-visitor-keys "^2.0.0" + espree "^7.3.1" + esquery "^1.4.0" + esutils "^2.0.2" + fast-deep-equal "^3.1.3" + file-entry-cache "^6.0.1" + functional-red-black-tree "^1.0.1" + glob-parent "^5.1.2" + globals "^13.6.0" + ignore "^4.0.6" + import-fresh "^3.0.0" + imurmurhash "^0.1.4" + is-glob "^4.0.0" + js-yaml "^3.13.1" + json-stable-stringify-without-jsonify "^1.0.1" + levn "^0.4.1" + lodash.merge "^4.6.2" + minimatch "^3.0.4" + natural-compare "^1.4.0" + optionator "^0.9.1" + progress "^2.0.0" + regexpp "^3.1.0" + semver "^7.2.1" + strip-ansi "^6.0.0" + strip-json-comments "^3.1.0" + table "^6.0.9" + text-table "^0.2.0" + v8-compile-cache "^2.0.3" + +espree@^7.3.0, espree@^7.3.1: + version "7.3.1" + resolved "https://registry.yarnpkg.com/espree/-/espree-7.3.1.tgz#f2df330b752c6f55019f8bd89b7660039c1bbbb6" + integrity sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g== + dependencies: + acorn "^7.4.0" + acorn-jsx "^5.3.1" + eslint-visitor-keys "^1.3.0" + +esprima@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +esquery@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.4.0.tgz#2148ffc38b82e8c7057dfed48425b3e61f0f24a5" + integrity sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w== + dependencies: + estraverse "^5.1.0" + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^4.1.1: + version "4.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d" + integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== + +estraverse@^5.1.0, estraverse@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.2.0.tgz#307df42547e6cc7324d3cf03c155d5cdb8c53880" + integrity sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ== + +esutils@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" + integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== + +events@^3.2.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400" + integrity sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q== + +execa@^5.0.0: + version "5.1.1" + resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== + dependencies: + cross-spawn "^7.0.3" + get-stream "^6.0.0" + human-signals "^2.1.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.1" + onetime "^5.1.2" + signal-exit "^3.0.3" + strip-final-newline "^2.0.0" + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-glob@^3.1.1: + version "3.2.7" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.7.tgz#fd6cb7a2d7e9aa7a7846111e85a196d6b2f766a1" + integrity sha512-rYGMRwip6lUMvYD3BTScMwT1HtAs2d71SMv66Vrxs0IekGZEjhM0pcMfjQPnknBt2zeCwQMEupiN02ZP4DiT1Q== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-levenshtein@^2.0.6: + version "2.0.6" + resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" + integrity sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc= + +fastest-levenshtein@^1.0.12: + version "1.0.12" + resolved "https://registry.yarnpkg.com/fastest-levenshtein/-/fastest-levenshtein-1.0.12.tgz#9990f7d3a88cc5a9ffd1f1745745251700d497e2" + integrity sha512-On2N+BpYJ15xIC974QNVuYGMOlEVt4s0EOI3wwMqOmK1fdDY+FN/zltPV8vosq4ad4c/gJ1KHScUn/6AWIgiow== + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +file-entry-cache@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-6.0.1.tgz#211b2dd9659cb0394b073e7323ac3c933d522027" + integrity sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg== + dependencies: + flat-cache "^3.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-cache-dir@^3.3.1: + version "3.3.2" + resolved "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-3.3.2.tgz#b30c5b6eff0730731aea9bbd9dbecbd80256d64b" + integrity sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig== + dependencies: + commondir "^1.0.1" + make-dir "^3.0.2" + pkg-dir "^4.1.0" + +find-up@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +flat-cache@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/flat-cache/-/flat-cache-3.0.4.tgz#61b0338302b2fe9f957dcc32fc2a87f1c3048b11" + integrity sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg== + dependencies: + flatted "^3.1.0" + rimraf "^3.0.2" + +flatted@^3.1.0: + version "3.2.2" + resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.2.2.tgz#64bfed5cb68fe3ca78b3eb214ad97b63bedce561" + integrity sha512-JaTY/wtrcSyvXJl4IMFHPKyFur1sE9AUqc0QnhOaJ0CxHtAoIV8pYDzeEfAaNEtGkOfq4gr3LBFmdXW5mOQFnA== + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8= + +function-bind@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.1.tgz#a56899d3ea3c9bab874bb9773b7c5ede92f4895d" + integrity sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A== + +functional-red-black-tree@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327" + integrity sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc= + +gensync@^1.0.0-beta.2: + version "1.0.0-beta.2" + resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" + integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== + +get-caller-file@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + +get-stream@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob-to-regexp@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" + integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== + +glob@^7.0.0, glob@^7.0.5, glob@^7.1.3: + version "7.2.0" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.0.tgz#d15535af7732e02e948f4c41628bd910293f6023" + integrity sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + +globals@^11.1.0: + version "11.12.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e" + integrity sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA== + +globals@^13.6.0, globals@^13.9.0: + version "13.11.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-13.11.0.tgz#40ef678da117fe7bd2e28f1fab24951bd0255be7" + integrity sha512-08/xrJ7wQjK9kkkRoI3OFUBbLx4f+6x3SGwcPvQ0QH6goFDrOU2oyAWrmh3dJezu65buo+HBMzAMQy6rovVC3g== + dependencies: + type-fest "^0.20.2" + +globby@^11.0.3: + version "11.0.4" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.0.4.tgz#2cbaff77c2f2a62e71e9b2813a67b97a3a3001a5" + integrity sha512-9O4MVG9ioZJ08ffbcyVYyLOJLk5JQ688pJ4eMGLpdWLHq/Wr1D9BlriLQyL0E+jbkuePVZXYFj47QM/v093wHg== + dependencies: + array-union "^2.1.0" + dir-glob "^3.0.1" + fast-glob "^3.1.1" + ignore "^5.1.4" + merge2 "^1.3.0" + slash "^3.0.0" + +graceful-fs@^4.1.2, graceful-fs@^4.2.4: + version "4.2.8" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.8.tgz#e412b8d33f5e006593cbd3cee6df9f2cebbe802a" + integrity sha512-qkIilPUYcNhJpd33n0GBXTB1MMPp14TxEsEs0pTrsSVucApsYzW5V+Q8Qxhik6KU3evy+qkAAowTByymK0avdg== + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0= + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +has@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/has/-/has-1.0.3.tgz#722d7cbfc1f6aa8241f16dd814e011e1f41e8796" + integrity sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw== + dependencies: + function-bind "^1.1.1" + +human-signals@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== + +ignore@^4.0.6: + version "4.0.6" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-4.0.6.tgz#750e3db5862087b4737ebac8207ffd1ef27b25fc" + integrity sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg== + +ignore@^5.1.4: + version "5.1.8" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.1.8.tgz#f150a8b50a34289b33e22f5889abd4d8016f0e57" + integrity sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw== + +import-fresh@^3.0.0, import-fresh@^3.2.1: + version "3.3.0" + resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.0.tgz#37162c25fcb9ebaa2e6e53d5b4d88ce17d9e0c2b" + integrity sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +import-local@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.0.2.tgz#a8cfd0431d1de4a2199703d003e3e62364fa6db6" + integrity sha512-vjL3+w0oulAVZ0hBHnxa/Nm5TAurf9YLQJDhqRZyqb+VKGOB6LU8t9H1Nr5CIo16vh9XfJTOoHwU0B71S557gA== + dependencies: + pkg-dir "^4.2.0" + resolve-cwd "^3.0.0" + +imurmurhash@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" + integrity sha1-khi5srkoojixPcT7a21XbyMUU+o= + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk= + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@^2.0.1, inherits@~2.0.1, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +interpret@^1.0.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.4.0.tgz#665ab8bc4da27a774a40584e812e3e0fa45b1a1e" + integrity sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA== + +interpret@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/interpret/-/interpret-2.2.0.tgz#1a78a0b5965c40a5416d007ad6f50ad27c417df9" + integrity sha512-Ju0Bz/cEia55xDwUWEa8+olFpCiQoypjnQySseKtmjNrnps3P+xfpUmGr90T7yjlVJmOtybRvPXhKMbHr+fWnw== + +is-core-module@^2.2.0: + version "2.6.0" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.6.0.tgz#d7553b2526fe59b92ba3e40c8df757ec8a709e19" + integrity sha512-wShG8vs60jKfPWpF2KZRaAtvt3a20OAn7+IJ6hLPECpSABLcKtFKTTI4ZtH5QcBruBHlq+WsdHWyz0BCZW7svQ== + dependencies: + has "^1.0.3" + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha1-qIwCU1eR8C7TfHahueqXc8gz+MI= + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-glob@^4.0.0, is-glob@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.2.tgz#859fc2e731e58c902f99fcabccb75a7dd07d29d8" + integrity sha512-ZZTOjRcDjuAAAv2cTBQP/lL59ZTArx77+7UzHdWW/XB1mrfp7DEaVpKmZ0XIzx+M7AxfhKcqV+nMetUQmFifwg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-plain-object@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-2.0.4.tgz#2c163b3fafb1b606d9d17928f05c2a1c38e07677" + integrity sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og== + dependencies: + isobject "^3.0.1" + +is-stream@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== + [email protected]: + version "0.0.1" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf" + integrity sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8= + +isarray@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" + integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE= + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= + +isobject@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" + integrity sha1-TkMekrEalzFjaqH5yNHMvP2reN8= + +jest-worker@^27.0.6: + version "27.2.2" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-27.2.2.tgz#636deeae8068abbf2b34b4eb9505f8d4e5bd625c" + integrity sha512-aG1xq9KgWB2CPC8YdMIlI8uZgga2LFNcGbHJxO8ctfXAydSaThR4EewKQGg3tBOC+kS3vhPGgymsBdi9VINjPw== + dependencies: + "@types/node" "" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@^3.13.1: + version "3.14.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" + integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +jsesc@^2.5.1: + version "2.5.2" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4" + integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA== + +json-parse-better-errors@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9" + integrity sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema-traverse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" + integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== + +json-stable-stringify-without-jsonify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651" + integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE= + +json5@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/json5/-/json5-1.0.1.tgz#779fb0018604fa854eacbf6252180d83543e3dbe" + integrity sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow== + dependencies: + minimist "^1.2.0" + +json5@^2.1.2: + version "2.2.0" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.0.tgz#2dfefe720c6ba525d9ebd909950f0515316c89a3" + integrity sha512-f+8cldu7X/y7RAJurMEJmdoKXGB/X550w2Nr3tTbezL6RwEE/iMcm+tZnXeoZtKuOq6ft8+CqzEkrIgx1fPoQA== + dependencies: + minimist "^1.2.5" + +kind-of@^6.0.2: + version "6.0.3" + resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd" + integrity sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw== + +levn@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade" + integrity sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ== + dependencies: + prelude-ls "^1.2.1" + type-check "~0.4.0" + +loader-runner@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-4.2.0.tgz#d7022380d66d14c5fb1d496b89864ebcfd478384" + integrity sha512-92+huvxMvYlMzMt0iIOukcwYBFpkYJdpl2xsZ7LrlayO7E8SOv+JJUEK17B/dJIHAOLMfh2dZZ/Y18WgmGtYNw== + +loader-utils@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-1.4.0.tgz#c579b5e34cb34b1a74edc6c1fb36bfa371d5a613" + integrity sha512-qH0WSMBtn/oHuwjy/NucEgbx5dbxxnxup9s4PVXJUDHZBQY+s0NWA9rJf53RBnQZxfch7euUui7hpoAPvALZdA== + dependencies: + big.js "^5.2.2" + emojis-list "^3.0.0" + json5 "^1.0.1" + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +lodash.clonedeep@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz#e23f3f9c4f8fbdde872529c1071857a086e5ccef" + integrity sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8= + +lodash.merge@^4.6.2: + version "4.6.2" + resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a" + integrity sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ== + +lodash.truncate@^4.4.2: + version "4.4.2" + resolved "https://registry.yarnpkg.com/lodash.truncate/-/lodash.truncate-4.4.2.tgz#5a350da0b1113b837ecfffd5812cbe58d6eae193" + integrity sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM= + +lru-cache@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" + integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA== + dependencies: + yallist "^4.0.0" + +make-dir@^3.0.2, make-dir@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.1.0.tgz#415e967046b3a7f1d185277d84aa58203726a13f" + integrity sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw== + dependencies: + semver "^6.0.0" + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +merge2@^1.3.0: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.4" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.4.tgz#896d519dfe9db25fce94ceb7a500919bf881ebf9" + integrity sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg== + dependencies: + braces "^3.0.1" + picomatch "^2.2.3" + [email protected]: + version "1.49.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.49.0.tgz#f3dfde60c99e9cf3bc9701d687778f537001cbed" + integrity sha512-CIc8j9URtOVApSFCQIF+VBkX1RwXp/oMMOrqdyXSBXq5RWNEsRfyj1kiRnQgmNXmHxPoFIxOroKA3zcU9P+nAA== + +mime-types@^2.1.27: + version "2.1.32" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.32.tgz#1d00e89e7de7fe02008db61001d9e02852670fd5" + integrity sha512-hJGaVS4G4c9TSMYh2n6SQAGrC4RnfU+daP8G7cSCmaqNjiOoUY0VHCMS42pxnQmVF1GWwFhbHWn3RIxCqTmZ9A== + dependencies: + mime-db "1.49.0" + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +minimatch@^3.0.3, minimatch@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" + integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA== + dependencies: + brace-expansion "^1.1.7" + +minimist@^1.2.0, minimist@^1.2.5: + version "1.2.5" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602" + integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw== + +mkdirp@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + [email protected]: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +nanocolors@^0.1.0, nanocolors@^0.1.5: + version "0.1.12" + resolved "https://registry.yarnpkg.com/nanocolors/-/nanocolors-0.1.12.tgz#8577482c58cbd7b5bb1681db4cf48f11a87fd5f6" + integrity sha512-2nMHqg1x5PU+unxX7PGY7AuYxl2qDx7PSrTRjizr8sxdd3l/3hBuWWaki62qmtYm2U5i4Z5E7GbjlyDFhs9/EQ== + +natural-compare@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" + integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc= + +neo-async@^2.6.2: + version "2.6.2" + resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" + integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== + +node-releases@^1.1.76: + version "1.1.76" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.1.76.tgz#df245b062b0cafbd5282ab6792f7dccc2d97f36e" + integrity sha512-9/IECtNr8dXNmPWmFXepT0/7o5eolGesHUa3mtr0KlgnCvnZxwh2qensKL42JJY2vQKC3nIBXetFAqR+PW1CmA== + [email protected]: + version "0.0.0" + resolved "https://registry.yarnpkg.com/noms/-/noms-0.0.0.tgz#da8ebd9f3af9d6760919b27d9cdc8092a7332859" + integrity sha1-2o69nzr51nYJGbJ9nNyAkqczKFk= + dependencies: + inherits "^2.0.1" + readable-stream "~1.0.31" + +npm-run-path@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +onetime@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== + dependencies: + mimic-fn "^2.1.0" + +optionator@^0.9.1: + version "0.9.1" + resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.9.1.tgz#4f236a6373dae0566a6d43e1326674f50c291499" + integrity sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw== + dependencies: + deep-is "^0.1.3" + fast-levenshtein "^2.0.6" + levn "^0.4.1" + prelude-ls "^1.2.1" + type-check "^0.4.0" + word-wrap "^1.2.3" + +p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-limit@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-3.1.0.tgz#e1daccbe78d0d1388ca18c64fea38e3e57e3706b" + integrity sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ== + dependencies: + yocto-queue "^0.1.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-parse@^1.0.6: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picomatch@^2.2.3: + version "2.3.0" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.0.tgz#f1f061de8f6a4bf022892e2d128234fb98302972" + integrity sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw== + +pkg-dir@^4.1.0, pkg-dir@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" + integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== + dependencies: + find-up "^4.0.0" + +prelude-ls@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" + integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== + +prettier@^2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.4.1.tgz#671e11c89c14a4cfc876ce564106c4a6726c9f5c" + integrity sha512-9fbDAXSBcc6Bs1mZrDYb3XKzDLm4EXXL9sC1LqKP5rZkT6KRr/rf9amVUcODVXgguK/isJz0d0hP72WeaKWsvA== + +process-nextick-args@~2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" + integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== + +progress@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" + integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== + +punycode@^2.1.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" + integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +randombytes@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a" + integrity sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ== + dependencies: + safe-buffer "^5.1.0" + +readable-stream@~1.0.31: + version "1.0.34" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c" + integrity sha1-Elgg40vIQtLyqq+v5MKRbuMsFXw= + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.1" + isarray "0.0.1" + string_decoder "~0.10.x" + +readable-stream@~2.3.6: + version "2.3.7" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.7.tgz#1eca1cf711aef814c04f62252a36a62f6cb23b57" + integrity sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw== + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.3" + isarray "~1.0.0" + process-nextick-args "~2.0.0" + safe-buffer "~5.1.1" + string_decoder "~1.1.1" + util-deprecate "~1.0.1" + +rechoir@^0.6.2: + version "0.6.2" + resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384" + integrity sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q= + dependencies: + resolve "^1.1.6" + +rechoir@^0.7.0: + version "0.7.1" + resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.7.1.tgz#9478a96a1ca135b5e88fc027f03ee92d6c645686" + integrity sha512-/njmZ8s1wVeR6pjTZ+0nCnv8SpZNRMT2D1RLOJQESlYFDBvwpTA4KWJpZ+sBJ4+vhjILRcK7JIFdGCdxEAAitg== + dependencies: + resolve "^1.9.0" + +regexpp@^3.1.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/regexpp/-/regexpp-3.2.0.tgz#0425a2768d8f23bad70ca4b90461fa2f1213e1b2" + integrity sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg== + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha1-jGStX9MNqxyXbiNE/+f3kqam30I= + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +resolve-cwd@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d" + integrity sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg== + dependencies: + resolve-from "^5.0.0" + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +resolve-from@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-5.0.0.tgz#c35225843df8f776df21c57557bc087e9dfdfc69" + integrity sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== + +resolve@^1.1.6, resolve@^1.9.0: + version "1.20.0" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.20.0.tgz#629a013fb3f70755d6f0b7935cc1c2c5378b1975" + integrity sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A== + dependencies: + is-core-module "^2.2.0" + path-parse "^1.0.6" + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +safe-buffer@^5.1.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +safe-buffer@~5.1.0, safe-buffer@~5.1.1: + version "5.1.2" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + +schema-utils@^2.6.5: + version "2.7.1" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-2.7.1.tgz#1ca4f32d1b24c590c203b8e7a50bf0ea4cd394d7" + integrity sha512-SHiNtMOUGWBQJwzISiVYKu82GiV4QYGePp3odlY1tuKO7gPtphAT5R/py0fA6xtbgLL/RvtJZnU9b8s0F1q0Xg== + dependencies: + "@types/json-schema" "^7.0.5" + ajv "^6.12.4" + ajv-keywords "^3.5.2" + +schema-utils@^3.1.0, schema-utils@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/schema-utils/-/schema-utils-3.1.1.tgz#bc74c4b6b6995c1d88f76a8b77bea7219e0c8281" + integrity sha512-Y5PQxS4ITlC+EahLuXaY86TXfR7Dc5lw294alXOq86JAHCihAIZfqv8nNCWvaEJvaC51uN9hbLGeV0cFBdH+Fw== + dependencies: + "@types/json-schema" "^7.0.8" + ajv "^6.12.5" + ajv-keywords "^3.5.2" + +semver@^6.0.0, semver@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" + integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== + +semver@^7.2.1, semver@^7.3.2, semver@^7.3.5: + version "7.3.5" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.5.tgz#0b621c879348d8998e4b0e4be94b3f12e6018ef7" + integrity sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ== + dependencies: + lru-cache "^6.0.0" + +serialize-javascript@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.0.tgz#efae5d88f45d7924141da8b5c3a7a7e663fefeb8" + integrity sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag== + dependencies: + randombytes "^2.1.0" + +shallow-clone@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/shallow-clone/-/shallow-clone-3.0.1.tgz#8f2981ad92531f55035b01fb230769a40e02efa3" + integrity sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA== + dependencies: + kind-of "^6.0.2" + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +shelljs@^0.8.3: + version "0.8.4" + resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.4.tgz#de7684feeb767f8716b326078a8a00875890e3c2" + integrity sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ== + dependencies: + glob "^7.0.0" + interpret "^1.0.0" + rechoir "^0.6.2" + +signal-exit@^3.0.3: + version "3.0.4" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.4.tgz#366a4684d175b9cab2081e3681fda3747b6c51d7" + integrity sha512-rqYhcAnZ6d/vTPGghdrw7iumdcbXpsk1b8IG/rz+VWV51DM0p7XCtMoJ3qhPLIbp3tvyt3pKRbaaEMZYpHto8Q== + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +slice-ansi@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/slice-ansi/-/slice-ansi-4.0.0.tgz#500e8dd0fd55b05815086255b3195adf2a45fe6b" + integrity sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ== + dependencies: + ansi-styles "^4.0.0" + astral-regex "^2.0.0" + is-fullwidth-code-point "^3.0.0" + +source-map-support@~0.5.20: + version "0.5.20" + resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.20.tgz#12166089f8f5e5e8c56926b377633392dd2cb6c9" + integrity sha512-n1lZZ8Ve4ksRqizaBQgxXDgKwttHDhyfQjA6YZZn8+AroHbsIz+JjwxQDxbp+7y5OYCI8t1Yk7etjD9CRd2hIw== + dependencies: + buffer-from "^1.0.0" + source-map "^0.6.0" + +source-map@^0.5.0: + version "0.5.7" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc" + integrity sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w= + +source-map@^0.6.0, source-map@^0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" + integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== + +source-map@~0.7.2: + version "0.7.3" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.3.tgz#5302f8169031735226544092e64981f751750383" + integrity sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ== + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw= + +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string_decoder@~0.10.x: + version "0.10.31" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-0.10.31.tgz#62e203bc41766c6c28c9fc84301dab1c5310fa94" + integrity sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ= + +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +strip-json-comments@^3.1.0, strip-json-comments@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +supports-color@^8.0.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + +table@^6.0.9: + version "6.7.1" + resolved "https://registry.yarnpkg.com/table/-/table-6.7.1.tgz#ee05592b7143831a8c94f3cee6aae4c1ccef33e2" + integrity sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg== + dependencies: + ajv "^8.0.1" + lodash.clonedeep "^4.5.0" + lodash.truncate "^4.4.2" + slice-ansi "^4.0.0" + string-width "^4.2.0" + strip-ansi "^6.0.0" + +tapable@^2.1.1, tapable@^2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.1.tgz#1967a73ef4060a82f12ab96af86d52fdb76eeca0" + integrity sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ== + +terser-webpack-plugin@^5.1.3: + version "5.2.4" + resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-5.2.4.tgz#ad1be7639b1cbe3ea49fab995cbe7224b31747a1" + integrity sha512-E2CkNMN+1cho04YpdANyRrn8CyN4yMy+WdFKZIySFZrGXZxJwJP6PMNGGc/Mcr6qygQHUUqRxnAPmi0M9f00XA== + dependencies: + jest-worker "^27.0.6" + p-limit "^3.1.0" + schema-utils "^3.1.1" + serialize-javascript "^6.0.0" + source-map "^0.6.1" + terser "^5.7.2" + +terser@^5.7.2: + version "5.9.0" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.9.0.tgz#47d6e629a522963240f2b55fcaa3c99083d2c351" + integrity sha512-h5hxa23sCdpzcye/7b8YqbE5OwKca/ni0RQz1uRX3tGh8haaGHqcuSqbGRybuAKNdntZ0mDgFNXPJ48xQ2RXKQ== + dependencies: + commander "^2.20.0" + source-map "~0.7.2" + source-map-support "~0.5.20" + +text-table@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4" + integrity sha1-f17oI66AUgfACvLfSoTsP8+lcLQ= + +through2@^2.0.1: + version "2.0.5" + resolved "https://registry.yarnpkg.com/through2/-/through2-2.0.5.tgz#01c1e39eb31d07cb7d03a96a70823260b23132cd" + integrity sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ== + dependencies: + readable-stream "~2.3.6" + xtend "~4.0.1" + +to-fast-properties@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/to-fast-properties/-/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e" + integrity sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4= + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +tslib@^1.8.1: + version "1.14.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" + integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== + +tsutils@^3.21.0: + version "3.21.0" + resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-3.21.0.tgz#b48717d394cea6c1e096983eed58e9d61715b623" + integrity sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA== + dependencies: + tslib "^1.8.1" + +type-check@^0.4.0, type-check@~0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.4.0.tgz#07b8203bfa7056c0657050e3ccd2c37730bab8f1" + integrity sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew== + dependencies: + prelude-ls "^1.2.1" + +type-fest@^0.20.2: + version "0.20.2" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4" + integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ== + +typescript@^4.1.0-dev.20201026, typescript@^4.4.3: + version "4.4.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324" + integrity sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA== + +untildify@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/untildify/-/untildify-4.0.0.tgz#2bc947b953652487e4600949fb091e3ae8cd919b" + integrity sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw== + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +util-deprecate@~1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8= + +v8-compile-cache@^2.0.3, v8-compile-cache@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz#2de19618c66dc247dcfb6f99338035d8245a2cee" + integrity sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA== + +watchpack@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.2.0.tgz#47d78f5415fe550ecd740f99fe2882323a58b1ce" + integrity sha512-up4YAn/XHgZHIxFBVCdlMiWDj6WaLKpwVeGQk2I5thdYxF/KmF0aaz6TfJZ/hfl1h/XlcDr7k1KH7ThDagpFaA== + dependencies: + glob-to-regexp "^0.4.1" + graceful-fs "^4.1.2" + +webpack-cli@^4.8.0: + version "4.8.0" + resolved "https://registry.yarnpkg.com/webpack-cli/-/webpack-cli-4.8.0.tgz#5fc3c8b9401d3c8a43e2afceacfa8261962338d1" + integrity sha512-+iBSWsX16uVna5aAYN6/wjhJy1q/GKk4KjKvfg90/6hykCTSgozbfz5iRgDTSJt/LgSbYxdBX3KBHeobIs+ZEw== + dependencies: + "@discoveryjs/json-ext" "^0.5.0" + "@webpack-cli/configtest" "^1.0.4" + "@webpack-cli/info" "^1.3.0" + "@webpack-cli/serve" "^1.5.2" + colorette "^1.2.1" + commander "^7.0.0" + execa "^5.0.0" + fastest-levenshtein "^1.0.12" + import-local "^3.0.2" + interpret "^2.2.0" + rechoir "^0.7.0" + v8-compile-cache "^2.2.0" + webpack-merge "^5.7.3" + +webpack-merge@^5.7.3: + version "5.8.0" + resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-5.8.0.tgz#2b39dbf22af87776ad744c390223731d30a68f61" + integrity sha512-/SaI7xY0831XwP6kzuwhKWVKDP9t1QY1h65lAFLbZqMPIuYcD9QAW4u9STIbU9kaJbPBB/geU/gLr1wDjOhQ+Q== + dependencies: + clone-deep "^4.0.1" + wildcard "^2.0.0" + +webpack-sources@^3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.2.1.tgz#251a7d9720d75ada1469ca07dbb62f3641a05b6d" + integrity sha512-t6BMVLQ0AkjBOoRTZgqrWm7xbXMBzD+XDq2EZ96+vMfn3qKgsvdXZhbPZ4ElUOpdv4u+iiGe+w3+J75iy/bYGA== + +webpack@^5.53.0: + version "5.54.0" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.54.0.tgz#629f0cd14c7a4340af758a3c7cef25c50670ae4d" + integrity sha512-MAVKJMsIUotOQKzFOmN8ZkmMlj7BOyjDU6t1lomW9dWOme5WTStzGa3HMLdV1KYD1AiFETGsznL4LMSvj4tukw== + dependencies: + "@types/eslint-scope" "^3.7.0" + "@types/estree" "^0.0.50" + "@webassemblyjs/ast" "1.11.1" + "@webassemblyjs/wasm-edit" "1.11.1" + "@webassemblyjs/wasm-parser" "1.11.1" + acorn "^8.4.1" + acorn-import-assertions "^1.7.6" + browserslist "^4.14.5" + chrome-trace-event "^1.0.2" + enhanced-resolve "^5.8.3" + es-module-lexer "^0.9.0" + eslint-scope "5.1.1" + events "^3.2.0" + glob-to-regexp "^0.4.1" + graceful-fs "^4.2.4" + json-parse-better-errors "^1.0.2" + loader-runner "^4.2.0" + mime-types "^2.1.27" + neo-async "^2.6.2" + schema-utils "^3.1.0" + tapable "^2.1.1" + terser-webpack-plugin "^5.1.3" + watchpack "^2.2.0" + webpack-sources "^3.2.0" + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +wildcard@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.0.tgz#a77d20e5200c6faaac979e4b3aadc7b3dd7f8fec" + integrity sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw== + +word-wrap@^1.2.3: + version "1.2.3" + resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c" + integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ== + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +xtend@~4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54" + integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ== + +y18n@^5.0.5: + version "5.0.8" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" + integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== + +yallist@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" + integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== + +yargs-parser@^20.2.2: + version "20.2.9" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee" + integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w== + +yargs@^16.1.0: + version "16.2.0" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66" + integrity sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw== + dependencies: + cliui "^7.0.2" + escalade "^3.1.1" + get-caller-file "^2.0.5" + require-directory "^2.1.1" + string-width "^4.2.0" + y18n "^5.0.5" + yargs-parser "^20.2.2" + +yocto-queue@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" + integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== diff --git a/Pusher.ts b/Pusher.ts index a0d17d0..8d5e06e 100644 --- a/Pusher.ts +++ b/Pusher.ts @@ -0,0 +1,59 @@ +import type { Container } from "tsparticles-engine"; +import { + Circle, + Constants, + ExternalInteractorBase, + Range, + getDistances, + calcEasing, + clamp, + isInArray, + ClickMode, + HoverMode, + Vector, +} from "tsparticles-engine"; +import { itemFromArray } from "tsparticles-engine"; + +/** + * Particle attract manager + * @category Interactions + / +export class Pusher extends ExternalInteractorBase { + handleClickMode: (mode: string) => void; + + constructor(container: Container) { + super(container); + + this.handleClickMode = (mode) => { + if (mode !== ClickMode.push) { + return; + } + + const container = this.container; + const options = container.actualOptions; + const pushNb = options.interactivity.modes.push.quantity; + + if (pushNb <= 0) { + return; + } + + const pushOptions = options.interactivity.modes.push; + const group = itemFromArray([undefined, ...pushOptions.groups]); + const groupOptions = group !== undefined ? container.actualOptions.particles.groups[group] : undefined; + + container.particles.push(pushNb, container.interactivity.mouse, groupOptions, group); + }; + } + + isEnabled(): boolean { + return true; + } + + reset(): void { + // do nothing + } + + interact(): void { + // do nothing + } +} diff --git a/Remover.ts b/Remover.ts index 9e0229e..9ac346e 100644 --- a/Remover.ts +++ b/Remover.ts @@ -0,0 +1,38 @@ +import type { Container } from "tsparticles-engine"; +import { ExternalInteractorBase, ClickMode } from "tsparticles-engine"; + +/* + * Particle attract manager + * @category Interactions + / +export class Remover extends ExternalInteractorBase { + handleClickMode: (mode: string) => void; + + constructor(container: Container) { + super(container); + + this.handleClickMode = (mode) => { + if (mode !== ClickMode.remove) { + return; + } + + const container = this.container; + const options = container.actualOptions; + const removeNb = options.interactivity.modes.remove.quantity; + + container.particles.removeQuantity(removeNb); + }; + } + + isEnabled(): boolean { + return true; + } + + reset(): void { + // do nothing + } + + interact(): void { + // do nothing + } +} diff --git a/Repulser.ts b/Repulser.ts index 1cce3e5..1d60eee 100644 --- a/Repulser.ts +++ b/Repulser.ts @@ -26,8 +26,34 @@ import type { RepulseDiv } from "tsparticles-engine/Options/Classes/Interactivit @category Interactions / export class Repulser extends ExternalInteractorBase { + handleClickMode: (mode: string) => void; + constructor(container: Container) { super(container); + + this.handleClickMode = (mode) => { + const options = this.container.actualOptions; + + if (mode !== ClickMode.repulse) { + return; + } + + container.repulse.clicking = true; + container.repulse.count = 0; + + for (const particle of container.repulse.particles) { + particle.velocity.setTo(particle.initialVelocity); + } + + container.repulse.particles = []; + container.repulse.finish = false; + + setTimeout(() => { + if (!container.destroyed) { + container.repulse.clicking = false; + } + }, options.interactivity.modes.repulse.duration 1000); + }; } isEnabled(): boolean { diff --git a/options.ts b/options.ts index 2298342..97ca475 100644 --- a/options.ts +++ b/options.ts @@ -32,6 +32,7 @@ export const options: ISourceOptions = { }, }, interactivity: { + detectsOn: "window", events: { onClick: { enable: true, diff --git a/getExternals.js b/getExternals.js index 3cd2f6f..793ee96 100644 --- a/getExternals.js +++ b/getExternals.js @@ -28,6 +28,9 @@ const getExternals = (bundle) => { "tsparticles-interaction-external-bubble", "tsparticles-interaction-external-connect", "tsparticles-interaction-external-grab", + "tsparticles-interaction-external-pause", + "tsparticles-interaction-external-push", + "tsparticles-interaction-external-remove", "tsparticles-interaction-external-repulse", "tsparticles-interaction-external-trail", "tsparticles-interaction-light",
test(polars): fix now-invalid comparisons	86512e53f0eafe0faf60211630b3ab9ece276262	test	https://github.com/ibis-project/ibis/commit/86512e53f0eafe0faf60211630b3ab9ece276262	fix now-invalid comparisons	[email protected]	diff --git a/test_temporal.py b/test_temporal.py index e31c2c2..357768b 100644 --- a/test_temporal.py +++ b/test_temporal.py @@ -1209,9 +1209,7 @@ def test_timestamp_comparison_filter(backend, con, alltypes, df, func_name): "gt", marks=[ pytest.mark.notimpl( - [ - "dask", - ], + ["dask"], raises=ValueError, reason="Metadata inference failed in `gt`.", ), @@ -1226,9 +1224,7 @@ def test_timestamp_comparison_filter(backend, con, alltypes, df, func_name): "ge", marks=[ pytest.mark.notimpl( - [ - "dask", - ], + ["dask"], raises=ValueError, reason="Metadata inference failed in `ge`.", ), @@ -1243,9 +1239,7 @@ def test_timestamp_comparison_filter(backend, con, alltypes, df, func_name): "lt", marks=[ pytest.mark.notimpl( - [ - "dask", - ], + ["dask"], raises=ValueError, reason="Metadata inference failed in `lt`.", ), @@ -1260,9 +1254,7 @@ def test_timestamp_comparison_filter(backend, con, alltypes, df, func_name): "le", marks=[ pytest.mark.notimpl( - [ - "dask", - ], + ["dask"], raises=ValueError, reason="Metadata inference failed in `le`.", ), @@ -1287,6 +1279,11 @@ def test_timestamp_comparison_filter(backend, con, alltypes, df, func_name): raises=AttributeError, reason="Can only use .dt accessor with datetimelike values", ) [email protected]( + ["polars"], + raises=BaseException, # pyo3_runtime.PanicException is not a subclass of Exception + reason="failed to determine supertype of datetime[ns, UTC] and datetime[ns]", +) def test_timestamp_comparison_filter_numpy(backend, con, alltypes, df, func_name): ts = np.datetime64('2010-03-02 00:00:00.000123')
test(api): add `names`/`types` `ibis.schema` parameters test	e297d4e9a58398d5956e48eccb4e67b25b8abd86	test	https://github.com/rohankumardubey/ibis/commit/e297d4e9a58398d5956e48eccb4e67b25b8abd86	add `names`/`types` `ibis.schema` parameters test	[email protected]	diff --git a/test_schema.py b/test_schema.py index b6e6e74..35721eb 100644 --- a/test_schema.py +++ b/test_schema.py @@ -194,3 +194,8 @@ def test_api_accepts_schema_objects(): s1 = ibis.schema(dict(a="int", b="str")) s2 = ibis.schema(s1) assert s1 == s2 + + +def test_names_types(): + s = ibis.schema(names=["a"], types=["array<float64>"]) + assert s == ibis.schema(dict(a="array<float64>"))
test: add some tests and disable failed tests	4ff562611ad14c94a6765aed27498aeb0c4c9c1c	test	https://github.com/pmndrs/react-spring/commit/4ff562611ad14c94a6765aed27498aeb0c4c9c1c	add some tests and disable failed tests	[email protected]	diff --git a/Controller.test.ts b/Controller.test.ts index 2388b30..f7cc7b8 100644 --- a/Controller.test.ts +++ b/Controller.test.ts @@ -118,41 +118,77 @@ describe('Controller', () => { }) }) - describe('when "loop" is used with async "to" prop', () => { - it('calls the "to" function repeatedly', async () => { - const ctrl = new Controller({ t: 0 }) - const { t } = ctrl.springs + describe('when "loop" is used when "to" is', () => { + describe('an async function', () => { + it('calls the "to" function repeatedly', async () => { + const ctrl = new Controller({ t: 0 }) + const { t } = ctrl.springs + + let loop = true + let times = 2 + + // Note: This example is silly, since you could use a for-loop + // to more easily achieve the same result, but it tests the ability + // to halt a looping script via the "loop" function prop. + ctrl.start({ + loop: () => loop, + to: async next => { + await next({ t: 1 }) + await next({ t: 0 }) + + if (times--) return + loop = false + }, + }) - let loop = true - let times = 2 - - // Note: This example is silly, since you could use a for-loop - // to more easily achieve the same result, but it tests the ability - // to halt a looping script via the "loop" function prop. - ctrl.start({ - loop: () => loop, - to: async next => { - await next({ t: 1 }) - await next({ t: 0 }) + await advanceUntilValue(t, 1) + expect(t.idle).toBeFalsy() - if (times--) return - loop = false - }, - }) + for (let i = 0; i < 2; i++) { + await advanceUntilValue(t, 0) + expect(t.idle).toBeFalsy() - await advanceUntilValue(t, 1) - expect(t.idle).toBeFalsy() + await advanceUntilValue(t, 1) + expect(t.idle).toBeFalsy() + } - for (let i = 0; i < 2; i++) { await advanceUntilValue(t, 0) - expect(t.idle).toBeFalsy() - - await advanceUntilValue(t, 1) - expect(t.idle).toBeFalsy() - } - - await advanceUntilValue(t, 0) - expect(t.idle).toBeTruthy() + expect(t.idle).toBeTruthy() + }) + }) + describe('an array', () => { + it('repeats the chain of updates', async () => { + const ctrl = new Controller({ t: 0 }) + const { t } = ctrl.springs + + let loop = true + const promise = ctrl.start({ + loop: () => { + return loop + }, + from: { t: 0 }, + to: [{ t: 1 }, { t: 2 }], + config: { duration: 3000 / 60 }, + }) + + for (let i = 0; i < 3; i++) { + await advanceUntilValue(t, 2) + expect(t.idle).toBeFalsy() + + // Run the first frame of the next loop. + mockRaf.step() + } + + loop = false + + await advanceUntilValue(t, 2) + expect(t.idle).toBeTruthy() + + expect(await promise).toMatchObject({ + value: { t: 2 }, + finished: true, + }) + }) }) }) }) diff --git a/SpringValue.test.ts b/SpringValue.test.ts index 529f2a1..12e5bbb 100644 --- a/SpringValue.test.ts +++ b/SpringValue.test.ts @@ -15,7 +15,20 @@ describe('SpringValue', () => { expect(frames).toMatchSnapshot() }) - it('animates a number the same as a numeric string', async () => { + it('can animate a string', async () => { + const spring = new SpringValue() + spring.start({ + to: '10px 20px', + from: '0px 0px', + config: { duration: 10 * frameLength }, + }) + await advanceUntilIdle() + const frames = getFrames(spring) + expect(frames).toMatchSnapshot() + }) + + // FIXME: This test fails. + xit('animates a number the same as a numeric string', async () => { const spring1 = new SpringValue(0) spring1.start(10) @@ -29,19 +42,8 @@ describe('SpringValue', () => { expect(frames).toEqual(getFrames(spring2)) }) - it('can animate a string', async () => { - const spring = new SpringValue() - spring.start({ - to: '10px 20px', - from: '0px 0px', - config: { duration: 10 * frameLength }, - }) - await advanceUntilIdle() - const frames = getFrames(spring) - expect(frames).toMatchSnapshot() - }) - - it('can animate an array of numbers', async () => { + // FIXME: This test fails. + xit('can animate an array of numbers', async () => { const spring = new SpringValue() spring.start({ to: [10, 20], @@ -100,6 +102,7 @@ function describeProps() { describeToProp() describeFromProp() describeResetProp() + describeDefaultProp() describeReverseProp() describeImmediateProp() describeConfigProp() @@ -142,31 +145,113 @@ function describeToProp() { } function describeFromProp() { - describe('when "from" prop is changed', () => { - describe('before the first animation', () => { - it('updates the current value', () => { - const spring = new SpringValue<number>({ from: 1, to: 1 }) - expect(spring.idle).toBeTruthy() - expect(spring.get()).toBe(1) - - spring.start({ from: 0 }) - expect(spring.idle).toBeFalsy() - expect(spring.get()).toBe(0) - }) - }) - describe('after the first animation', () => { - it.todo('does nothing unless "reset" is true') - }) + describe('when "from" prop is defined', () => { + it.todo('controls the start value') }) } function describeResetProp() { describe('when "reset" prop is true', () => { + it('calls "onRest" before jumping back to its "from" value', async () => { + const spring = new SpringValue(0) + + const onRest = jest.fn((result: any) => { + expect(result.value).toBe(1) + expect(spring.get()).toBe(1) + }) + + spring.start(1, { onRest, loop: true }) + + await advanceUntilValue(spring, 1) + expect(onRest).toHaveBeenCalled() + + // The spring has been reset. + expect(spring.get()).toBe(0) + }) + it.todo('resolves the "start" promise with (finished: false)') it.todo('calls the "onRest" prop with (finished: false)') }) } +function describeDefaultProp() { + // The hook API always uses { default: true } for render-driven updates. + // Some props can have default values (eg: onRest, config, etc), and + // other props may behave differently when { default: true } is used. + describe('when "default" prop is true', () => { + describe('and "from" prop is changed', () => { + describe('before the first animation', () => { + it('updates the current value', () => { + const props = { default: true, from: 1, to: 1 } + const spring = new SpringValue(props) + expect(spring.get()).toBe(1) + expect(spring.idle).toBeTruthy() + + props.from = 0 + spring.start(props) + expect(spring.get()).toBe(0) + + // The animation should be started, now that from !== to + expect(spring.idle).toBeFalsy() + }) + }) + + describe('after the first animation', () => { + it('does not start animating', async () => { + const props = { default: true, from: 0, to: 2 } + const spring = new SpringValue(props) + await advanceUntilIdle() + + props.from = 1 + spring.start(props) + + expect(spring.get()).toBe(2) + expect(spring.idle).toBeTruthy() + expect(spring.animation.from).toBe(1) + }) + + describe('and "reset" prop is true', () => { + it('starts at the "from" prop', async () => { + const props: any = { default: true, from: 0, to: 2 } + const spring = new SpringValue(props) + await advanceUntilIdle() + + props.from = 1 + props.reset = true + spring.start(props) + + expect(spring.get()).toBe(1) + expect(spring.idle).toBeFalsy() + }) + }) + }) + }) + }) + + describe('when "default" prop is false', () => { + describe('and "from" prop is defined', () => { + it('updates the current value', () => { + const spring = new SpringValue(0) + spring.start({ from: 1 }) + expect(spring.get()).toBe(1) + }) + it('updates the "from" value', () => { + const spring = new SpringValue(0) + spring.start({ from: 1 }) + expect(spring.animation.from).toBe(1) + }) + + describe('and "to" prop is undefined', () => { + it('updates the "to" value', () => { + const spring = new SpringValue(0) + spring.start({ from: 1 }) + expect(spring.animation.to).toBe(1) + }) + }) + }) + }) +} + function describeReverseProp() { describe('when "reverse" prop is true', () => { it('swaps the "to" and "from" props', async () => { @@ -266,7 +351,8 @@ function describeConfigProp() { }) }) describe('when "damping" is less than 1.0', () => { - it('should bounce', async () => { + // FIXME: This test fails. + xit('should bounce', async () => { const spring = new SpringValue(0) spring.start(1, { config: { frequency: 1.5, damping: 1 }, @@ -523,7 +609,8 @@ function describeTarget(name: string, create: (from: number) => OpaqueTarget) { }) }) - describe('when animating a string', () => { + // FIXME: These tests fail. + xdescribe('when animating a string', () => { it('animates as expected', async () => { const spring = new SpringValue('yellow') spring.start('red', {
fix: `gix clone` now handles empty repositories. (#792) Previously it would panic as the case was unexpected, now it prints a message informing about the empty repository similar to how git does.	32cfeac2f4d7bb02f6ce5d01a62906aa64d3e487	fix	https://github.com/Byron/gitoxide/commit/32cfeac2f4d7bb02f6ce5d01a62906aa64d3e487	`gix clone` now handles empty repositories. (#792) Previously it would panic as the case was unexpected, now it prints a message informing about the empty repository similar to how git does.	[email protected]	diff --git a/clone.rs b/clone.rs index 9b37462..88c7818 100644 --- a/clone.rs +++ b/clone.rs @@ -86,7 +86,7 @@ pub(crate) mod function { match fetch_outcome.status { Status::NoPackReceived { .. } => { - unreachable!("clone always has changes") + writeln!(err, "The cloned repository appears to be empty")?; } Status::DryRun { .. } => unreachable!("dry-run unsupported"), Status::Change { update_refs, .. } => {
chore(deps): relock	da418e1dc85eea9b7d222b6478802c8ef4132aaa	chore	https://github.com/ibis-project/ibis/commit/da418e1dc85eea9b7d222b6478802c8ef4132aaa	relock	[email protected]	diff --git a/poetry.lock b/poetry.lock index c3b2346..eb9af24 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,9 +1,10 @@ -# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand. +# This file is automatically @generated by Poetry and should not be changed by hand. [[package]] name = "appnope" version = "0.1.3" description = "Disable App Nap on macOS >= 10.9" +category = "dev" optional = false python-versions = "" files = [ @@ -15,6 +16,7 @@ files = [ name = "asn1crypto" version = "1.5.1" description = "Fast ASN.1 parser and serializer with definitions for private keys, public keys, certificates, CRL, OCSP, CMS, PKCS#3, PKCS#7, PKCS#8, PKCS#12, PKCS#5, X.509 and TSP" +category = "main" optional = true python-versions = "" files = [ @@ -26,6 +28,7 @@ files = [ name = "asttokens" version = "2.2.1" description = "Annotate AST trees with source code positions" +category = "dev" optional = false python-versions = "" files = [ @@ -43,6 +46,7 @@ test = ["astroid", "pytest"] name = "atpublic" version = "4.0" description = "Keep all y'all's __all__'s in sync" +category = "main" optional = false python-versions = ">=3.8" files = [ @@ -54,6 +58,7 @@ files = [ name = "attrs" version = "23.1.0" description = "Classes Without Boilerplate" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -72,6 +77,7 @@ tests-no-zope = ["cloudpickle", "hypothesis", "mypy (>=1.1.1)", "pympler", "pyte name = "babel" version = "2.12.1" description = "Internationalization utilities" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -86,6 +92,7 @@ pytz = {version = ">=2015.7", markers = "python_version < \\"3.9\\""} name = "backcall" version = "0.2.0" description = "Specifications for callback functions passed in to an API" +category = "dev" optional = false python-versions = "" files = [ @@ -97,6 +104,7 @@ files = [ name = "backports-zoneinfo" version = "0.2.1" description = "Backport of the standard library zoneinfo module" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -125,6 +133,7 @@ tzdata = ["tzdata"] name = "beautifulsoup4" version = "4.12.2" description = "Screen-scraping library" +category = "dev" optional = false python-versions = ">=3.6.0" files = [ @@ -143,6 +152,7 @@ lxml = ["lxml"] name = "bidict" version = "0.22.1" description = "The bidirectional mapping library for Python." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -159,6 +169,7 @@ test = ["hypothesis", "pytest", "pytest-benchmark[histogram]", "pytest-cov", "py name = "bitarray" version = "2.7.4" description = "efficient arrays of booleans -- C extension" +category = "main" optional = true python-versions = "" files = [ @@ -255,6 +266,7 @@ files = [ name = "black" version = "23.3.0" description = "The uncompromising code formatter." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -304,6 +316,7 @@ uvloop = ["uvloop (>=0.15.2)"] name = "bleach" version = "6.0.0" description = "An easy safelist-based HTML-sanitizing tool." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -322,6 +335,7 @@ css = ["tinycss2 (>=1.1.0,<1.2)"] name = "cachetools" version = "5.3.1" description = "Extensible memoizing collections and decorators" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -333,6 +347,7 @@ files = [ name = "certifi" version = "2023.5.7" description = "Python package for providing Mozilla's CA Bundle." +category = "main" optional = false python-versions = ">=3.6" files = [ @@ -344,6 +359,7 @@ files = [ name = "cffi" version = "1.15.1" description = "Foreign Function Interface for Python calling C code." +category = "main" optional = false python-versions = "" files = [ @@ -420,6 +436,7 @@ pycparser = "" name = "cfgv" version = "3.3.1" description = "Validate configuration and produce human readable error messages." +category = "dev" optional = false python-versions = ">=3.6.1" files = [ @@ -431,6 +448,7 @@ files = [ name = "chardet" version = "5.1.0" description = "Universal encoding detector for Python 3" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -442,6 +460,7 @@ files = [ name = "charset-normalizer" version = "3.1.0" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +category = "main" optional = false python-versions = ">=3.7.0" files = [ @@ -526,6 +545,7 @@ files = [ name = "click" version = "8.1.3" description = "Composable command line interface toolkit" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -540,6 +560,7 @@ colorama = {version = "", markers = "platform_system == \\"Windows\\""} name = "click-plugins" version = "1.1.1" description = "An extension module for click to enable registering CLI commands via setuptools entry-points." +category = "main" optional = true python-versions = "" files = [ @@ -557,6 +578,7 @@ dev = ["coveralls", "pytest (>=3.6)", "pytest-cov", "wheel"] name = "clickhouse-connect" version = "0.5.25" description = "ClickHouse core driver, SqlAlchemy, and Superset libraries" +category = "main" optional = true python-versions = "~=3.7" files = [ @@ -649,6 +671,7 @@ superset = ["apache-superset (>=1.4.1)"] name = "cligj" version = "0.7.2" description = "Click params for commmand line interfaces to GeoJSON" +category = "main" optional = true python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., <4" files = [ @@ -666,6 +689,7 @@ test = ["pytest-cov"] name = "cloudpickle" version = "2.2.1" description = "Extended pickling support for Python objects" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -677,6 +701,7 @@ files = [ name = "codespell" version = "2.2.4" description = "Codespell" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -698,6 +723,7 @@ types = ["chardet (>=5.1.0)", "mypy", "pytest", "pytest-cov", "pytest-dependency name = "colorama" version = "0.4.6" description = "Cross-platform colored terminal text." +category = "main" optional = false python-versions = "!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4.,!=3.5.,!=3.6.,>=2.7" files = [ @@ -709,6 +735,7 @@ files = [ name = "comm" version = "0.1.3" description = "Jupyter Python Comm implementation, for usage in ipykernel, xeus-python etc." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -728,6 +755,7 @@ typing = ["mypy (>=0.990)"] name = "coverage" version = "7.2.7" description = "Code coverage measurement for Python" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -803,6 +831,7 @@ toml = ["tomli"] name = "cryptography" version = "40.0.2" description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers." +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -844,6 +873,7 @@ tox = ["tox"] name = "dask" version = "2023.5.0" description = "Parallel PyData with Task Scheduling" +category = "main" optional = true python-versions = ">=3.8" files = [ @@ -856,7 +886,7 @@ click = ">=8.0" cloudpickle = ">=1.5.0" fsspec = ">=2021.09.0" importlib-metadata = ">=4.13.0" -numpy = {version = ">=1.21", optional = true, markers = "extra == \\"array\\" or extra == \\"dataframe\\""} +numpy = {version = ">=1.21", optional = true, markers = "extra == \\"array\\""} packaging = ">=20.0" pandas = {version = ">=1.3", optional = true, markers = "extra == \\"dataframe\\""} partd = ">=1.2.0" @@ -875,6 +905,7 @@ test = ["pandas[test]", "pre-commit", "pytest", "pytest-rerunfailures", "pytest- name = "datafusion" version = "22.0.0" description = "Build and run queries against data" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -893,6 +924,7 @@ pyarrow = ">=6.0.1" name = "db-dtypes" version = "1.1.1" description = "Pandas Data Types for SQL systems (BigQuery, Spanner)" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -910,6 +942,7 @@ pyarrow = ">=3.0.0" name = "debugpy" version = "1.6.7" description = "An implementation of the Debug Adapter Protocol for Python" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -937,6 +970,7 @@ files = [ name = "decorator" version = "5.1.1" description = "Decorators for Humans" +category = "dev" optional = false python-versions = ">=3.5" files = [ @@ -948,6 +982,7 @@ files = [ name = "defusedxml" version = "0.7.1" description = "XML bomb protection for Python stdlib modules" +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4." files = [ @@ -959,6 +994,7 @@ files = [ name = "deltalake" version = "0.10.0" description = "Native Delta Lake Python binding based on delta-rs with Pandas integration" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -983,6 +1019,7 @@ pyspark = ["delta-spark", "numpy (==1.22.2)", "pyspark"] name = "distlib" version = "0.3.6" description = "Distribution utilities" +category = "dev" optional = false python-versions = "" files = [ @@ -994,6 +1031,7 @@ files = [ name = "duckdb" version = "0.8.0" description = "DuckDB embedded database" +category = "main" optional = true python-versions = "" files = [ @@ -1050,6 +1088,7 @@ files = [ name = "duckdb-engine" version = "0.7.3" description = "SQLAlchemy driver for duckdb" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1066,6 +1105,7 @@ sqlalchemy = ">=1.3.22" name = "dunamai" version = "1.17.0" description = "Dynamic version generation" +category = "dev" optional = false python-versions = ">=3.5,<4.0" files = [ @@ -1080,6 +1120,7 @@ packaging = ">=20.9" name = "exceptiongroup" version = "1.1.1" description = "Backport of PEP 654 (exception groups)" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1094,6 +1135,7 @@ test = ["pytest (>=6)"] name = "execnet" version = "1.9.0" description = "execnet: rapid multi-Python deployment" +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4." files = [ @@ -1108,6 +1150,7 @@ testing = ["pre-commit"] name = "executing" version = "1.2.0" description = "Get the currently executing AST node of a frame, and other information" +category = "dev" optional = false python-versions = "" files = [ @@ -1122,6 +1165,7 @@ tests = ["asttokens", "littleutils", "pytest", "rich"] name = "fastjsonschema" version = "2.17.1" description = "Fastest Python implementation of JSON schema" +category = "dev" optional = false python-versions = "" files = [ @@ -1136,6 +1180,7 @@ devel = ["colorama", "json-spec", "jsonschema", "pylint", "pytest", "pytest-benc name = "filelock" version = "3.12.0" description = "A platform independent file lock." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1151,6 +1196,7 @@ testing = ["covdefaults (>=2.3)", "coverage (>=7.2.3)", "diff-cover (>=7.5)", "p name = "fiona" version = "1.9.4.post1" description = "Fiona reads and writes spatial data files" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1195,6 +1241,7 @@ test = ["Fiona[s3]", "pytest (>=7)", "pytest-cov", "pytz"] name = "fsspec" version = "2023.5.0" description = "File-system specification" +category = "main" optional = true python-versions = ">=3.8" files = [ @@ -1230,6 +1277,7 @@ tqdm = ["tqdm"] name = "geoalchemy2" version = "0.13.3" description = "Using SQLAlchemy with Spatial Databases" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1245,6 +1293,7 @@ SQLAlchemy = ">=1.4" name = "geopandas" version = "0.13.0" description = "Geographic pandas extensions" +category = "main" optional = true python-versions = ">=3.8" files = [ @@ -1263,6 +1312,7 @@ shapely = ">=1.7.1" name = "ghp-import" version = "2.1.0" description = "Copy your docs directly to the gh-pages branch." +category = "dev" optional = false python-versions = "" files = [ @@ -1280,6 +1330,7 @@ dev = ["flake8", "markdown", "twine", "wheel"] name = "gitdb" version = "4.0.10" description = "Git Object Database" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1294,6 +1345,7 @@ smmap = ">=3.0.1,<6" name = "gitpython" version = "3.1.31" description = "GitPython is a Python library used to interact with Git repositories" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1308,6 +1360,7 @@ gitdb = ">=4.0.1,<5" name = "google-api-core" version = "2.11.0" description = "Google API client core library" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1320,11 +1373,11 @@ google-auth = ">=2.14.1,<3.0dev" googleapis-common-protos = ">=1.56.2,<2.0dev" grpcio = [ {version = ">=1.33.2,<2.0dev", optional = true, markers = "extra == \\"grpc\\""}, - {version = ">=1.49.1,<2.0dev", optional = true, markers = "python_version >= \\"3.11\\" and extra == \\"grpc\\""}, + {version = ">=1.49.1,<2.0dev", optional = true, markers = "python_version >= \\"3.11\\""}, ] grpcio-status = [ {version = ">=1.33.2,<2.0dev", optional = true, markers = "extra == \\"grpc\\""}, - {version = ">=1.49.1,<2.0dev", optional = true, markers = "python_version >= \\"3.11\\" and extra == \\"grpc\\""}, + {version = ">=1.49.1,<2.0dev", optional = true, markers = "python_version >= \\"3.11\\""}, ] protobuf = ">=3.19.5,<3.20.0 \|\| >3.20.0,<3.20.1 \|\| >3.20.1,<4.21.0 \|\| >4.21.0,<4.21.1 \|\| >4.21.1,<4.21.2 \|\| >4.21.2,<4.21.3 \|\| >4.21.3,<4.21.4 \|\| >4.21.4,<4.21.5 \|\| >4.21.5,<5.0.0dev" requests = ">=2.18.0,<3.0.0dev" @@ -1338,6 +1391,7 @@ grpcio-gcp = ["grpcio-gcp (>=0.2.2,<1.0dev)"] name = "google-auth" version = "2.19.1" description = "Google Authentication Library" +category = "main" optional = false python-versions = ">=3.6" files = [ @@ -1363,6 +1417,7 @@ requests = ["requests (>=2.20.0,<3.0.0dev)"] name = "google-auth-oauthlib" version = "1.0.0" description = "Google Authentication Library" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -1381,6 +1436,7 @@ tool = ["click (>=6.0.0)"] name = "google-cloud-bigquery" version = "3.11.0" description = "Google BigQuery API client library" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1389,7 +1445,7 @@ files = [ ] [package.dependencies] -google-api-core = {version = ">=1.31.5,<2.0.dev0 \|\| >2.3.0,<3.0.0dev", extras = ["grpc"]} +google-api-core = {version = ">=1.31.5,<2.0.0 \|\| >2.3.0,<3.0.0dev", extras = ["grpc"]} google-cloud-core = ">=1.6.0,<3.0.0dev" google-resumable-media = ">=0.6.0,<3.0dev" grpcio = [ @@ -1416,6 +1472,7 @@ tqdm = ["tqdm (>=4.7.4,<5.0.0dev)"] name = "google-cloud-bigquery-storage" version = "2.20.0" description = "Google Cloud Bigquery Storage API client library" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1424,7 +1481,7 @@ files = [ ] [package.dependencies] -google-api-core = {version = ">=1.34.0,<2.0.dev0 \|\| >=2.11.dev0,<3.0.0dev", extras = ["grpc"]} +google-api-core = {version = ">=1.34.0,<2.0.0 \|\| >=2.11.0,<3.0.0dev", extras = ["grpc"]} proto-plus = [ {version = ">=1.22.0,<2.0.0dev", markers = "python_version < \\"3.11\\""}, {version = ">=1.22.2,<2.0.0dev", markers = "python_version >= \\"3.11\\""}, @@ -1440,6 +1497,7 @@ pyarrow = ["pyarrow (>=0.15.0)"] name = "google-cloud-core" version = "2.3.2" description = "Google Cloud API client core library" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1448,7 +1506,7 @@ files = [ ] [package.dependencies] -google-api-core = ">=1.31.6,<2.0.dev0 \|\| >2.3.0,<3.0.0dev" +google-api-core = ">=1.31.6,<2.0.0 \|\| >2.3.0,<3.0.0dev" google-auth = ">=1.25.0,<3.0dev" [package.extras] @@ -1458,6 +1516,7 @@ grpc = ["grpcio (>=1.38.0,<2.0dev)"] name = "google-cloud-storage" version = "2.9.0" description = "Google Cloud Storage API client library" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1466,7 +1525,7 @@ files = [ ] [package.dependencies] -google-api-core = ">=1.31.5,<2.0.dev0 \|\| >2.3.0,<3.0.0dev" +google-api-core = ">=1.31.5,<2.0.0 \|\| >2.3.0,<3.0.0dev" google-auth = ">=1.25.0,<3.0dev" google-cloud-core = ">=2.3.0,<3.0dev" google-resumable-media = ">=2.3.2" @@ -1479,6 +1538,7 @@ protobuf = ["protobuf (<5.0.0dev)"] name = "google-crc32c" version = "1.5.0" description = "A python wrapper of the C library 'Google CRC32C'" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1559,6 +1619,7 @@ testing = ["pytest"] name = "google-resumable-media" version = "2.5.0" description = "Utilities for Google Media Downloads and Resumable Uploads" +category = "main" optional = false python-versions = ">= 3.7" files = [ @@ -1577,6 +1638,7 @@ requests = ["requests (>=2.18.0,<3.0.0dev)"] name = "googleapis-common-protos" version = "1.59.0" description = "Common protobufs used in Google APIs" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1594,6 +1656,7 @@ grpc = ["grpcio (>=1.44.0,<2.0.0dev)"] name = "gprof2dot" version = "2022.7.29" description = "Generate a dot graph from the output of several profilers." +category = "dev" optional = false python-versions = ">=2.7" files = [ @@ -1605,6 +1668,7 @@ files = [ name = "graphviz" version = "0.20.1" description = "Simple Python interface for Graphviz" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1621,6 +1685,7 @@ test = ["coverage", "mock (>=4)", "pytest (>=7)", "pytest-cov", "pytest-mock (>= name = "greenlet" version = "2.0.2" description = "Lightweight in-process concurrent programming" +category = "main" optional = false python-versions = ">=2.7,!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4." files = [ @@ -1694,6 +1759,7 @@ test = ["objgraph", "psutil"] name = "griffe" version = "0.29.0" description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1708,6 +1774,7 @@ colorama = ">=0.4" name = "grpcio" version = "1.54.2" description = "HTTP/2-based RPC framework" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -1765,6 +1832,7 @@ protobuf = ["grpcio-tools (>=1.54.2)"] name = "grpcio-status" version = "1.54.2" description = "Status proto mapping for gRPC" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -1781,6 +1849,7 @@ protobuf = ">=4.21.6" name = "hypothesis" version = "6.76.0" description = "A library for property-based testing" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1813,6 +1882,7 @@ zoneinfo = ["backports.zoneinfo (>=0.2.1)", "tzdata (>=2023.3)"] name = "identify" version = "2.5.24" description = "File identification library for Python" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1827,6 +1897,7 @@ license = ["ukkonen"] name = "idna" version = "3.4" description = "Internationalized Domain Names in Applications (IDNA)" +category = "main" optional = false python-versions = ">=3.5" files = [ @@ -1838,6 +1909,7 @@ files = [ name = "importlib-metadata" version = "6.6.0" description = "Read metadata from Python packages" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1857,6 +1929,7 @@ testing = ["flake8 (<5)", "flufl.flake8", "importlib-resources (>=1.3)", "packag name = "importlib-resources" version = "5.12.0" description = "Read resources from Python packages" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -1875,6 +1948,7 @@ testing = ["flake8 (<5)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-chec name = "impyla" version = "0.18.0" description = "Python client for the Impala distributed query engine" +category = "main" optional = true python-versions = "" files = [ @@ -1895,6 +1969,7 @@ kerberos = ["kerberos (>=1.3.0)"] name = "iniconfig" version = "2.0.0" description = "brain-dead simple config-ini parsing" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -1906,6 +1981,7 @@ files = [ name = "ipykernel" version = "6.23.1" description = "IPython Kernel for Jupyter" +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -1919,7 +1995,7 @@ comm = ">=0.1.1" debugpy = ">=1.6.5" ipython = ">=7.23.1" jupyter-client = ">=6.1.12" -jupyter-core = ">=4.12,<5.0.dev0 \|\| >=5.1.dev0" +jupyter-core = ">=4.12,<5.0.0 \|\| >=5.1.0" matplotlib-inline = ">=0.1" nest-asyncio = "" packaging = "" @@ -1939,6 +2015,7 @@ test = ["flaky", "ipyparallel", "pre-commit", "pytest (>=7.0)", "pytest-asyncio" name = "ipython" version = "8.12.2" description = "IPython: Productive Interactive Computing" +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -1978,6 +2055,7 @@ test-extra = ["curio", "matplotlib (!=3.2.0)", "nbformat", "numpy (>=1.21)", "pa name = "jedi" version = "0.18.2" description = "An autocompletion tool for Python that can be used for text editors." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -1997,6 +2075,7 @@ testing = ["Django (<3.1)", "attrs", "colorama", "docopt", "pytest (<7.0.0)"] name = "jinja2" version = "3.1.2" description = "A very fast and expressive template engine." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2014,6 +2093,7 @@ i18n = ["Babel (>=2.7)"] name = "jsonschema" version = "4.17.3" description = "An implementation of JSON Schema validation for Python" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2035,6 +2115,7 @@ format-nongpl = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339- name = "jupyter-client" version = "8.2.0" description = "Jupyter protocol implementation and client libraries" +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -2044,7 +2125,7 @@ files = [ [package.dependencies] importlib-metadata = {version = ">=4.8.3", markers = "python_version < \\"3.10\\""} -jupyter-core = ">=4.12,<5.0.dev0 \|\| >=5.1.dev0" +jupyter-core = ">=4.12,<5.0.0 \|\| >=5.1.0" python-dateutil = ">=2.8.2" pyzmq = ">=23.0" tornado = ">=6.2" @@ -2058,6 +2139,7 @@ test = ["coverage", "ipykernel (>=6.14)", "mypy", "paramiko", "pre-commit", "pyt name = "jupyter-core" version = "5.3.0" description = "Jupyter core package. A base package on which Jupyter projects rely." +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -2078,6 +2160,7 @@ test = ["ipykernel", "pre-commit", "pytest", "pytest-cov", "pytest-timeout"] name = "jupyterlab-pygments" version = "0.2.2" description = "Pygments theme using JupyterLab CSS variables" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2089,6 +2172,7 @@ files = [ name = "jupytext" version = "1.14.6" description = "Jupyter notebooks as Markdown documents, Julia, Python or R scripts" +category = "dev" optional = false python-versions = "~=3.6" files = [ @@ -2111,6 +2195,7 @@ toml = ["toml"] name = "locket" version = "1.0.0" description = "File-based locks for Python on Linux and Windows" +category = "main" optional = true python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -2122,6 +2207,7 @@ files = [ name = "lz4" version = "4.3.2" description = "LZ4 Bindings for Python" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -2171,6 +2257,7 @@ tests = ["psutil", "pytest (!=3.3.0)", "pytest-cov"] name = "markdown" version = "3.3.7" description = "Python implementation of Markdown." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -2188,6 +2275,7 @@ testing = ["coverage", "pyyaml"] name = "markdown-it-py" version = "2.2.0" description = "Python port of markdown-it. Markdown parsing, done right!" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2212,6 +2300,7 @@ testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"] name = "markupsafe" version = "2.1.3" description = "Safely add untrusted strings to HTML/XML markup." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2271,6 +2360,7 @@ files = [ name = "matplotlib-inline" version = "0.1.6" description = "Inline Matplotlib backend for Jupyter" +category = "dev" optional = false python-versions = ">=3.5" files = [ @@ -2285,6 +2375,7 @@ traitlets = "" name = "mdit-py-plugins" version = "0.3.5" description = "Collection of plugins for markdown-it-py" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2304,6 +2395,7 @@ testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"] name = "mdurl" version = "0.1.2" description = "Markdown URL utilities" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2315,6 +2407,7 @@ files = [ name = "mergedeep" version = "1.3.4" description = "A deep merge function for 🐍." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -2326,6 +2419,7 @@ files = [ name = "mistune" version = "2.0.5" description = "A sane Markdown parser with useful plugins and renderers" +category = "dev" optional = false python-versions = "" files = [ @@ -2337,6 +2431,7 @@ files = [ name = "mkdocs" version = "1.4.3" description = "Project documentation with Markdown." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2365,6 +2460,7 @@ min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-imp name = "mkdocs-autorefs" version = "0.4.1" description = "Automatically link across pages in MkDocs." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2380,6 +2476,7 @@ mkdocs = ">=1.1" name = "mkdocs-exclude" version = "1.0.2" description = "A mkdocs plugin that lets you exclude files or trees." +category = "dev" optional = false python-versions = "" files = [ @@ -2393,6 +2490,7 @@ mkdocs = "" name = "mkdocs-gen-files" version = "0.5.0" description = "MkDocs plugin to programmatically generate documentation pages during the build" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2407,6 +2505,7 @@ mkdocs = ">=1.0.3" name = "mkdocs-git-revision-date-localized-plugin" version = "1.2.0" description = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -2424,6 +2523,7 @@ pytz = "" name = "mkdocs-jupyter" version = "0.24.1" description = "Use Jupyter in mkdocs websites" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2445,6 +2545,7 @@ test = ["pytest", "pytest-cov"] name = "mkdocs-literate-nav" version = "0.6.0" description = "MkDocs plugin to specify the navigation in Markdown instead of YAML" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2459,6 +2560,7 @@ mkdocs = ">=1.0.3" name = "mkdocs-macros-plugin" version = "1.0.1" description = "Unleash the power of MkDocs with macros and variables" +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -2480,6 +2582,7 @@ test = ["mkdocs-include-markdown-plugin", "mkdocs-macros-test", "mkdocs-material name = "mkdocs-material" version = "9.1.15" description = "Documentation that simply works" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2502,6 +2605,7 @@ requests = ">=2.26" name = "mkdocs-material-extensions" version = "1.1.1" description = "Extension pack for Python Markdown and MkDocs Material." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2513,6 +2617,7 @@ files = [ name = "mkdocstrings" version = "0.22.0" description = "Automatic documentation from sources, for MkDocs." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2539,6 +2644,7 @@ python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"] name = "mkdocstrings-python" version = "1.1.2" description = "A Python handler for mkdocstrings." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2554,6 +2660,7 @@ mkdocstrings = ">=0.20" name = "multipledispatch" version = "0.6.0" description = "Multiple dispatch" +category = "main" optional = false python-versions = "" files = [ @@ -2569,6 +2676,7 @@ six = "" name = "mypy-extensions" version = "1.0.0" description = "Type system extensions for programs checked with the mypy type checker." +category = "main" optional = false python-versions = ">=3.5" files = [ @@ -2580,6 +2688,7 @@ files = [ name = "nbclient" version = "0.8.0" description = "A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor." +category = "dev" optional = false python-versions = ">=3.8.0" files = [ @@ -2589,7 +2698,7 @@ files = [ [package.dependencies] jupyter-client = ">=6.1.12" -jupyter-core = ">=4.12,<5.0.dev0 \|\| >=5.1.dev0" +jupyter-core = ">=4.12,<5.0.0 \|\| >=5.1.0" nbformat = ">=5.1" traitlets = ">=5.4" @@ -2602,6 +2711,7 @@ test = ["flaky", "ipykernel (>=6.19.3)", "ipython", "ipywidgets", "nbconvert (>= name = "nbconvert" version = "7.4.0" description = "Converting Jupyter Notebooks" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -2640,6 +2750,7 @@ webpdf = ["pyppeteer (>=1,<1.1)"] name = "nbformat" version = "5.9.0" description = "The Jupyter Notebook format" +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -2661,6 +2772,7 @@ test = ["pep440", "pre-commit", "pytest", "testpath"] name = "nest-asyncio" version = "1.5.6" description = "Patch asyncio to allow nested event loops" +category = "dev" optional = false python-versions = ">=3.5" files = [ @@ -2672,6 +2784,7 @@ files = [ name = "nodeenv" version = "1.8.0" description = "Node.js virtual environment builder" +category = "dev" optional = false python-versions = ">=2.7,!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4.,!=3.5.,!=3.6." files = [ @@ -2686,6 +2799,7 @@ setuptools = "" name = "numpy" version = "1.24.3" description = "Fundamental package for array computing in Python" +category = "main" optional = false python-versions = ">=3.8" files = [ @@ -2723,6 +2837,7 @@ files = [ name = "oauthlib" version = "3.2.2" description = "A generic, spec-compliant, thorough implementation of the OAuth request-signing logic" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -2739,6 +2854,7 @@ signedtoken = ["cryptography (>=3.0.0)", "pyjwt (>=2.0.0,<3)"] name = "oracledb" version = "1.3.1" description = "Python interface to Oracle Database" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -2779,6 +2895,7 @@ cryptography = ">=3.2.1" name = "oscrypto" version = "1.3.0" description = "TLS (SSL) sockets, key generation, encryption, decryption, signing, verification and KDFs using the OS crypto libraries. Does not require a compiler, and relies on the OS for patching. Works on Windows, OS X and Linux/BSD." +category = "main" optional = true python-versions = "" files = [ @@ -2793,6 +2910,7 @@ asn1crypto = ">=1.5.1" name = "packaging" version = "23.1" description = "Core utilities for Python packages" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2804,6 +2922,7 @@ files = [ name = "pandas" version = "2.0.2" description = "Powerful data structures for data analysis, time series, and statistics" +category = "main" optional = false python-versions = ">=3.8" files = [ @@ -2871,6 +2990,7 @@ xml = ["lxml (>=4.6.3)"] name = "pandocfilters" version = "1.5.0" description = "Utilities for writing pandoc filters in python" +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -2882,6 +3002,7 @@ files = [ name = "parso" version = "0.8.3" description = "A Python Parser" +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -2897,6 +3018,7 @@ testing = ["docopt", "pytest (<6.0.0)"] name = "parsy" version = "2.1" description = "Easy-to-use parser combinators, for parsing in pure Python" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2908,6 +3030,7 @@ files = [ name = "partd" version = "1.4.0" description = "Appendable key-value storage" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -2926,6 +3049,7 @@ complete = ["blosc", "numpy (>=1.9.0)", "pandas (>=0.19.0)", "pyzmq"] name = "pathspec" version = "0.11.1" description = "Utility library for gitignore style pattern matching of file paths." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2937,6 +3061,7 @@ files = [ name = "pexpect" version = "4.8.0" description = "Pexpect allows easy control of interactive console applications." +category = "dev" optional = false python-versions = "" files = [ @@ -2951,6 +3076,7 @@ ptyprocess = ">=0.5" name = "pickleshare" version = "0.7.5" description = "Tiny 'shelve'-like database with concurrency support" +category = "dev" optional = false python-versions = "" files = [ @@ -2962,6 +3088,7 @@ files = [ name = "pkgutil-resolve-name" version = "1.3.10" description = "Resolve a name to an object." +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -2973,6 +3100,7 @@ files = [ name = "platformdirs" version = "3.5.1" description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \\"user data dir\\"." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -2988,6 +3116,7 @@ test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.3.1)", "pytest- name = "pluggy" version = "1.0.0" description = "plugin and hook calling mechanisms for python" +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -3003,6 +3132,7 @@ testing = ["pytest", "pytest-benchmark"] name = "poetry-dynamic-versioning" version = "0.22.0" description = "Plugin for Poetry to enable dynamic versioning based on VCS tags" +category = "dev" optional = false python-versions = ">=3.7,<4.0" files = [ @@ -3022,6 +3152,7 @@ plugin = ["poetry (>=1.2.0,<2.0.0)"] name = "polars" version = "0.18.0" description = "Blazingly fast DataFrame library" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -3051,6 +3182,7 @@ xlsxwriter = ["xlsxwriter"] name = "pooch" version = "1.7.0" description = "\\"Pooch manages your Python library's sample data files: it automatically downloads and stores them in a local directory, with support for versioning and corruption checks.\\"" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -3074,6 +3206,7 @@ xxhash = ["xxhash (>=1.4.3)"] name = "pprintpp" version = "0.4.0" description = "A drop-in replacement for pprint that's actually pretty" +category = "dev" optional = false python-versions = "" files = [ @@ -3085,6 +3218,7 @@ files = [ name = "pre-commit" version = "3.3.2" description = "A framework for managing and maintaining multi-language pre-commit hooks." +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -3103,6 +3237,7 @@ virtualenv = ">=20.10.0" name = "prompt-toolkit" version = "3.0.38" description = "Library for building powerful interactive command lines in Python" +category = "dev" optional = false python-versions = ">=3.7.0" files = [ @@ -3117,6 +3252,7 @@ wcwidth = "" name = "proto-plus" version = "1.22.2" description = "Beautiful, Pythonic protocol buffers." +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -3134,6 +3270,7 @@ testing = ["google-api-core[grpc] (>=1.31.5)"] name = "protobuf" version = "4.23.2" description = "" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -3156,6 +3293,7 @@ files = [ name = "psutil" version = "5.9.5" description = "Cross-platform lib for process and system monitoring in Python." +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -3182,6 +3320,7 @@ test = ["enum34", "ipaddress", "mock", "pywin32", "wmi"] name = "psycopg2" version = "2.9.6" description = "psycopg2 - Python-PostgreSQL Database Adapter" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -3204,6 +3343,7 @@ files = [ name = "ptyprocess" version = "0.7.0" description = "Run a subprocess in a pseudo terminal" +category = "dev" optional = false python-versions = "" files = [ @@ -3215,6 +3355,7 @@ files = [ name = "pure-eval" version = "0.2.2" description = "Safely evaluate AST nodes without side effects" +category = "dev" optional = false python-versions = "" files = [ @@ -3229,6 +3370,7 @@ tests = ["pytest"] name = "pure-sasl" version = "0.6.2" description = "Pure Python client SASL implementation" +category = "main" optional = true python-versions = "" files = [ @@ -3243,6 +3385,7 @@ gssapi = ["kerberos (>=1.3.0)"] name = "py-cpuinfo" version = "9.0.0" description = "Get CPU info with pure Python" +category = "dev" optional = false python-versions = "" files = [ @@ -3254,6 +3397,7 @@ files = [ name = "py4j" version = "0.10.9.5" description = "Enables Python programs to dynamically access arbitrary Java objects" +category = "main" optional = true python-versions = "" files = [ @@ -3265,6 +3409,7 @@ files = [ name = "pyarrow" version = "10.0.1" description = "Python library for Apache Arrow" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -3302,6 +3447,7 @@ numpy = ">=1.16.6" name = "pyasn1" version = "0.5.0" description = "Pure-Python implementation of ASN.1 types and DER/BER/CER codecs (X.208)" +category = "main" optional = false python-versions = "!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4.,!=3.5.,>=2.7" files = [ @@ -3313,6 +3459,7 @@ files = [ name = "pyasn1-modules" version = "0.3.0" description = "A collection of ASN.1-based protocols modules" +category = "main" optional = false python-versions = "!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4.,!=3.5.,>=2.7" files = [ @@ -3327,6 +3474,7 @@ pyasn1 = ">=0.4.6,<0.6.0" name = "pycparser" version = "2.21" description = "C parser in Python" +category = "main" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -3338,6 +3486,7 @@ files = [ name = "pycryptodomex" version = "3.18.0" description = "Cryptographic library for Python" +category = "main" optional = true python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4." files = [ @@ -3379,6 +3528,7 @@ files = [ name = "pydata-google-auth" version = "1.8.0" description = "PyData helpers for authenticating to Google APIs" +category = "main" optional = true python-versions = "" files = [ @@ -3395,6 +3545,7 @@ setuptools = "" name = "pydeps" version = "1.12.8" description = "Display module dependencies" +category = "dev" optional = false python-versions = "" files = [ @@ -3409,6 +3560,7 @@ stdlib-list = "" name = "pydruid" version = "0.6.5" description = "A Python connector for Druid." +category = "main" optional = true python-versions = "" files = [ @@ -3429,6 +3581,7 @@ sqlalchemy = ["sqlalchemy"] name = "pygments" version = "2.15.1" description = "Pygments is a syntax highlighting package written in Python." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -3443,6 +3596,7 @@ plugins = ["importlib-metadata"] name = "pyjwt" version = "2.7.0" description = "JSON Web Token implementation in Python" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -3460,6 +3614,7 @@ tests = ["coverage[toml] (==5.0.4)", "pytest (>=6.0.0,<7.0.0)"] name = "pymdown-extensions" version = "10.0.1" description = "Extension pack for Python Markdown." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3475,6 +3630,7 @@ pyyaml = "" name = "pymssql" version = "2.2.7" description = "DB-API interface to Microsoft SQL Server for Python. (new Cython-based version)" +category = "main" optional = true python-versions = "" files = [ @@ -3545,6 +3701,7 @@ files = [ name = "pymysql" version = "1.0.3" description = "Pure Python MySQL Driver" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -3560,6 +3717,7 @@ rsa = ["cryptography"] name = "pyopenssl" version = "23.2.0" description = "Python wrapper module around the OpenSSL library" +category = "main" optional = true python-versions = ">=3.6" files = [ @@ -3578,6 +3736,7 @@ test = ["flaky", "pretend", "pytest (>=3.0.1)"] name = "pyproj" version = "3.5.0" description = "Python interface to PROJ (cartographic projections and coordinate transformations library)" +category = "main" optional = true python-versions = ">=3.8" files = [ @@ -3625,6 +3784,7 @@ certifi = "" name = "pyrsistent" version = "0.19.3" description = "Persistent/Functional/Immutable data structures" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3661,6 +3821,7 @@ files = [ name = "pyspark" version = "3.3.2" description = "Apache Spark Python API" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -3680,6 +3841,7 @@ sql = ["pandas (>=1.0.5)", "pyarrow (>=1.0.0)"] name = "pytest" version = "7.3.1" description = "pytest: simple powerful testing with Python" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3702,6 +3864,7 @@ testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "no name = "pytest-benchmark" version = "4.0.0" description = "A ``pytest`` fixture for benchmarking code. It will group the tests into rounds that are calibrated to the chosen timer." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3722,6 +3885,7 @@ histogram = ["pygal", "pygaljs"] name = "pytest-clarity" version = "1.0.1" description = "A plugin providing an alternative, colourful diff output for failing assertions." +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -3737,6 +3901,7 @@ rich = ">=8.0.0" name = "pytest-cov" version = "4.1.0" description = "Pytest plugin for measuring coverage." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3755,6 +3920,7 @@ testing = ["fields", "hunter", "process-tests", "pytest-xdist", "six", "virtuale name = "pytest-httpserver" version = "1.0.8" description = "pytest-httpserver is a httpserver for pytest" +category = "dev" optional = false python-versions = ">=3.8,<4.0" files = [ @@ -3769,6 +3935,7 @@ Werkzeug = ">=2.0.0" name = "pytest-mock" version = "3.10.0" description = "Thin-wrapper around the mock package for easier use with pytest" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3786,6 +3953,7 @@ dev = ["pre-commit", "pytest-asyncio", "tox"] name = "pytest-profiling" version = "1.7.0" description = "Profiling plugin for py.test" +category = "dev" optional = false python-versions = "" files = [ @@ -3805,6 +3973,7 @@ tests = ["pytest-virtualenv"] name = "pytest-randomly" version = "3.12.0" description = "Pytest plugin to randomly order tests and control random.seed." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3820,6 +3989,7 @@ pytest = "" name = "pytest-repeat" version = "0.9.1" description = "pytest plugin for repeating tests" +category = "dev" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4." files = [ @@ -3834,6 +4004,7 @@ pytest = ">=3.6" name = "pytest-snapshot" version = "0.9.0" description = "A plugin for snapshot testing with pytest." +category = "dev" optional = false python-versions = ">=3.5" files = [ @@ -3848,6 +4019,7 @@ pytest = ">=3.0.0" name = "pytest-xdist" version = "3.3.1" description = "pytest xdist plugin for distributed testing, most importantly across multiple CPUs" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -3868,6 +4040,7 @@ testing = ["filelock"] name = "python-dateutil" version = "2.8.2" description = "Extensions to the standard Python datetime module" +category = "main" optional = false python-versions = "!=3.0.,!=3.1.,!=3.2.,>=2.7" files = [ @@ -3882,6 +4055,7 @@ six = ">=1.5" name = "pytz" version = "2023.3" description = "World timezone definitions, modern and historical" +category = "main" optional = false python-versions = "" files = [ @@ -3893,6 +4067,7 @@ files = [ name = "pywin32" version = "306" description = "Python for Window Extensions" +category = "dev" optional = false python-versions = "" files = [ @@ -3916,6 +4091,7 @@ files = [ name = "pyyaml" version = "6.0" description = "YAML parser and emitter for Python" +category = "main" optional = false python-versions = ">=3.6" files = [ @@ -3965,6 +4141,7 @@ files = [ name = "pyyaml-env-tag" version = "0.1" description = "A custom YAML tag for referencing environment variables in YAML files. " +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -3979,6 +4156,7 @@ pyyaml = "" name = "pyzmq" version = "25.1.0" description = "Python bindings for 0MQ" +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -4068,6 +4246,7 @@ cffi = {version = "", markers = "implementation_name == \\"pypy\\""} name = "regex" version = "2023.6.3" description = "Alternative regular expression module, to replace re." +category = "main" optional = false python-versions = ">=3.6" files = [ @@ -4165,6 +4344,7 @@ files = [ name = "requests" version = "2.31.0" description = "Python HTTP for Humans." +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -4186,6 +4366,7 @@ use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] name = "requests-oauthlib" version = "1.3.1" description = "OAuthlib authentication support for Requests." +category = "main" optional = true python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3." files = [ @@ -4204,6 +4385,7 @@ rsa = ["oauthlib[signedtoken] (>=3.0.0)"] name = "rich" version = "13.4.1" description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal" +category = "main" optional = false python-versions = ">=3.7.0" files = [ @@ -4223,6 +4405,7 @@ jupyter = ["ipywidgets (>=7.5.1,<9)"] name = "rsa" version = "4.9" description = "Pure-Python RSA implementation" +category = "main" optional = false python-versions = ">=3.6,<4" files = [ @@ -4237,6 +4420,7 @@ pyasn1 = ">=0.1.3" name = "ruff" version = "0.0.272" description = "An extremely fast Python linter, written in Rust." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4263,6 +4447,7 @@ files = [ name = "setuptools" version = "67.8.0" description = "Easily download, build, install, upgrade, and uninstall Python packages" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -4279,6 +4464,7 @@ testing-integration = ["build[virtualenv]", "filelock (>=3.4.0)", "jaraco.envs ( name = "shapely" version = "2.0.1" description = "Manipulation and analysis of geometric objects" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -4326,13 +4512,14 @@ files = [ numpy = ">=1.14" [package.extras] -docs = ["matplotlib", "numpydoc (==1.1.)", "sphinx", "sphinx-book-theme", "sphinx-remove-toctrees"] +docs = ["matplotlib", "numpydoc (>=1.1.0,<1.2.0)", "sphinx", "sphinx-book-theme", "sphinx-remove-toctrees"] test = ["pytest", "pytest-cov"] [[package]] name = "six" version = "1.16.0" description = "Python 2 and 3 compatibility utilities" +category = "main" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2." files = [ @@ -4344,6 +4531,7 @@ files = [ name = "smmap" version = "5.0.0" description = "A pure Python implementation of a sliding window memory map manager" +category = "dev" optional = false python-versions = ">=3.6" files = [ @@ -4355,6 +4543,7 @@ files = [ name = "snowflake-connector-python" version = "3.0.4" description = "Snowflake Connector for Python" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -4415,6 +4604,7 @@ secure-local-storage = ["keyring (!=16.1.0,<24.0.0)"] name = "snowflake-sqlalchemy" version = "1.4.7" description = "Snowflake SQLAlchemy Dialect" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -4437,6 +4627,7 @@ pandas = ["snowflake-connector-python[pandas] (<4.0.0)"] name = "sortedcontainers" version = "2.4.0" description = "Sorted Containers -- Sorted List, Sorted Dict, Sorted Set" +category = "main" optional = false python-versions = "" files = [ @@ -4448,6 +4639,7 @@ files = [ name = "soupsieve" version = "2.4.1" description = "A modern CSS selector implementation for Beautiful Soup." +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4459,6 +4651,7 @@ files = [ name = "sqlalchemy" version = "1.4.48" description = "Database Abstraction Library" +category = "main" optional = false python-versions = "!=3.0.,!=3.1.,!=3.2.,!=3.3.,!=3.4.,!=3.5.,>=2.7" files = [ @@ -4506,7 +4699,7 @@ files = [ ] [package.dependencies] -greenlet = {version = "!=0.4.17", markers = "python_version >= \\"3\\" and (platform_machine == \\"win32\\" or platform_machine == \\"WIN32\\" or platform_machine == \\"AMD64\\" or platform_machine == \\"amd64\\" or platform_machine == \\"x86_64\\" or platform_machine == \\"ppc64le\\" or platform_machine == \\"aarch64\\")"} +greenlet = {version = "!=0.4.17", markers = "python_version >= \\"3\\" and (platform_machine == \\"aarch64\\" or platform_machine == \\"ppc64le\\" or platform_machine == \\"x86_64\\" or platform_machine == \\"amd64\\" or platform_machine == \\"AMD64\\" or platform_machine == \\"win32\\" or platform_machine == \\"WIN32\\")"} [package.extras] aiomysql = ["aiomysql", "greenlet (!=0.4.17)"] @@ -4533,6 +4726,7 @@ sqlcipher = ["sqlcipher3-binary"] name = "sqlalchemy-views" version = "0.3.2" description = "Adds CreateView and DropView constructs to SQLAlchemy" +category = "main" optional = true python-versions = "" files = [ @@ -4547,6 +4741,7 @@ sqlalchemy = ">=1.0.0" name = "sqlglot" version = "15.0.0" description = "An easily customizable SQL parser and transpiler" +category = "main" optional = false python-versions = "" files = [ @@ -4561,6 +4756,7 @@ dev = ["autoflake", "black", "duckdb (>=0.6)", "isort", "mypy (>=0.990)", "panda name = "stack-data" version = "0.6.2" description = "Extract data from python stack frames and tracebacks for informative displays" +category = "dev" optional = false python-versions = "" files = [ @@ -4580,6 +4776,7 @@ tests = ["cython", "littleutils", "pygments", "pytest", "typeguard"] name = "stdlib-list" version = "0.8.0" description = "A list of Python Standard Libraries (2.6-7, 3.2-9)." +category = "dev" optional = false python-versions = "" files = [ @@ -4594,6 +4791,7 @@ develop = ["sphinx"] name = "termcolor" version = "2.3.0" description = "ANSI color formatting for output in terminal" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4608,6 +4806,7 @@ tests = ["pytest", "pytest-cov"] name = "thrift" version = "0.16.0" description = "Python bindings for the Apache Thrift RPC system" +category = "main" optional = true python-versions = "" files = [ @@ -4626,6 +4825,7 @@ twisted = ["twisted"] name = "thrift-sasl" version = "0.4.3" description = "Thrift SASL Python module that implements SASL transports for Thrift (`TSaslClientTransport`)." +category = "main" optional = true python-versions = "" files = [ @@ -4642,6 +4842,7 @@ thrift = {version = ">=0.10.0", markers = "python_version >= \\"3.0\\""} name = "tinycss2" version = "1.2.1" description = "A tiny CSS parser" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4660,6 +4861,7 @@ test = ["flake8", "isort", "pytest"] name = "toml" version = "0.10.2" description = "Python Library for Tom's Obvious, Minimal Language" +category = "dev" optional = false python-versions = ">=2.6, !=3.0., !=3.1., !=3.2." files = [ @@ -4671,6 +4873,7 @@ files = [ name = "tomli" version = "2.0.1" description = "A lil' TOML parser" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -4682,6 +4885,7 @@ files = [ name = "tomlkit" version = "0.11.8" description = "Style preserving TOML library" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4693,6 +4897,7 @@ files = [ name = "toolz" version = "0.12.0" description = "List processing tools and functional utilities" +category = "main" optional = false python-versions = ">=3.5" files = [ @@ -4704,6 +4909,7 @@ files = [ name = "tornado" version = "6.3.2" description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed." +category = "dev" optional = false python-versions = ">= 3.8" files = [ @@ -4724,6 +4930,7 @@ files = [ name = "tqdm" version = "4.65.0" description = "Fast, Extensible Progress Meter" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -4744,6 +4951,7 @@ telegram = ["requests"] name = "traitlets" version = "5.9.0" description = "Traitlets Python configuration system" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4759,6 +4967,7 @@ test = ["argcomplete (>=2.0)", "pre-commit", "pytest", "pytest-mock"] name = "trino" version = "0.326.0" description = "Client for the Trino distributed SQL Engine" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -4785,6 +4994,7 @@ tests = ["black", "httpretty (<1.1)", "isort", "pre-commit", "pytest", "pytest-r name = "typing-extensions" version = "4.6.3" description = "Backported and Experimental Type Hints for Python 3.7+" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -4796,6 +5006,7 @@ files = [ name = "tzdata" version = "2023.3" description = "Provider of IANA time zone data" +category = "main" optional = false python-versions = ">=2" files = [ @@ -4807,6 +5018,7 @@ files = [ name = "tzlocal" version = "5.0.1" description = "tzinfo object for the local timezone" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -4825,6 +5037,7 @@ devenv = ["black", "check-manifest", "flake8", "pyroma", "pytest (>=4.3)", "pyte name = "urllib3" version = "1.26.16" description = "HTTP library with thread-safe connection pooling, file post, and more." +category = "main" optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4., !=3.5." files = [ @@ -4841,6 +5054,7 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] name = "virtualenv" version = "20.23.0" description = "Virtual Python Environment builder" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4861,6 +5075,7 @@ test = ["covdefaults (>=2.3)", "coverage (>=7.2.3)", "coverage-enable-subprocess name = "watchdog" version = "3.0.0" description = "Filesystem events monitoring" +category = "dev" optional = false python-versions = ">=3.7" files = [ @@ -4900,6 +5115,7 @@ watchmedo = ["PyYAML (>=3.10)"] name = "wcwidth" version = "0.2.6" description = "Measures the displayed width of unicode strings in a terminal" +category = "dev" optional = false python-versions = "" files = [ @@ -4911,6 +5127,7 @@ files = [ name = "webencodings" version = "0.5.1" description = "Character encoding aliases for legacy web content" +category = "dev" optional = false python-versions = "" files = [ @@ -4922,6 +5139,7 @@ files = [ name = "werkzeug" version = "2.3.4" description = "The comprehensive WSGI web application library." +category = "dev" optional = false python-versions = ">=3.8" files = [ @@ -4939,6 +5157,7 @@ watchdog = ["watchdog (>=2.3)"] name = "xxhash" version = "3.2.0" description = "Python binding for xxHash" +category = "main" optional = false python-versions = ">=3.6" files = [ @@ -5046,6 +5265,7 @@ files = [ name = "zipp" version = "3.15.0" description = "Backport of pathlib-compatible object wrapper for zip files" +category = "main" optional = false python-versions = ">=3.7" files = [ @@ -5061,6 +5281,7 @@ testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more name = "zstandard" version = "0.21.0" description = "Zstandard bindings for Python" +category = "main" optional = true python-versions = ">=3.7" files = [ @@ -5116,7 +5337,7 @@ cffi = {version = ">=1.11", markers = "platform_python_implementation == \\"PyPy\\ cffi = ["cffi (>=1.11)"] [extras] -all = ["GeoAlchemy2", "black", "clickhouse-connect", "dask", "datafusion", "db-dtypes", "deltalake", "duckdb", "duckdb-engine", "fsspec", "geopandas", "google-cloud-bigquery", "google-cloud-bigquery-storage", "graphviz", "impyla", "oracledb", "packaging", "polars", "psycopg2", "pydata-google-auth", "pydruid", "pymssql", "pymysql", "pyspark", "regex", "requests", "shapely", "snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy", "sqlalchemy-views", "trino"] +all = ["black", "clickhouse-connect", "dask", "datafusion", "db-dtypes", "duckdb", "duckdb-engine", "deltalake", "fsspec", "GeoAlchemy2", "geopandas", "google-cloud-bigquery", "google-cloud-bigquery-storage", "graphviz", "impyla", "oracledb", "packaging", "polars", "psycopg2", "pydata-google-auth", "pydruid", "pymssql", "pymysql", "pyspark", "regex", "requests", "shapely", "snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy", "sqlalchemy-views", "trino"] bigquery = ["db-dtypes", "google-cloud-bigquery", "google-cloud-bigquery-storage", "pydata-google-auth"] clickhouse = ["clickhouse-connect", "sqlalchemy"] dask = ["dask", "regex"] @@ -5127,16 +5348,16 @@ druid = ["pydruid", "sqlalchemy"] duckdb = ["duckdb", "duckdb-engine", "packaging", "sqlalchemy", "sqlalchemy-views"] geospatial = ["GeoAlchemy2", "geopandas", "shapely"] impala = ["fsspec", "impyla", "requests", "sqlalchemy"] -mssql = ["pymssql", "sqlalchemy", "sqlalchemy-views"] -mysql = ["pymysql", "sqlalchemy", "sqlalchemy-views"] -oracle = ["oracledb", "packaging", "sqlalchemy", "sqlalchemy-views"] +mssql = ["sqlalchemy", "pymssql", "sqlalchemy-views"] +mysql = ["sqlalchemy", "pymysql", "sqlalchemy-views"] +oracle = ["sqlalchemy", "oracledb", "packaging", "sqlalchemy-views"] pandas = ["regex"] polars = ["polars"] postgres = ["psycopg2", "sqlalchemy", "sqlalchemy-views"] pyspark = ["pyspark", "sqlalchemy"] snowflake = ["snowflake-connector-python", "snowflake-sqlalchemy", "sqlalchemy-views"] sqlite = ["regex", "sqlalchemy", "sqlalchemy-views"] -trino = ["sqlalchemy", "sqlalchemy-views", "trino"] +trino = ["trino", "sqlalchemy", "sqlalchemy-views"] visualization = ["graphviz"] [metadata] diff --git a/requirements.txt b/requirements.txt index 8f7238e..cf2ce81 100644 --- a/requirements.txt +++ b/requirements.txt @@ -33,7 +33,7 @@ db-dtypes==1.1.1 ; python_version >= "3.8" and python_version < "4.0" debugpy==1.6.7 ; python_version >= "3.8" and python_version < "4.0" decorator==5.1.1 ; python_version >= "3.8" and python_version < "4.0" defusedxml==0.7.1 ; python_version >= "3.8" and python_version < "4.0" -deltalake==0.9.0 ; python_version >= "3.8" and python_version < "4.0" +deltalake==0.10.0 ; python_version >= "3.8" and python_version < "4.0" distlib==0.3.6 ; python_version >= "3.8" and python_version < "4.0" duckdb-engine==0.7.3 ; python_version >= "3.8" and python_version < "4.0" duckdb==0.8.0 ; python_version >= "3.8" and python_version < "4.0"
build: deps updated	ebb7604e494eb6c922d05982cb15fa4a23568c04	build	https://github.com/tsparticles/tsparticles/commit/ebb7604e494eb6c922d05982cb15fa4a23568c04	deps updated	[email protected]	diff --git a/package.json b/package.json index 792d615..130917d 100644 --- a/package.json +++ b/package.json @@ -109,7 +109,7 @@ "tsparticles-updater-wobble": "^2.6.0", "typescript": "^4.9.3", "webpack": "^5.75.0", - "webpack-tsparticles-plugin": "^1.5.0" + "webpack-tsparticles-plugin": "^1.5.1" }, "devDependencies": { "@types/eslint": "^8.4.10", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 771895f..243e357 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -6,9 +6,9 @@ importers: specifiers: '@commitlint/cli': ^17.3.0 '@commitlint/config-conventional': ^17.3.0 - '@nrwl/cli': ^15.2.4 + '@nrwl/cli': ^15.3.0 '@nrwl/nx-cloud': ^15.0.2 - '@nrwl/workspace': ^15.2.4 + '@nrwl/workspace': ^15.3.0 '@parcel/core': ^2.8.0 '@parcel/transformer-sass': ^2.8.0 '@tsparticles/prettier-config': ^1.4.0 @@ -17,7 +17,7 @@ importers: husky: ^8.0.2 ini: ^3.0.1 lerna: ^6.1.0 - nx: ^15.2.4 + nx: ^15.3.0 parcel: ^2.8.0 prettier: ^2.8.0 rimraf: ^3.0.2 @@ -32,9 +32,9 @@ importers: devDependencies: '@commitlint/cli': 17.3.0 '@commitlint/config-conventional': 17.3.0 - '@nrwl/cli': 15.2.4 + '@nrwl/cli': 15.3.0 '@nrwl/nx-cloud': 15.0.2 - '@nrwl/workspace': 15.2.4_uf7ur4xvpkq7xbobfxd2xaxn5y + '@nrwl/workspace': 15.3.0_brpckf4sz23pco3jyty2eys3iq '@parcel/core': 2.8.0 '@parcel/transformer-sass': 2.8.0_@[email protected] '@tsparticles/prettier-config': [email protected] @@ -43,7 +43,7 @@ importers: husky: 8.0.2 ini: 3.0.1 lerna: 6.1.0 - nx: 15.2.4 + nx: 15.3.0 parcel: 2.8.0 prettier: 2.8.0 rimraf: 3.0.2 @@ -59,7 +59,7 @@ importers: bundles/full: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -88,7 +88,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-external-trail: link:../../interactions/external/trail/dist @@ -102,7 +102,7 @@ importers: tsparticles-updater-wobble: link:../../updaters/wobble/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -121,13 +121,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist bundles/pjs: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -147,12 +147,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -171,13 +171,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist bundles/slim: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -228,7 +228,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-external-attract: link:../../interactions/external/attract/dist @@ -264,7 +264,7 @@ importers: tsparticles-updater-stroke-color: link:../../updaters/strokeColor/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -283,7 +283,7 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist components/angular: @@ -670,7 +670,7 @@ importers: '@typescript-eslint/eslint-plugin': ^5.45.1 '@typescript-eslint/parser': ^5.45.1 babel-loader: ^9.1.0 - babel-preset-solid: ^1.6.2 + babel-preset-solid: ^1.6.3 clean-webpack-plugin: ^4.0.0 css-loader: ^6.7.2 eslint: ^8.29.0 @@ -680,7 +680,7 @@ importers: node-sass: ^8.0.0 prettier: ^2.8.0 sass-loader: ^13.2.0 - solid-js: ^1.6.2 + solid-js: ^1.6.3 source-map-loader: ^4.0.1 style-loader: ^3.3.1 tsparticles-engine: ^2.6.0 @@ -690,7 +690,7 @@ importers: webpack-dev-server: ^4.11.1 dependencies: fast-deep-equal: 3.1.3 - solid-js: 1.6.2 + solid-js: 1.6.3 tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 @@ -703,7 +703,7 @@ importers: '@typescript-eslint/eslint-plugin': 5.45.1_tdm6ms4ntwhlpozn7kjqrhum74 '@typescript-eslint/parser': 5.45.1_s5ps7njkmjlaqajutnox5ntcla babel-loader: 9.1.0_ztqwsvkb6z73luspkai6ilstpu - babel-preset-solid: 1.6.2_@[email protected] + babel-preset-solid: 1.6.3_@[email protected] clean-webpack-plugin: [email protected] css-loader: [email protected] eslint: 8.29.0 @@ -731,7 +731,7 @@ importers: rollup: ^3.6.0 rollup-plugin-svelte: ^7.1.0 rollup-plugin-terser: ^7.0.2 - svelte: ^3.53.1 + svelte: ^3.54.0 svelte-check: ^2.10.1 svelte-preprocess: ^4.10.7 tslib: ^2.4.1 @@ -746,13 +746,13 @@ importers: '@tsconfig/svelte': 3.0.0 '@tsparticles/prettier-config': [email protected] prettier: 2.8.0 - prettier-plugin-svelte: 2.8.1_3ndnxlh52lolrqe4kgjgbxb3xa + prettier-plugin-svelte: 2.8.1_kaioqtfwjumrsfopsgfoca65re rollup: 3.6.0 - rollup-plugin-svelte: [email protected][email protected] + rollup-plugin-svelte: [email protected][email protected] rollup-plugin-terser: [email protected] - svelte: 3.53.1 - svelte-check: [email protected] - svelte-preprocess: 4.10.7_7dvewpees4iyn2tkw2qzal77a4 + svelte: 3.54.0 + svelte-check: [email protected] + svelte-preprocess: 4.10.7_gf4dcx76vtk2o62ixxeqx7chra tslib: 2.4.1 typescript: 4.9.3 @@ -1863,7 +1863,7 @@ importers: specifiers: '@types/jest': ^29.2.4 '@types/node': ^18.11.11 - solid-js: ^1.6.2 + solid-js: ^1.6.3 solid-particles: ^2.6.0 solid-scripts: ^0.0.61 tsparticles: ^2.6.0 @@ -1872,7 +1872,7 @@ importers: devDependencies: '@types/jest': 29.2.4 '@types/node': 18.11.11 - solid-js: 1.6.2 + solid-js: 1.6.3 solid-particles: link:../../components/solid solid-scripts: 0.0.61_t5doefn7w4ujvjnqe2l7o7g4cm tsparticles: link:../../bundles/full/dist @@ -1891,7 +1891,7 @@ importers: rollup-plugin-svelte: ^7.1.0 rollup-plugin-terser: ^7.0.2 sirv-cli: ^2.0.2 - svelte: ^3.53.1 + svelte: ^3.54.0 svelte-check: ^2.10.1 svelte-particles: ^2.6.0 svelte-preprocess: ^4.10.7 @@ -1910,11 +1910,11 @@ importers: rollup: 3.6.0 rollup-plugin-css-only: [email protected] rollup-plugin-livereload: 2.0.5 - rollup-plugin-svelte: [email protected][email protected] + rollup-plugin-svelte: [email protected][email protected] rollup-plugin-terser: [email protected] - svelte: 3.53.1 - svelte-check: [email protected] - svelte-preprocess: 4.10.7_7dvewpees4iyn2tkw2qzal77a4 + svelte: 3.54.0 + svelte-check: [email protected] + svelte-preprocess: 4.10.7_gf4dcx76vtk2o62ixxeqx7chra tslib: 2.4.1 typescript: 4.9.3 @@ -2313,7 +2313,7 @@ importers: editor: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2348,7 +2348,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: object-gui: 2.0.2 tsparticles-engine: link:../engine/dist @@ -2368,7 +2368,7 @@ importers: tsparticles-plugin-infection: link:../plugins/infection/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2387,13 +2387,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist engine: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2430,10 +2430,10 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2470,13 +2470,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/attract: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2496,12 +2496,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2520,13 +2520,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/bounce: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2546,12 +2546,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2570,13 +2570,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/bubble: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2596,12 +2596,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2620,13 +2620,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/connect: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2646,12 +2646,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2670,13 +2670,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/grab: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2696,12 +2696,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2720,13 +2720,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/pause: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2746,12 +2746,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2770,13 +2770,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/push: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2796,12 +2796,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2820,13 +2820,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/remove: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2846,12 +2846,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2870,13 +2870,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/repulse: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2896,12 +2896,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2920,13 +2920,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/slow: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2946,12 +2946,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -2970,13 +2970,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/external/trail: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -2996,12 +2996,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3020,13 +3020,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/light: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3046,12 +3046,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3070,13 +3070,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/particles/attract: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3096,12 +3096,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3120,13 +3120,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/particles/collisions: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3146,12 +3146,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3170,13 +3170,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/particles/links: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3196,12 +3196,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3220,13 +3220,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist interactions/particles/repulse: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3246,12 +3246,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3270,13 +3270,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist move/base: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3296,12 +3296,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3320,13 +3320,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist move/parallax: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3346,12 +3346,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3370,13 +3370,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist paths/curves: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3396,12 +3396,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3420,13 +3420,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist paths/perlinNoise: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3446,12 +3446,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3470,13 +3470,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist paths/polygon: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3496,12 +3496,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3520,13 +3520,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist paths/simplexNoise: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3546,12 +3546,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3570,13 +3570,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/absorbers: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3596,12 +3596,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3620,13 +3620,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/canvasMask: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3646,12 +3646,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3670,13 +3670,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/back: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3696,12 +3696,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3720,13 +3720,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/circ: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3746,12 +3746,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3770,13 +3770,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/cubic: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3796,12 +3796,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3820,13 +3820,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/expo: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3846,12 +3846,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3870,13 +3870,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/quad: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3896,12 +3896,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3920,13 +3920,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/quart: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3946,12 +3946,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -3970,13 +3970,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/quint: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -3996,12 +3996,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4020,13 +4020,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/easings/sine: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4046,12 +4046,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4070,13 +4070,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/emitters: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4096,12 +4096,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4120,13 +4120,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/hsvColor: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4146,12 +4146,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4170,13 +4170,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/infection: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4196,12 +4196,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4220,13 +4220,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/motion: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4246,12 +4246,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4270,13 +4270,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist plugins/polygonMask: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4296,12 +4296,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4320,13 +4320,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/bigCircles: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4353,7 +4353,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4365,7 +4365,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4384,13 +4384,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/bubbles: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4417,7 +4417,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4429,7 +4429,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4448,13 +4448,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/confetti: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4488,7 +4488,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4507,7 +4507,7 @@ importers: tsparticles-updater-wobble: link:../../updaters/wobble/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4526,13 +4526,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/fire: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4559,7 +4559,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-external-push: link:../../interactions/external/push/dist @@ -4571,7 +4571,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4590,13 +4590,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/firefly: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4623,7 +4623,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-external-trail: link:../../interactions/external/trail/dist @@ -4635,7 +4635,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4654,13 +4654,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/fireworks: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4692,7 +4692,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4709,7 +4709,7 @@ importers: tsparticles-updater-stroke-color: link:../../updaters/strokeColor/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4728,13 +4728,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/fountain: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4762,7 +4762,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4775,7 +4775,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4794,13 +4794,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/links: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4827,7 +4827,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-particles-links: link:../../interactions/particles/links/dist @@ -4839,7 +4839,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4858,13 +4858,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/seaAnemone: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4892,7 +4892,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4905,7 +4905,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4924,13 +4924,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/snow: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -4957,7 +4957,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -4969,7 +4969,7 @@ importers: tsparticles-updater-wobble: link:../../updaters/wobble/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -4988,13 +4988,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/stars: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5020,7 +5020,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-move-base: link:../../move/base/dist @@ -5031,7 +5031,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5050,13 +5050,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist presets/triangles: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5083,7 +5083,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist tsparticles-interaction-particles-links: link:../../interactions/particles/links/dist @@ -5095,7 +5095,7 @@ importers: tsparticles-updater-size: link:../../updaters/size/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5114,13 +5114,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/bubble: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5140,12 +5140,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5164,13 +5164,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/cards: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5190,12 +5190,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5214,13 +5214,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/circle: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5240,12 +5240,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5264,13 +5264,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/heart: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5290,12 +5290,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5314,13 +5314,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/image: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5340,12 +5340,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5364,13 +5364,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/line: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5390,12 +5390,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5414,13 +5414,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/multiline-text: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5440,12 +5440,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5464,13 +5464,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/polygon: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5490,12 +5490,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5514,13 +5514,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/rounded-rect: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5540,12 +5540,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5564,13 +5564,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/spiral: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5590,12 +5590,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5614,13 +5614,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/square: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5640,12 +5640,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5664,13 +5664,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/star: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5690,12 +5690,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5714,13 +5714,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist shapes/text: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5740,12 +5740,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5764,7 +5764,7 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist templates/react: @@ -5800,7 +5800,7 @@ importers: updaters/angle: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5820,12 +5820,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5844,13 +5844,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/color: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5870,12 +5870,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5894,13 +5894,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/destroy: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5920,12 +5920,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5944,13 +5944,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/gradient: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -5970,12 +5970,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -5994,13 +5994,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/life: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6020,12 +6020,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6044,13 +6044,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/opacity: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6070,12 +6070,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6094,13 +6094,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/orbit: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6120,12 +6120,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6144,13 +6144,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/outModes: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6170,12 +6170,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6194,13 +6194,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/roll: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6220,12 +6220,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6244,13 +6244,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/size: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6270,12 +6270,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6294,13 +6294,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/strokeColor: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6320,12 +6320,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6344,13 +6344,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/tilt: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6370,12 +6370,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6394,13 +6394,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/twinkle: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6420,12 +6420,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6444,13 +6444,13 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist updaters/wobble: specifiers: '@babel/core': ^7.20.5 - '@tsparticles/build': ^1.5.0 + '@tsparticles/build': ^1.5.1 '@tsparticles/eslint-config': ^1.4.0 '@tsparticles/prettier-config': ^1.4.0 '@tsparticles/tsconfig': ^1.5.0 @@ -6470,12 +6470,12 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: '@babel/core': 7.20.5 - '@tsparticles/build': [email protected] + '@tsparticles/build': [email protected] '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] '@tsparticles/tsconfig': [email protected] @@ -6494,7 +6494,7 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist utils/configs: @@ -6519,7 +6519,7 @@ importers: webpack: ^5.75.0 webpack-bundle-analyzer: ^4.7.0 webpack-cli: ^5.0.1 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: tsparticles-engine: link:../../engine/dist devDependencies: @@ -6542,7 +6542,7 @@ importers: webpack: [email protected] webpack-bundle-analyzer: 4.7.0 webpack-cli: 5.0.1_zfjer5eiwvoit4zaxwbfe5plkm - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 publishDirectory: dist utils/options-updater: @@ -6638,7 +6638,7 @@ importers: tsparticles-updater-wobble: ^2.6.0 typescript: ^4.9.3 webpack: ^5.75.0 - webpack-tsparticles-plugin: ^1.5.0 + webpack-tsparticles-plugin: ^1.5.1 dependencies: '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m '@tsparticles/prettier-config': [email protected] @@ -6723,7 +6723,7 @@ importers: tsparticles-updater-wobble: link:../../updaters/wobble/dist typescript: 4.9.3 webpack: [email protected] - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 devDependencies: '@types/eslint': 8.4.10 '@types/fs-extra': 9.0.13 @@ -7521,7 +7521,7 @@ packages: dependencies: '@ampproject/remapping': 2.2.0 '@babel/code-frame': 7.18.6 - '@babel/generator': 7.20.5 + '@babel/generator': 7.20.4 '@babel/helper-compilation-targets': 7.20.0_@[email protected] '@babel/helper-module-transforms': 7.20.2 '@babel/helpers': 7.20.6 @@ -10492,18 +10492,6 @@ packages: slash: 3.0.0 dev: true - /@jest/console/28.1.3: - resolution: {integrity: sha512-QPAkP5EwKdK/bxIr6C1I4Vs0rm2nHiANzj/Z5X2JQkrZo6IqvC4ldZ9K95tF0HdidhA8Bo6egxSzUFPYKcEXLw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - chalk: 4.1.2 - jest-message-util: 28.1.3 - jest-util: 28.1.3 - slash: 3.0.0 - dev: true - /@jest/core/26.6.3: resolution: {integrity: sha512-xvV1kKbhfUqFVuZ8Cyo+JPpipAHHAV3kcDBftiduK8EICXmTFddryy3P7NfZt8Pv37rA9nEJBKCCkglCPt/Xjw==} engines: {node: '>= 10.14.2'} @@ -10609,23 +10597,6 @@ packages: jest-mock: 27.5.1 dev: true - /@jest/environment/28.1.3: - resolution: {integrity: sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/fake-timers': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - jest-mock: 28.1.3 - dev: true - - /@jest/expect-utils/28.1.3: - resolution: {integrity: sha512-wvbi9LUrHJLn3NlDW6wF2hvIMtd4JUl2QNVrjq+IBSHirgfrR3o9RnVtxzdEGO2n9JyIWwHnLfby5KzqBGg2YA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - jest-get-type: 28.0.2 - dev: true - /@jest/expect-utils/29.3.1: resolution: {integrity: sha512-wlrznINZI5sMjwvUoLVk617ll/UYfGIZNxmbU+Pa7wmkL4vYzhV9R2pwVqUh4NWWuLQWkI8+8mOkxs//prKQ3g==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -10633,16 +10604,6 @@ packages: jest-get-type: 29.2.0 dev: true - /@jest/expect/28.1.3: - resolution: {integrity: sha512-lzc8CpUbSoE4dqT0U+g1qODQjBRHPpCPXissXD4mS9+sWQdmmpeJ9zSH1rS1HEkrsMN0fb7nKrJ9giAR1d3wBw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - expect: 28.1.3 - jest-snapshot: 28.1.3 - transitivePeerDependencies: - - supports-color - dev: true - /@jest/fake-timers/26.6.2: resolution: {integrity: sha512-14Uleatt7jdzefLPYM3KLcnUl1ZNikaKq34enpb5XG9i81JpppDb5muZvonvKyrl7ftEHkKS5L5/eB/kxJ+bvA==} engines: {node: '>= 10.14.2'} @@ -10667,18 +10628,6 @@ packages: jest-util: 27.5.1 dev: true - /@jest/fake-timers/28.1.3: - resolution: {integrity: sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@sinonjs/fake-timers': 9.1.2 - '@types/node': 18.11.11 - jest-message-util: 28.1.3 - jest-mock: 28.1.3 - jest-util: 28.1.3 - dev: true - /@jest/globals/26.6.2: resolution: {integrity: sha512-85Ltnm7HlB/KesBUuALwQ68YTU72w9H2xW9FjZ1eL1U3lhtefjjl5c2MiUbpXt/i6LaPRvoOFJ22yCBSfQ0JIA==} engines: {node: '>= 10.14.2'} @@ -10697,17 +10646,6 @@ packages: expect: 27.5.1 dev: true - /@jest/globals/28.1.3: - resolution: {integrity: sha512-XFU4P4phyryCXu1pbcqMO0GSQcYe1IsalYCDzRNyhetyeyxMcIxa11qPNDpVNLeretItNqEmYYQn1UYz/5x1NA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/environment': 28.1.3 - '@jest/expect': 28.1.3 - '@jest/types': 28.1.3 - transitivePeerDependencies: - - supports-color - dev: true - /@jest/reporters/26.6.2: resolution: {integrity: sha512-h2bW53APG4HvkOnVMo8q3QXa6pcaNt1HkwVsOPMBV6LD/q9oSpxNSYZQYkAnjdMjrJ86UuYeLo+aEZClV6opnw==} engines: {node: '>= 10.14.2'} @@ -10780,51 +10718,6 @@ packages: - supports-color dev: true - /@jest/reporters/28.1.1: - resolution: {integrity: sha512-597Zj4D4d88sZrzM4atEGLuO7SdA/YrOv9SRXHXRNC+/FwPCWxZhBAEzhXoiJzfRwn8zes/EjS8Lo6DouGN5Gg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - peerDependencies: - node-notifier: ^8.0.1 \|\| ^9.0.0 \|\| ^10.0.0 - peerDependenciesMeta: - node-notifier: - optional: true - dependencies: - '@bcoe/v8-coverage': 0.2.3 - '@jest/console': 28.1.3 - '@jest/test-result': 28.1.1 - '@jest/transform': 28.1.3 - '@jest/types': 28.1.3 - '@jridgewell/trace-mapping': 0.3.17 - '@types/node': 18.11.11 - chalk: 4.1.2 - collect-v8-coverage: 1.0.1 - exit: 0.1.2 - glob: 7.2.3 - graceful-fs: 4.2.10 - istanbul-lib-coverage: 3.2.0 - istanbul-lib-instrument: 5.2.1 - istanbul-lib-report: 3.0.0 - istanbul-lib-source-maps: 4.0.1 - istanbul-reports: 3.1.5 - jest-message-util: 28.1.3 - jest-util: 28.1.1 - jest-worker: 28.1.3 - slash: 3.0.0 - string-length: 4.0.2 - strip-ansi: 6.0.1 - terminal-link: 2.1.1 - v8-to-istanbul: 9.0.1 - transitivePeerDependencies: - - supports-color - dev: true - - /@jest/schemas/28.1.3: - resolution: {integrity: sha512-/l/VWsdt/aBXgjshLWOFyFt3IVdYypu5y2Wn2rOO1un6nkqIn8SLXzgIMYXFyYsRWDyF5EthmKJMIdJvk08grg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@sinclair/typebox': 0.24.51 - dev: true - /@jest/schemas/29.0.0: resolution: {integrity: sha512-3Ab5HgYIIAnS0HjqJHQYZS+zXc4tUmTmBH3z83ajI6afXp8X3ZtdLX+nXx+I7LNkJD7uN9LAVhgnjDgZa2z0kA==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -10850,15 +10743,6 @@ packages: source-map: 0.6.1 dev: true - /@jest/source-map/28.1.2: - resolution: {integrity: sha512-cV8Lx3BeStJb8ipPHnqVw/IM2VCMWO3crWZzYodSIkxXnRcXJipCdx1JCK0K5MsJJouZQTH73mzf4vgxRaH9ww==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jridgewell/trace-mapping': 0.3.17 - callsites: 3.1.0 - graceful-fs: 4.2.10 - dev: true - /@jest/test-result/26.6.2: resolution: {integrity: sha512-5O7H5c/7YlojphYNrK02LlDIV2GNPYisKwHm2QTKjNZeEzezCbwYs9swJySv2UfPMyZ0VdsmMv7jIlD/IKYQpQ==} engines: {node: '>= 10.14.2'} @@ -10879,26 +10763,6 @@ packages: collect-v8-coverage: 1.0.1 dev: true - /@jest/test-result/28.1.1: - resolution: {integrity: sha512-hPmkugBktqL6rRzwWAtp1JtYT4VHwv8OQ+9lE5Gymj6dHzubI/oJHMUpPOt8NrdVWSrz9S7bHjJUmv2ggFoUNQ==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/console': 28.1.3 - '@jest/types': 28.1.3 - '@types/istanbul-lib-coverage': 2.0.4 - collect-v8-coverage: 1.0.1 - dev: true - - /@jest/test-result/28.1.3: - resolution: {integrity: sha512-kZAkxnSE+FqE8YjW8gNuoVkkC9I7S1qmenl8sGcDOLropASP+BkcGKwhXoyqQuGOGeYY0y/ixjrd/iERpEXHNg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/console': 28.1.3 - '@jest/types': 28.1.3 - '@types/istanbul-lib-coverage': 2.0.4 - collect-v8-coverage: 1.0.1 - dev: true - /@jest/test-sequencer/26.6.3: resolution: {integrity: sha512-YHlVIjP5nfEyjlrSr8t/YdNfU/1XEt7c5b4OxcXCjyRhjzLYu/rO69/WHPuYcbCWkz8kAeZVZp2N2+IOLLEPGw==} engines: {node: '>= 10.14.2'} @@ -10928,16 +10792,6 @@ packages: - supports-color dev: true - /@jest/test-sequencer/28.1.3: - resolution: {integrity: sha512-NIMPEqqa59MWnDi1kvXXpYbqsfQmSJsIbnd85mdVGkiDfQ9WQQTXOLsvISUfonmnBT+w85WEgneCigEEdHDFxw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/test-result': 28.1.3 - graceful-fs: 4.2.10 - jest-haste-map: 28.1.3 - slash: 3.0.0 - dev: true - /@jest/transform/26.6.2: resolution: {integrity: sha512-E9JjhUgNzvuQ+vVAL21vlyfy12gP0GhazGgJC4h6qUt1jSdUXGWJ1wfu/X7Sd8etSgxV4ovT1pb9v5D6QW4XgA==} engines: {node: '>= 10.14.2'} @@ -10984,29 +10838,6 @@ packages: - supports-color dev: true - /@jest/transform/28.1.3: - resolution: {integrity: sha512-u5dT5di+oFI6hfcLOHGTAfmUxFRrjK+vnaP0kkVow9Md/M7V/MxqQMOz/VV25UZO8pzeA9PjfTpOu6BDuwSPQA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@babel/core': 7.20.5 - '@jest/types': 28.1.3 - '@jridgewell/trace-mapping': 0.3.17 - babel-plugin-istanbul: 6.1.1 - chalk: 4.1.2 - convert-source-map: 1.9.0 - fast-json-stable-stringify: 2.1.0 - graceful-fs: 4.2.10 - jest-haste-map: 28.1.3 - jest-regex-util: 28.0.2 - jest-util: 28.1.3 - micromatch: 4.0.5 - pirates: 4.0.5 - slash: 3.0.0 - write-file-atomic: 4.0.2 - transitivePeerDependencies: - - supports-color - dev: true - /@jest/types/26.6.2: resolution: {integrity: sha512-fC6QCp7Sc5sX6g8Tvbmj4XUTbyrik0akgRy03yjXbQaBWWNWGE7SGtJk98m0N8nzegD/7SggrUlivxo5ax4KWQ==} engines: {node: '>= 10.14.2'} @@ -11029,18 +10860,6 @@ packages: chalk: 4.1.2 dev: true - /@jest/types/28.1.3: - resolution: {integrity: sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/schemas': 28.1.3 - '@types/istanbul-lib-coverage': 2.0.4 - '@types/istanbul-reports': 3.0.1 - '@types/node': 18.11.11 - '@types/yargs': 17.0.16 - chalk: 4.1.2 - dev: true - /@jest/types/29.3.1: resolution: {integrity: sha512-d0S0jmmTpjnhCmNpApgX3jrUZgZ22ivKJRvL2lli5hpCRoNnp1f85r2/wpKfXuYu8E7Jjh1hGfhPyup1NM5AmA==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -11620,7 +11439,7 @@ packages: npmlog: 6.0.2 dev: true - /@lerna/publish/[email protected][email protected]: + /@lerna/publish/[email protected][email protected]: resolution: {integrity: sha512-XtvuydtU0IptbAapLRgoN1AZj/WJR+e3UKnx9BQ1Dwc+Fpg2oqPxR/vi+6hxAsr95pdQ5CnWBdgS+dg2wEUJ7Q==} engines: {node: ^14.15.0 \|\| >=16.0.0} dependencies: @@ -11642,7 +11461,7 @@ packages: '@lerna/run-lifecycle': 6.1.0 '@lerna/run-topologically': 6.1.0 '@lerna/validation-error': 6.1.0 - '@lerna/version': [email protected][email protected] + '@lerna/version': [email protected][email protected] fs-extra: 9.1.0 libnpmaccess: 6.0.4 npm-package-arg: 8.1.1 @@ -11774,7 +11593,7 @@ packages: npmlog: 6.0.2 dev: true - /@lerna/version/[email protected][email protected]: + /@lerna/version/[email protected][email protected]: resolution: {integrity: sha512-RUxVFdzHt0739lRNMrAbo6HWcFrcyG7atM1pn+Eo61fUoA5R/9N4bCk4m9xUGkJ/mOcROjuwAGe+wT1uOs58Bg==} engines: {node: ^14.15.0 \|\| >=16.0.0} dependencies: @@ -11792,7 +11611,7 @@ packages: '@lerna/run-topologically': 6.1.0 '@lerna/temp-write': 6.1.0 '@lerna/validation-error': 6.1.0 - '@nrwl/devkit': [email protected][email protected] + '@nrwl/devkit': [email protected][email protected] chalk: 4.1.2 dedent: 0.7.0 load-json-file: 6.2.0 @@ -11953,49 +11772,49 @@ packages: json5: 2.2.1 dev: true - /@motionone/animation/10.15.0: - resolution: {integrity: sha512-FllQ9ogoATxEEiq7TFKuh2uPEvcw9658IYCpOTGnu53HYCrFQS61eKwsn7TqR4NEnTql2I+NGNipFqw3UZo1AA==} + /@motionone/animation/10.15.1: + resolution: {integrity: sha512-mZcJxLjHor+bhcPuIFErMDNyrdb2vJur8lSfMCsuCB4UyV8ILZLvK+t+pg56erv8ud9xQGK/1OGPt10agPrCyQ==} dependencies: - '@motionone/easing': 10.15.0 - '@motionone/types': 10.15.0 - '@motionone/utils': 10.15.0 + '@motionone/easing': 10.15.1 + '@motionone/types': 10.15.1 + '@motionone/utils': 10.15.1 tslib: 2.4.1 dev: true /@motionone/dom/10.12.0: resolution: {integrity: sha512-UdPTtLMAktHiqV0atOczNYyDd/d8Cf5fFsd1tua03PqTwwCe/6lwhLSQ8a7TbnQ5SN0gm44N1slBfj+ORIhrqw==} dependencies: - '@motionone/animation': 10.15.0 - '@motionone/generators': 10.15.0 - '@motionone/types': 10.15.0 - '@motionone/utils': 10.15.0 + '@motionone/animation': 10.15.1 + '@motionone/generators': 10.15.1 + '@motionone/types': 10.15.1 + '@motionone/utils': 10.15.1 hey-listen: 1.0.8 tslib: 2.4.1 dev: true - /@motionone/easing/10.15.0: - resolution: {integrity: sha512-VA1a0sa81euSeki2JgVl/t4MygeqfJn7GsMfewoGCln7gp/iZR12HbSo6RaWsHxPkUBRxSRUo+8zeuYRxv6oZQ==} + /@motionone/easing/10.15.1: + resolution: {integrity: sha512-6hIHBSV+ZVehf9dcKZLT7p5PEKHGhDwky2k8RKkmOvUoYP3S+dXsKupyZpqx5apjd9f+php4vXk4LuS+ADsrWw==} dependencies: - '@motionone/utils': 10.15.0 + '@motionone/utils': 10.15.1 tslib: 2.4.1 dev: true - /@motionone/generators/10.15.0: - resolution: {integrity: sha512-bE4lEd/RIQ+DwlLC2IfF/FBOSPwjxV5AbwQuatMg/bWtndps66YMvX1NbvD0wzg+EIpPwi8i8YnYy7usdb8apg==} + /@motionone/generators/10.15.1: + resolution: {integrity: sha512-67HLsvHJbw6cIbLA/o+gsm7h+6D4Sn7AUrB/GPxvujse1cGZ38F5H7DzoH7PhX+sjvtDnt2IhFYF2Zp1QTMKWQ==} dependencies: - '@motionone/types': 10.15.0 - '@motionone/utils': 10.15.0 + '@motionone/types': 10.15.1 + '@motionone/utils': 10.15.1 tslib: 2.4.1 dev: true - /@motionone/types/10.15.0: - resolution: {integrity: sha512-uNjSt2/Ud1Ld5TuZ98empFFgHNPysIcUQE3F/YuWxDQR/UO86sCqvnAHBkxUhpc2FVE6hb+3RpFmFxAUDwn11w==} + /@motionone/types/10.15.1: + resolution: {integrity: sha512-iIUd/EgUsRZGrvW0jqdst8st7zKTzS9EsKkP+6c6n4MPZoQHwiHuVtTQLD6Kp0bsBLhNzKIBlHXponn/SDT4hA==} dev: true - /@motionone/utils/10.15.0: - resolution: {integrity: sha512-M1PCJ533xpjuEmhTVZYw+KPU6/lDZP9d2NpJDcMMUH/TYPnL3w9CYCTn+b4KKdSUJB2KO7t3xfspJsLqj35SRQ==} + /@motionone/utils/10.15.1: + resolution: {integrity: sha512-p0YncgU+iklvYr/Dq4NobTRdAPv9PveRDUXabPEeOjBLSO/1FNB2phNTZxOxpi1/GZwYpAoECEa0Wam+nsmhSw==} dependencies: - '@motionone/types': 10.15.0 + '@motionone/types': 10.15.1 hey-listen: 1.0.8 tslib: 2.4.1 dev: true @@ -12454,77 +12273,45 @@ packages: - supports-color dev: true - /@nrwl/cli/15.2.4: - resolution: {integrity: sha512-Urhkzj/hzhTlJqOHFZyibYGjvzHvSQhkjN3keHiYCNEOaAGp9DPF+oC5cYrPcqWbu3ZkldDWTk7aVBbeqwDWZQ==} + /@nrwl/cli/15.3.0: + resolution: {integrity: sha512-WAki2+puBp6qel/VAxdQmr/L/sLyw8K6bynYNmMl4eIlR5hjefrUChPzUiJDAS9/CUYQNOyva2VV5wofzdv95w==} dependencies: - nx: 15.2.4 + nx: 15.3.0 transitivePeerDependencies: - '@swc-node/register' - '@swc/core' - debug dev: true - /@nrwl/devkit/[email protected][email protected]: - resolution: {integrity: sha512-5JZWB4ydnu+NKNIfj958nML8AWwhareQ+Q1hLXoOIS/7brqfALNP3y/Ef1ljrLIo1f3xc484TPclqwSH7aRdvQ==} + /@nrwl/devkit/[email protected][email protected]: + resolution: {integrity: sha512-1O9QLB/eYS6ddw4MZnV4yj4CEqLIbpleZZiG/9w1TaiVO/jfNfXVaxc8EA87XSzMpk2W+/4Qggmabt6gAQaabA==} peerDependencies: nx: '>= 14 <= 16' dependencies: '@phenomnomnominal/tsquery': [email protected] ejs: 3.1.8 ignore: 5.2.1 - nx: 15.2.4 + nx: 15.3.0 semver: 7.3.4 tslib: 2.4.1 transitivePeerDependencies: - typescript dev: true - /@nrwl/jest/15.2.4_mvurwutqjky6gqsjiakl6juv24: - resolution: {integrity: sha512-b2GoUPPs4/EAGhJvUn41sphD0Ln9P3ybX2Cyb1U5upM9glOGU5qdGYO20ZMl7IJhEL17QRcojUudWTnk1RejHA==} - dependencies: - '@jest/reporters': 28.1.1 - '@jest/test-result': 28.1.1 - '@nrwl/devkit': [email protected][email protected] - '@phenomnomnominal/tsquery': [email protected] - chalk: 4.1.0 - dotenv: 10.0.0 - identity-obj-proxy: 3.0.0 - jest-config: 28.1.1_k7quxe733nexnlgzi4yxvxoplq - jest-resolve: 28.1.1 - jest-util: 28.1.1 - resolve.exports: 1.1.0 - tslib: 2.4.1 - transitivePeerDependencies: - - '@types/node' - - node-notifier - - nx - - supports-color - - ts-node - - typescript - dev: true - - /@nrwl/linter/15.2.4_7o3zmy2l7r5fhtajqqtxmepoga: - resolution: {integrity: sha512-EINxMgb7uEYW2rhj8MomHLktUsVAVlGBSTEZSg7SC32vgzY+QJ144qubLNlCHzSV1O5J/LMugoAHt3E+0eNHyA==} + /@nrwl/linter/[email protected][email protected]: + resolution: {integrity: sha512-pxmL9taYRjKsQC3/XAD9JJCoIRGiuAs+xW4798kD/SFCRQEs5CddA3J4M1y9YoyPjiocNDfUE2AvVMOuM2qbDw==} peerDependencies: eslint: ^8.0.0 peerDependenciesMeta: eslint: optional: true dependencies: - '@nrwl/devkit': [email protected][email protected] - '@nrwl/jest': 15.2.4_mvurwutqjky6gqsjiakl6juv24 + '@nrwl/devkit': [email protected][email protected] '@phenomnomnominal/tsquery': [email protected] - nx: 15.2.4 tmp: 0.2.1 tslib: 2.4.1 transitivePeerDependencies: - - '@swc-node/register' - - '@swc/core' - - '@types/node' - - debug - - node-notifier - - supports-color - - ts-node + - nx - typescript dev: true @@ -12544,28 +12331,27 @@ packages: - debug dev: true - /@nrwl/tao/15.2.4: - resolution: {integrity: sha512-ebGJCkg84yfptuNhGMnIrgHvnknJkeyxWLqRQ7AlMXTzxXOfMS+whjVImM9XjfVYVpBVFWc5QBU5gaKQtzLHmA==} + /@nrwl/tao/15.3.0: + resolution: {integrity: sha512-alyzKKSgfgPwQ/FUozvk43VGOZHyNMiSM6Udl49ZaQwT77GXRFkrOu21odW6dciWPd3iUOUjfJISNqrEJmxvpw==} hasBin: true dependencies: - nx: 15.2.4 + nx: 15.3.0 transitivePeerDependencies: - '@swc-node/register' - '@swc/core' - debug dev: true - /@nrwl/workspace/15.2.4_uf7ur4xvpkq7xbobfxd2xaxn5y: - resolution: {integrity: sha512-h35+NwG2zCeJpQzLevw8q9frrKCwsQyOfUxzyP7nApoxQNO70iGdTwRli/dvB7jVIckp3x78yLuu32D9oqiKEA==} + /@nrwl/workspace/15.3.0_brpckf4sz23pco3jyty2eys3iq: + resolution: {integrity: sha512-MjDRzDZLke3A44FeMjaV9Zyc3XcgbZJlrvFe0nDj7lo3/aLP/SvltE30kfkTwlg7EwvyCSv61lt9zz2NMxpHQw==} peerDependencies: prettier: ^2.6.2 peerDependenciesMeta: prettier: optional: true dependencies: - '@nrwl/devkit': [email protected][email protected] - '@nrwl/jest': 15.2.4_mvurwutqjky6gqsjiakl6juv24 - '@nrwl/linter': 15.2.4_7o3zmy2l7r5fhtajqqtxmepoga + '@nrwl/devkit': [email protected][email protected] + '@nrwl/linter': [email protected][email protected] '@parcel/watcher': 2.0.4 chalk: 4.1.0 chokidar: 3.5.3 @@ -12580,7 +12366,7 @@ packages: ignore: 5.2.1 minimatch: 3.0.5 npm-run-path: 4.0.1 - nx: 15.2.4 + nx: 15.3.0 open: 8.4.0 prettier: 2.8.0 rxjs: 6.6.7 @@ -12592,12 +12378,8 @@ packages: transitivePeerDependencies: - '@swc-node/register' - '@swc/core' - - '@types/node' - debug - eslint - - node-notifier - - supports-color - - ts-node - typescript dev: true @@ -13984,12 +13766,6 @@ packages: '@sinonjs/commons': 1.8.6 dev: true - /@sinonjs/fake-timers/9.1.2: - resolution: {integrity: sha512-BPS4ynJW/o92PUR4wgriz2Ud5gpST5vz6GQfMixEDK0Z8ZCUv2M7SkBLykH56T++Xs+8ln9zTGbOvNGIe02/jw==} - dependencies: - '@sinonjs/commons': 1.8.6 - dev: true - /@socket.io/component-emitter/3.1.0: resolution: {integrity: sha512-+9jVqKhRSpsc591z5vX+X5Yyw+he/HCB4iQ/RYxw35CEPaY1gnsNE43nf9n9AaYjAQrTiI/mOwKUKdUs9vf7Xg==} dev: true @@ -14266,8 +14042,8 @@ packages: resolution: {integrity: sha512-pYrtLtOwku/7r1i9AMONsJMVYAtk3hzOfiGNekhtq5tYBGA7unMve8RvUclKLMT3PrihvJqUmzsRGh0RP84hKg==} dev: true - /@tsparticles/build/[email protected]: - resolution: {integrity: sha512-1TE0Wtd8x6CjksCzIRRHwkDc8+ekczpu3+nBHTgH7AKbISw1pHayOvlPTdB+T5/9WVp+SoQvdLA7vuuqMLbCgg==} + /@tsparticles/build/[email protected]: + resolution: {integrity: sha512-WuFWD3lEHa5ml8UhQxlSMvCvL7+iSmVcJluOlVAlrBrrBGWshQJ4X/+bfcJ/MS33KC2Cl8QRi1Kbtj1X1Wzgmg==} hasBin: true dependencies: '@tsparticles/eslint-config': 1.4.0_k4no56dex7zbuk5vxtxtgxs27m @@ -14283,7 +14059,7 @@ packages: rimraf: 3.0.2 typescript: 4.9.3 webpack: [email protected] - webpack-tsparticles-plugin: 1.5.0 + webpack-tsparticles-plugin: 1.5.1 transitivePeerDependencies: - '@swc/core' - '@webpack-cli/generators' @@ -14388,7 +14164,7 @@ packages: dependencies: '@types/http-cache-semantics': 4.0.1 '@types/keyv': 3.1.4 - '@types/node': 18.11.11 + '@types/node': 16.18.6 '@types/responselike': 1.0.0 dev: true @@ -14421,7 +14197,7 @@ packages: resolution: {integrity: sha512-9K4zoImiZc3HlIp6AVUDE4CWYx22a+lhSZMYNpbjW04+YF0KWj4pJXnEMjdnFTiQibFFmElcsasJXDbdI/EPhA==} dependencies: '@types/eslint': 8.4.10 - '@types/estree': 1.0.0 + '@types/estree': 0.0.51 /@types/eslint/8.4.10: resolution: {integrity: sha512-Sl/HOqN8NKPmhWo2VBEPm0nvHnu2LL3v9vKo8MEq0EtbJ4eVzGPl41VNPvn5E1i5poMk4/XD8UriLHpJvEP/Nw==} @@ -14562,7 +14338,7 @@ packages: /@types/keyv/3.1.4: resolution: {integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==} dependencies: - '@types/node': 18.11.11 + '@types/node': 16.18.6 dev: true /@types/klaw/3.0.3: @@ -14700,7 +14476,7 @@ packages: /@types/responselike/1.0.0: resolution: {integrity: sha512-85Y2BjiufFzaMIlvJDvTTB8Fxl2xfLo4HgmHzVBz08w4wDePCTjYw66PdrolO0kzli3yam/YCgRufyo1DdQVTA==} dependencies: - '@types/node': 18.11.11 + '@types/node': 16.18.6 dev: true /@types/retry/0.12.0: @@ -14849,7 +14625,7 @@ packages: resolution: {integrity: sha512-Cn6WYCm0tXv8p6k+A8PvbDG763EDpBoTzHdA+Q/MF6H3sapGjCm9NzoaJncJS9tUKSuCoDs9XHxYYsQDgxR6kw==} requiresBuild: true dependencies: - '@types/node': 18.11.11 + '@types/node': 16.18.6 dev: true optional: true @@ -18274,24 +18050,6 @@ packages: - supports-color dev: true - /babel-jest/28.1.3_@[email protected]: - resolution: {integrity: sha512-epUaPOEWMk3cWX0M/sPvCHHCe9fMFAa/9hXEgKP8nFfNl/jlGkE9ucq9NqkZGXLDduCJYS0UvSlPUwC0S+rH6Q==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - peerDependencies: - '@babel/core': ^7.8.0 - dependencies: - '@babel/core': 7.20.5 - '@jest/transform': 28.1.3 - '@types/babel__core': 7.1.20 - babel-plugin-istanbul: 6.1.1 - babel-preset-jest: 28.1.3_@[email protected] - chalk: 4.1.2 - graceful-fs: 4.2.10 - slash: 3.0.0 - transitivePeerDependencies: - - supports-color - dev: true - /babel-loader/8.3.0_em3sh5kto35xuanci4cvhzqfay: resolution: {integrity: sha512-H8SvsMF+m9t15HNLMipppzkC+Y2Yq+v3SonZyU70RBL/h1gxPkH08Ot8pEE9Z4Kd+czyWJClmFS8qzIP9OZ04Q==} engines: {node: '>= 8.9'} @@ -18408,16 +18166,6 @@ packages: '@types/babel__traverse': 7.18.3 dev: true - /babel-plugin-jest-hoist/28.1.3: - resolution: {integrity: sha512-Ys3tUKAmfnkRUpPdpa98eYrAR0nV+sSFUZZEGuQ2EbFd1y4SOLtD5QDNHAq+bb9a+bbXvYQC4b+ID/THIMcU6Q==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@babel/template': 7.18.10 - '@babel/types': 7.20.5 - '@types/babel__core': 7.1.20 - '@types/babel__traverse': 7.18.3 - dev: true - /babel-plugin-jsx-dom-expressions/0.35.6_@[email protected]: resolution: {integrity: sha512-z8VBym+Scol38MiR97iqQGsANjhsDqscRRemk+po+z3TWKV/fb9kux/gdKOJJSC/ARyUL3HExBFVtr+Efd24uw==} peerDependencies: @@ -18835,19 +18583,8 @@ packages: babel-preset-current-node-syntax: 1.0.1_@[email protected] dev: true - /babel-preset-jest/28.1.3_@[email protected]: - resolution: {integrity: sha512-L+fupJvlWAHbQfn74coNX3zf60LXMJsezNvvx8eIh7iOR1luJ1poxYgQk1F8PYtNq/6QODDHCqsSnTFSWC491A==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - peerDependencies: - '@babel/core': ^7.0.0 - dependencies: - '@babel/core': 7.20.5 - babel-plugin-jest-hoist: 28.1.3 - babel-preset-current-node-syntax: 1.0.1_@[email protected] - dev: true - - /babel-preset-solid/1.6.2_@[email protected]: - resolution: {integrity: sha512-5sFI34g7Jtp4r04YFWkuC1o+gnekBdPXQTJb5/6lmxi5YwzazVgKAXRwEAToC3zRaPyIYJbZUVLpOi5mDzPEuw==} + /babel-preset-solid/1.6.3_@[email protected]: + resolution: {integrity: sha512-AQ6aaKQlDAZc3aAS+nFfXbNBf+NeJwKlRA55clj9PQI+Mkqv8JvTOnAEIGfYa0OW0sntMWhNWx+ih/4PK2s3/w==} peerDependencies: '@babel/core': ^7.0.0 dependencies: @@ -19408,7 +19145,7 @@ packages: mississippi: 3.0.0 mkdirp: 0.5.6 move-concurrently: 1.0.1 - promise-inflight: 1.0.1 + promise-inflight: [email protected] rimraf: 2.7.1 ssri: 6.0.2 unique-filename: 1.1.1 @@ -22295,11 +22032,6 @@ packages: engines: {node: ^10.13.0 \|\| ^12.13.0 \|\| ^14.15.0 \|\| >=15.0.0} dev: true - /diff-sequences/28.1.1: - resolution: {integrity: sha512-FU0iFaH/E23a+a718l8Qa/19bF9p06kgE0KipMOMadwa3SjnaElKzPaUC0vnibs6/B/9ni97s61mcejk8W1fQw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dev: true - /diff-sequences/29.3.1: resolution: {integrity: sha512-hlM3QR272NXCi4pq+N4Kok4kOp6EsgOM3ZSpJI7Da3UAs+Ttsi8MRmB6trM/lhyzUxGfOgnpkHtgqm5Q/CTcfQ==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -22643,11 +22375,6 @@ packages: /email-addresses/3.1.0: resolution: {integrity: sha512-k0/r7GrWVL32kZlGwfPNgB2Y/mMXVTq/decgLczm/j34whdaspNrZO8CnXPf1laaHxI6ptUlsnAxN+UAPw+fzg==} - /emittery/0.10.2: - resolution: {integrity: sha512-aITqOwnLanpHLNXZJENbOgjUBeHocD+xsSJmNrjovKBW5HbSpW3d1pEls7GFQPUWXiwG9+0P4GtHfEqC/4M0Iw==} - engines: {node: '>=12'} - dev: true - /emittery/0.7.2: resolution: {integrity: sha512-A8OG5SR/ij3SsJdWDJdkkSYUjQdCUx6APQXem0SaEePBSRg4eymGYwBkKo1Y6DU+af/Jn2dBQqDBvjnr9Vi8nQ==} engines: {node: '>=10'} @@ -24176,17 +23903,6 @@ packages: jest-message-util: 27.5.1 dev: true - /expect/28.1.3: - resolution: {integrity: sha512-eEh0xn8HlsuOBxFgIss+2mX85VAS4Qy3OSkjV7rlBWljtA4oWH37glVGyOZSZvErDT/yBywZdPGwCXuTvSG85g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/expect-utils': 28.1.3 - jest-get-type: 28.0.2 - jest-matcher-utils: 28.1.3 - jest-message-util: 28.1.3 - jest-util: 28.1.3 - dev: true - /expect/29.3.1: resolution: {integrity: sha512-gGb1yTgU30Q0O/tQq+z30KBWv24ApkMgFUpvKBkyLUBL68Wv8dHdJxTBZFl/iT8K/bqDHvUYRH6IIN3rToopPA==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -25481,7 +25197,7 @@ packages: fs.realpath: 1.0.0 inflight: 1.0.6 inherits: 2.0.4 - minimatch: 3.1.2 + minimatch: 3.0.5 once: 1.4.0 path-is-absolute: 1.0.1 dev: true @@ -27630,9 +27346,9 @@ packages: hasBin: true dependencies: async: 3.2.4 - chalk: 4.1.2 + chalk: 4.1.0 filelist: 1.0.4 - minimatch: 3.1.2 + minimatch: 3.0.5 dev: true /jasmine-core/2.8.0: @@ -27716,33 +27432,6 @@ packages: - supports-color dev: true - /jest-circus/28.1.3: - resolution: {integrity: sha512-cZ+eS5zc79MBwt+IhQhiEp0OeBddpc1n8MBo1nMB8A7oPMKEO+Sre+wHaLJexQUj9Ya/8NOBY0RESUgYjB6fow==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/environment': 28.1.3 - '@jest/expect': 28.1.3 - '@jest/test-result': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - chalk: 4.1.2 - co: 4.6.0 - dedent: 0.7.0 - is-generator-fn: 2.1.0 - jest-each: 28.1.3 - jest-matcher-utils: 28.1.3 - jest-message-util: 28.1.3 - jest-runtime: 28.1.3 - jest-snapshot: 28.1.3 - jest-util: 28.1.3 - p-limit: 3.1.0 - pretty-format: 28.1.3 - slash: 3.0.0 - stack-utils: 2.0.6 - transitivePeerDependencies: - - supports-color - dev: true - /jest-cli/26.6.3: resolution: {integrity: sha512-GF9noBSa9t08pSyl3CY4frMrqp+aQXFGFkf5hEPbh/pIUFYWMK6ZLTfbmadxJVcJrdRoChlWQsA2VkJcDFK8hg==} engines: {node: '>= 10.14.2'} @@ -27873,46 +27562,6 @@ packages: - utf-8-validate dev: true - /jest-config/28.1.1_k7quxe733nexnlgzi4yxvxoplq: - resolution: {integrity: sha512-tASynMhS+jVV85zKvjfbJ8nUyJS/jUSYZ5KQxLUN2ZCvcQc/OmhQl2j6VEL3ezQkNofxn5pQ3SPYWPHb0unTZA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - peerDependencies: - '@types/node': '' - ts-node: '>=9.0.0' - peerDependenciesMeta: - '@types/node': - optional: true - ts-node: - optional: true - dependencies: - '@babel/core': 7.20.5 - '@jest/test-sequencer': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - babel-jest: 28.1.3_@[email protected] - chalk: 4.1.2 - ci-info: 3.7.0 - deepmerge: 4.2.2 - glob: 7.2.3 - graceful-fs: 4.2.10 - jest-circus: 28.1.3 - jest-environment-node: 28.1.3 - jest-get-type: 28.0.2 - jest-regex-util: 28.0.2 - jest-resolve: 28.1.1 - jest-runner: 28.1.3 - jest-util: 28.1.1 - jest-validate: 28.1.3 - micromatch: 4.0.5 - parse-json: 5.2.0 - pretty-format: 28.1.3 - slash: 3.0.0 - strip-json-comments: 3.1.1 - ts-node: 10.9.1_zhirybrk4zoofuxp64necizyzy - transitivePeerDependencies: - - supports-color - dev: true - /jest-dev-server/6.1.1: resolution: {integrity: sha512-z5LnaGDvlIkdMv/rppSO4+rq+GyQKf1xI9oiBxf9/2EBeN2hxRaWiMvaLNDnHPZj2PAhBXsycrKslDDoZO2Xtw==} dependencies: @@ -27948,16 +27597,6 @@ packages: pretty-format: 27.5.1 dev: true - /jest-diff/28.1.3: - resolution: {integrity: sha512-8RqP1B/OXzjjTWkqMX67iqgwBVJRgCyKD3L9nq+6ZqJMdvjE8RgHktqZ6jNrkdMT+dJuYNI3rhQpxaz7drJHfw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - chalk: 4.1.2 - diff-sequences: 28.1.1 - jest-get-type: 28.0.2 - pretty-format: 28.1.3 - dev: true - /jest-diff/29.3.1: resolution: {integrity: sha512-vU8vyiO7568tmin2lA3r2DP8oRvzhvRcD4DjpXc6uGveQodyk7CKLhQlCSiwgx3g0pFaE88/KLZ0yaTWMc4Uiw==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -27982,13 +27621,6 @@ packages: detect-newline: 3.1.0 dev: true - /jest-docblock/28.1.1: - resolution: {integrity: sha512-3wayBVNiOYx0cwAbl9rwm5kKFP8yHH3d/fkEaL02NPTkDojPtheGB7HZSFY4wzX+DxyrvhXz0KSCVksmCknCuA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - detect-newline: 3.1.0 - dev: true - /jest-each/26.6.2: resolution: {integrity: sha512-Mer/f0KaATbjl8MCJ+0GEpNdqmnVmDYqCTJYTvoo7rqmRiDllmp2AYN+06F93nXcY3ur9ShIjS+CO/uD+BbH4A==} engines: {node: '>= 10.14.2'} @@ -28011,17 +27643,6 @@ packages: pretty-format: 27.5.1 dev: true - /jest-each/28.1.3: - resolution: {integrity: sha512-arT1z4sg2yABU5uogObVPvSlSMQlDA48owx07BDPAiasW0yYpYHYOo4HHLz9q0BVzDVU4hILFjzJw0So9aCL/g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - chalk: 4.1.2 - jest-get-type: 28.0.2 - jest-util: 28.1.3 - pretty-format: 28.1.3 - dev: true - /jest-environment-jsdom/26.6.2: resolution: {integrity: sha512-jgPqCruTlt3Kwqg5/WVFyHIOJHsiAvhcp2qiR2QQstuG9yWox5+iHpU3ZrcBxW14T4fe5Z68jAfLRh7joCSP2Q==} engines: {node: '>= 10.14.2'} @@ -28082,18 +27703,6 @@ packages: jest-util: 27.5.1 dev: true - /jest-environment-node/28.1.3: - resolution: {integrity: sha512-ugP6XOhEpjAEhGYvp5Xj989ns5cB1K6ZdjBYuS30umT4CQEETaxSiPcZ/E1kFktX4GkrcM4qu07IIlDYX1gp+A==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/environment': 28.1.3 - '@jest/fake-timers': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - jest-mock: 28.1.3 - jest-util: 28.1.3 - dev: true - /jest-get-type/26.3.0: resolution: {integrity: sha512-TpfaviN1R2pQWkIihlfEanwOXK0zcxrKEE4MlU6Tn7keoXdN6/3gK/xl0yEh8DOunn5pOVGKf8hB4R9gVh04ig==} engines: {node: '>= 10.14.2'} @@ -28104,11 +27713,6 @@ packages: engines: {node: ^10.13.0 \|\| ^12.13.0 \|\| ^14.15.0 \|\| >=15.0.0} dev: true - /jest-get-type/28.0.2: - resolution: {integrity: sha512-ioj2w9/DxSYHfOm5lJKCdcAmPJzQXmbM/Url3rhlghrPvT3tt+7a/+oXc9azkKmLvoiXjtV83bEWqi+vs5nlPA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dev: true - /jest-get-type/29.2.0: resolution: {integrity: sha512-uXNJlg8hKFEnDgFsrCjznB+sTxdkuqiCL6zMgA75qEbAJjJYTs9XPrvDctrEig2GDow22T/LvHgO57iJhXB/UA==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -28157,25 +27761,6 @@ packages: fsevents: 2.3.2 dev: true - /jest-haste-map/28.1.3: - resolution: {integrity: sha512-3S+RQWDXccXDKSWnkHa/dPwt+2qwA8CJzR61w3FoYCvoo3Pn8tvGcysmMF0Bj0EX5RYvAI2EIvC57OmotfdtKA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@types/graceful-fs': 4.1.5 - '@types/node': 18.11.11 - anymatch: 3.1.3 - fb-watchman: 2.0.2 - graceful-fs: 4.2.10 - jest-regex-util: 28.0.2 - jest-util: 28.1.3 - jest-worker: 28.1.3 - micromatch: 4.0.5 - walker: 1.0.8 - optionalDependencies: - fsevents: 2.3.2 - dev: true - /jest-jasmine2/26.6.3: resolution: {integrity: sha512-kPKUrQtc8aYwBV7CqBg5pu+tmYXlvFlSFYn18ev4gPFtrRzB15N2gW/Roew3187q2w2eHuu0MU9TJz6w0/nPEg==} engines: {node: '>= 10.14.2'} @@ -28247,14 +27832,6 @@ packages: pretty-format: 27.5.1 dev: true - /jest-leak-detector/28.1.3: - resolution: {integrity: sha512-WFVJhnQsiKtDEo5lG2mM0v40QWnBM+zMdHHyJs8AWZ7J0QZJS59MsyKeJHWhpBZBH32S48FOVvGyOFT1h0DlqA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - jest-get-type: 28.0.2 - pretty-format: 28.1.3 - dev: true - /jest-matcher-utils/26.6.2: resolution: {integrity: sha512-llnc8vQgYcNqDrqRDXWwMr9i7rS5XFiCwvh6DTP7Jqa2mqpcCBBlpCbn+trkG0KNhPu/h8rzyBkriOtBstvWhw==} engines: {node: '>= 10.14.2'} @@ -28275,16 +27852,6 @@ packages: pretty-format: 27.5.1 dev: true - /jest-matcher-utils/28.1.3: - resolution: {integrity: sha512-kQeJ7qHemKfbzKoGjHHrRKH6atgxMk8Enkk2iPQ3XwO6oE/KYD8lMYOziCkeSB9G4adPM4nR1DE8Tf5JeWH6Bw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - chalk: 4.1.2 - jest-diff: 28.1.3 - jest-get-type: 28.0.2 - pretty-format: 28.1.3 - dev: true - /jest-matcher-utils/29.3.1: resolution: {integrity: sha512-fkRMZUAScup3txIKfMe3AIZZmPEjWEdsPJFK3AIy5qRohWqQFg1qrmKfYXR9qEkNc7OdAu2N4KPHibEmy4HPeQ==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -28325,21 +27892,6 @@ packages: stack-utils: 2.0.6 dev: true - /jest-message-util/28.1.3: - resolution: {integrity: sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@babel/code-frame': 7.18.6 - '@jest/types': 28.1.3 - '@types/stack-utils': 2.0.1 - chalk: 4.1.2 - graceful-fs: 4.2.10 - micromatch: 4.0.5 - pretty-format: 28.1.3 - slash: 3.0.0 - stack-utils: 2.0.6 - dev: true - /jest-message-util/29.3.1: resolution: {integrity: sha512-lMJTbgNcDm5z+6KDxWtqOFWlGQxD6XaYwBqHR8kmpkP+WWWG90I35kdtQHY67Ay5CSuydkTBbJG+tH9JShFCyA==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -28371,14 +27923,6 @@ packages: '@types/node': 18.11.11 dev: true - /jest-mock/28.1.3: - resolution: {integrity: sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - dev: true - /jest-pnp-resolver/[email protected]: resolution: {integrity: sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==} engines: {node: '>=6'} @@ -28403,30 +27947,6 @@ packages: jest-resolve: 27.5.1 dev: true - /jest-pnp-resolver/[email protected]: - resolution: {integrity: sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==} - engines: {node: '>=6'} - peerDependencies: - jest-resolve: '' - peerDependenciesMeta: - jest-resolve: - optional: true - dependencies: - jest-resolve: 28.1.1 - dev: true - - /jest-pnp-resolver/[email protected]: - resolution: {integrity: sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==} - engines: {node: '>=6'} - peerDependencies: - jest-resolve: '' - peerDependenciesMeta: - jest-resolve: - optional: true - dependencies: - jest-resolve: 28.1.3 - dev: true - /jest-regex-util/26.0.0: resolution: {integrity: sha512-Gv3ZIs/nA48/Zvjrl34bf+oD76JHiGDUxNOVgUjh3j890sblXryjY4rss71fPtD/njchl6PSE2hIhvyWa1eT0A==} engines: {node: '>= 10.14.2'} @@ -28437,11 +27957,6 @@ packages: engines: {node: ^10.13.0 \|\| ^12.13.0 \|\| ^14.15.0 \|\| >=15.0.0} dev: true - /jest-regex-util/28.0.2: - resolution: {integrity: sha512-4s0IgyNIy0y9FK+cjoVYoxamT7Zeo7MhzqRGx7YDYmaQn1wucY9rotiGkBzzcMXTtjrCAP/f7f+E0F7+fxPNdw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dev: true - /jest-resolve-dependencies/26.6.3: resolution: {integrity: sha512-pVwUjJkxbhe4RY8QEWzN3vns2kqyuldKpxlxJlzEYfKSvY6/bMvxoFrYYzUO1Gx28yKWN37qyV7rIoIp2h8fTg==} engines: {node: '>= 10.14.2'} @@ -28494,36 +28009,6 @@ packages: slash: 3.0.0 dev: true - /jest-resolve/28.1.1: - resolution: {integrity: sha512-/d1UbyUkf9nvsgdBildLe6LAD4DalgkgZcKd0nZ8XUGPyA/7fsnaQIlKVnDiuUXv/IeZhPEDrRJubVSulxrShA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - chalk: 4.1.2 - graceful-fs: 4.2.10 - jest-haste-map: 28.1.3 - jest-pnp-resolver: [email protected] - jest-util: 28.1.1 - jest-validate: 28.1.3 - resolve: 1.22.1 - resolve.exports: 1.1.0 - slash: 3.0.0 - dev: true - - /jest-resolve/28.1.3: - resolution: {integrity: sha512-Z1W3tTjE6QaNI90qo/BJpfnvpxtaFTFw5CDgwpyE/Kz8U/06N1Hjf4ia9quUhCh39qIGWF1ZuxFiBiJQwSEYKQ==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - chalk: 4.1.2 - graceful-fs: 4.2.10 - jest-haste-map: 28.1.3 - jest-pnp-resolver: [email protected] - jest-util: 28.1.3 - jest-validate: 28.1.3 - resolve: 1.22.1 - resolve.exports: 1.1.0 - slash: 3.0.0 - dev: true - /jest-runner/26.6.3: resolution: {integrity: sha512-atgKpRHnaA2OvByG/HpGA4g6CSPS/1LK0jK3gATJAoptC1ojltpmVlYC3TYgdmGp+GLuhzpH30Gvs36szSL2JQ==} engines: {node: '>= 10.14.2'} @@ -28588,35 +28073,6 @@ packages: - utf-8-validate dev: true - /jest-runner/28.1.3: - resolution: {integrity: sha512-GkMw4D/0USd62OVO0oEgjn23TM+YJa2U2Wu5zz9xsQB1MxWKDOlrnykPxnMsN0tnJllfLPinHTka61u0QhaxBA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/console': 28.1.3 - '@jest/environment': 28.1.3 - '@jest/test-result': 28.1.3 - '@jest/transform': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - chalk: 4.1.2 - emittery: 0.10.2 - graceful-fs: 4.2.10 - jest-docblock: 28.1.1 - jest-environment-node: 28.1.3 - jest-haste-map: 28.1.3 - jest-leak-detector: 28.1.3 - jest-message-util: 28.1.3 - jest-resolve: 28.1.3 - jest-runtime: 28.1.3 - jest-util: 28.1.3 - jest-watcher: 28.1.3 - jest-worker: 28.1.3 - p-limit: 3.1.0 - source-map-support: 0.5.13 - transitivePeerDependencies: - - supports-color - dev: true - /jest-runtime/26.6.3: resolution: {integrity: sha512-lrzyR3N8sacTAMeonbqpnSka1dHNux2uk0qqDXVkMv2c/A3wYnvQ4EXuI013Y6+gSKSCxdaczvf4HF0mVXHRdw==} engines: {node: '>= 10.14.2'} @@ -28687,36 +28143,6 @@ packages: - supports-color dev: true - /jest-runtime/28.1.3: - resolution: {integrity: sha512-NU+881ScBQQLc1JHG5eJGU7Ui3kLKrmwCPPtYsJtBykixrM2OhVQlpMmFWJjMyDfdkGgBMNjXCGB/ebzsgNGQw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/environment': 28.1.3 - '@jest/fake-timers': 28.1.3 - '@jest/globals': 28.1.3 - '@jest/source-map': 28.1.2 - '@jest/test-result': 28.1.3 - '@jest/transform': 28.1.3 - '@jest/types': 28.1.3 - chalk: 4.1.2 - cjs-module-lexer: 1.2.2 - collect-v8-coverage: 1.0.1 - execa: 5.1.1 - glob: 7.2.3 - graceful-fs: 4.2.10 - jest-haste-map: 28.1.3 - jest-message-util: 28.1.3 - jest-mock: 28.1.3 - jest-regex-util: 28.0.2 - jest-resolve: 28.1.3 - jest-snapshot: 28.1.3 - jest-util: 28.1.3 - slash: 3.0.0 - strip-bom: 4.0.0 - transitivePeerDependencies: - - supports-color - dev: true - /jest-serializer/26.6.2: resolution: {integrity: sha512-S5wqyz0DXnNJPd/xfIzZ5Xnp1HrJWBczg8mMfMpN78OJ5eDxXyf+Ygld9wX1DnUWbIbhM1YDY95NjR4CBXkb2g==} engines: {node: '>= 10.14.2'} @@ -28787,37 +28213,6 @@ packages: - supports-color dev: true - /jest-snapshot/28.1.3: - resolution: {integrity: sha512-4lzMgtiNlc3DU/8lZfmqxN3AYD6GGLbl+72rdBpXvcV+whX7mDrREzkPdp2RnmfIiWBg1YbuFSkXduF2JcafJg==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@babel/core': 7.20.5 - '@babel/generator': 7.20.5 - '@babel/plugin-syntax-typescript': 7.20.0_@[email protected] - '@babel/traverse': 7.20.5 - '@babel/types': 7.20.5 - '@jest/expect-utils': 28.1.3 - '@jest/transform': 28.1.3 - '@jest/types': 28.1.3 - '@types/babel__traverse': 7.18.3 - '@types/prettier': 2.7.1 - babel-preset-current-node-syntax: 1.0.1_@[email protected] - chalk: 4.1.2 - expect: 28.1.3 - graceful-fs: 4.2.10 - jest-diff: 28.1.3 - jest-get-type: 28.0.2 - jest-haste-map: 28.1.3 - jest-matcher-utils: 28.1.3 - jest-message-util: 28.1.3 - jest-util: 28.1.3 - natural-compare: 1.4.0 - pretty-format: 28.1.3 - semver: 7.3.8 - transitivePeerDependencies: - - supports-color - dev: true - /jest-util/26.6.2: resolution: {integrity: sha512-MDW0fKfsn0OI7MS7Euz6h8HNDXVQ0gaM9uW6RjfDmd1DAFcaxX9OqIakHIqhbnmF08Cf2DLDG+ulq8YQQ0Lp0Q==} engines: {node: '>= 10.14.2'} @@ -28842,30 +28237,6 @@ packages: picomatch: 2.3.1 dev: true - /jest-util/28.1.1: - resolution: {integrity: sha512-FktOu7ca1DZSyhPAxgxB6hfh2+9zMoJ7aEQA759Z6p45NuO8mWcqujH+UdHlCm/V6JTWwDztM2ITCzU1ijJAfw==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - chalk: 4.1.2 - ci-info: 3.7.0 - graceful-fs: 4.2.10 - picomatch: 2.3.1 - dev: true - - /jest-util/28.1.3: - resolution: {integrity: sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - chalk: 4.1.2 - ci-info: 3.7.0 - graceful-fs: 4.2.10 - picomatch: 2.3.1 - dev: true - /jest-util/29.3.1: resolution: {integrity: sha512-7YOVZaiX7RJLv76ZfHt4nbNEzzTRiMW/IiOG7ZOKmTXmoGBxUDefgMAxQubu6WPVqP5zSzAdZG0FfLcC7HOIFQ==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -28902,18 +28273,6 @@ packages: pretty-format: 27.5.1 dev: true - /jest-validate/28.1.3: - resolution: {integrity: sha512-SZbOGBWEsaTxBGCOpsRWlXlvNkvTkY0XxRfh7zYmvd8uL5Qzyg0CHAXiXKROflh801quA6+/DsT4ODDthOC/OA==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/types': 28.1.3 - camelcase: 6.3.0 - chalk: 4.1.2 - jest-get-type: 28.0.2 - leven: 3.1.0 - pretty-format: 28.1.3 - dev: true - /jest-watch-typeahead/[email protected]: resolution: {integrity: sha512-GIbV6h37/isatMDtqZlA8Q5vC6T3w+5qdvtF+3LIkPc58zEWzbKmTHvlUIp3wvBm400RzrQWcVPcsAJqKWu7XQ==} engines: {node: '>=10'} @@ -28956,20 +28315,6 @@ packages: string-length: 4.0.2 dev: true - /jest-watcher/28.1.3: - resolution: {integrity: sha512-t4qcqj9hze+jviFPUN3YAtAEeFnr/azITXQEMARf5cMwKY2SMBRnCQTXLixTl20OR6mLh9KLMrgVJgJISym+1g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/test-result': 28.1.3 - '@jest/types': 28.1.3 - '@types/node': 18.11.11 - ansi-escapes: 4.3.2 - chalk: 4.1.2 - emittery: 0.10.2 - jest-util: 28.1.3 - string-length: 4.0.2 - dev: true - /jest-worker/25.5.0: resolution: {integrity: sha512-/dsSmUkIy5EBGfv/IjjqmFxrNAUpBERfGs1oHROyD7yxjG/w+t0GOJDX8O1k32ySmd7+a5IhnJU2qQFcJ4n1vw==} engines: {node: '>= 8.3'} @@ -28995,15 +28340,6 @@ packages: merge-stream: 2.0.0 supports-color: 8.1.1 - /jest-worker/28.1.3: - resolution: {integrity: sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@types/node': 18.11.11 - merge-stream: 2.0.0 - supports-color: 8.1.1 - dev: true - /jest/26.6.3: resolution: {integrity: sha512-lGS5PXGAzR4RF7V5+XObhqz2KZIDUA1yD0DG6pBVmy10eh0ZIXQImRuzocsI/N2XZ1GrLFwTS27In2i2jlpq1Q==} engines: {node: '>= 10.14.2'} @@ -29729,14 +29065,14 @@ packages: '@lerna/init': 6.1.0 '@lerna/link': 6.1.0 '@lerna/list': 6.1.0 - '@lerna/publish': [email protected][email protected] + '@lerna/publish': [email protected][email protected] '@lerna/run': 6.1.0 - '@lerna/version': [email protected][email protected] - '@nrwl/devkit': [email protected][email protected] + '@lerna/version': [email protected][email protected] + '@nrwl/devkit': [email protected][email protected] import-local: 3.1.0 inquirer: 8.2.5 npmlog: 6.0.2 - nx: 15.2.4 + nx: 15.3.0 typescript: 4.9.3 transitivePeerDependencies: - '@swc-node/register' @@ -30544,8 +29880,8 @@ packages: markdown-it: 12.3.2 dev: true - /marked/4.2.3: - resolution: {integrity: sha512-slWRdJkbTZ+PjkyJnE30Uid64eHwbwa1Q25INCAYfZlK4o6ylagBy/Le9eWntqJFoFT93ikUKMv47GZ4gTwHkw==} + /marked/4.2.4: + resolution: {integrity: sha512-Wcc9ikX7Q5E4BYDPvh1C6QNSxrjC9tBgz+A/vAhp59KXUgachw++uMvMKiSW8oA85nopmPZcEvBoex/YLMsiyA==} engines: {node: '>= 12'} hasBin: true dev: true @@ -32087,8 +31423,8 @@ packages: /nwsapi/2.2.2: resolution: {integrity: sha512-90yv+6538zuvUMnN+zCr8LuV6bPFdq50304114vJYJ8RDyK8D5O9Phpbd6SZWgI7PwzmmfN1upeOJlvybDSgCw==} - /nx/15.2.4: - resolution: {integrity: sha512-8rTLo5WGmM6hEo5R/u03Jllkyj4vIUbBk2MRAppCvVRXWLS4xJUEOityXJ5BAvaKoLYm6sWUP1gqU7xlldnT5A==} + /nx/15.3.0: + resolution: {integrity: sha512-5tBrEF2zDkGBDfe8wThazJqBDhsVkRrxc6OttzfBmkXP4VPp8w5MMtUEOry181AXKfjDGkw//UnCSkUNynTDlw==} hasBin: true requiresBuild: true peerDependencies: @@ -32100,8 +31436,8 @@ packages: '@swc/core': optional: true dependencies: - '@nrwl/cli': 15.2.4 - '@nrwl/tao': 15.2.4 + '@nrwl/cli': 15.3.0 + '@nrwl/tao': 15.3.0 '@parcel/watcher': 2.0.4 '@yarnpkg/lockfile': 1.1.0 '@yarnpkg/parsers': 3.0.0-rc.32 @@ -34500,14 +33836,14 @@ packages: fast-diff: 1.2.0 dev: true - /prettier-plugin-svelte/2.8.1_3ndnxlh52lolrqe4kgjgbxb3xa: + /prettier-plugin-svelte/2.8.1_kaioqtfwjumrsfopsgfoca65re: resolution: {integrity: sha512-KA3K1J3/wKDnCxW7ZDRA/QL2Q67N7Xs3gOERqJ5X1qFjq1DdnN3K1R29scSKwh+kA8FF67pXbYytUpvN/i3iQw==} peerDependencies: prettier: ^1.16.4 \|\| ^2.0.0 svelte: ^3.2.0 dependencies: prettier: 2.8.0 - svelte: 3.53.1 + svelte: 3.54.0 dev: true /prettier/2.8.0: @@ -34558,16 +33894,6 @@ packages: react-is: 17.0.2 dev: true - /pretty-format/28.1.3: - resolution: {integrity: sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==} - engines: {node: ^12.13.0 \|\| ^14.15.0 \|\| ^16.10.0 \|\| >=17.0.0} - dependencies: - '@jest/schemas': 28.1.3 - ansi-regex: 5.0.1 - ansi-styles: 5.2.0 - react-is: 18.2.0 - dev: true - /pretty-format/29.3.1: resolution: {integrity: sha512-FyLnmb1cYJV8biEIiRyzRFvs2lry7PPIvOqKVe1GCUEYg4YGmlx1qG9EJNMxArYm7piII4qb8UV1Pncq5dxmcg==} engines: {node: ^14.15.0 \|\| ^16.10.0 \|\| >=18.0.0} @@ -34668,6 +33994,17 @@ packages: optional: true dev: true + /promise-inflight/[email protected]: + resolution: {integrity: sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==} + peerDependencies: + bluebird: '' + peerDependenciesMeta: + bluebird: + optional: true + dependencies: + bluebird: 3.7.2 + dev: true + /promise-polyfill/8.2.3: resolution: {integrity: sha512-Og0+jCRQetV84U8wVjMNccfGCnMQ9mGs9Hv78QFe+pSDD3gWTpz0y+1QCuxy5d/vBFuZ3iwP2eycAkvqIMPmWg==} dev: true @@ -36222,7 +35559,7 @@ packages: source-map-resolve: 0.6.0 dev: true - /rollup-plugin-svelte/[email protected][email protected]: + /rollup-plugin-svelte/[email protected][email protected]: resolution: {integrity: sha512-vopCUq3G+25sKjwF5VilIbiY6KCuMNHP1PFvx2Vr3REBNMDllKHFZN2B9jwwC+MqNc3UPKkjXnceLPEjTjXGXg==} engines: {node: '>=10'} peerDependencies: @@ -36232,7 +35569,7 @@ packages: require-relative: 0.8.7 rollup: 3.6.0 rollup-pluginutils: 2.8.2 - svelte: 3.53.1 + svelte: 3.54.0 dev: true /rollup-plugin-terser/[email protected]: @@ -37395,8 +36732,8 @@ packages: smart-buffer: 4.2.0 dev: true - /solid-js/1.6.2: - resolution: {integrity: sha512-AZBsj+Yn1xliniTTeuQKG9V7VQVkQ8lZmSKvBjpcVSoZeF7nvt/N5f7Kcsx6QSufioa2YgvBjkIiA0cM0qhotw==} + /solid-js/1.6.3: + resolution: {integrity: sha512-YoieThdhAKt83O86+DjpKXNlVSU5JYdi21RdYqiEIsWxahOphiAfao8e/zRTLyZEM5ZgyZ3ZHPPgW1HO5537Rw==} dependencies: csstype: 3.1.1 @@ -37413,7 +36750,7 @@ packages: acorn: 6.4.1 babel-jest: 26.6.3_@[email protected] babel-loader: 8.3.0_em3sh5kto35xuanci4cvhzqfay - babel-preset-solid: 1.6.2_@[email protected] + babel-preset-solid: 1.6.3_@[email protected] case-sensitive-paths-webpack-plugin: 2.4.0 component-register-loader: [email protected] css-loader: [email protected] @@ -37551,13 +36888,6 @@ packages: source-map: 0.5.7 dev: true - /source-map-support/0.5.13: - resolution: {integrity: sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==} - dependencies: - buffer-from: 1.1.2 - source-map: 0.6.1 - dev: true - /source-map-support/0.5.21: resolution: {integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==} dependencies: @@ -38362,7 +37692,7 @@ packages: resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} engines: {node: '>= 0.4'} - /svelte-check/[email protected]: + /svelte-check/[email protected]: resolution: {integrity: sha512-uscZovyuOPA89NuAkc4vO27mzx//2wFBNtwTsgYcNs7JwaFpJ2TqBawQ/avG7gkieYQ3QXqFUggJZ+s51fQGDQ==} hasBin: true peerDependencies: @@ -38374,8 +37704,8 @@ packages: import-fresh: 3.3.0 picocolors: 1.0.0 sade: 1.8.1 - svelte: 3.53.1 - svelte-preprocess: 4.10.7_7dvewpees4iyn2tkw2qzal77a4 + svelte: 3.54.0 + svelte-preprocess: 4.10.7_gf4dcx76vtk2o62ixxeqx7chra typescript: 4.9.3 transitivePeerDependencies: - '@babel/core' @@ -38390,7 +37720,7 @@ packages: - sugarss dev: true - /svelte-preprocess/4.10.7_7dvewpees4iyn2tkw2qzal77a4: + /svelte-preprocess/4.10.7_gf4dcx76vtk2o62ixxeqx7chra: resolution: {integrity: sha512-sNPBnqYD6FnmdBrUmBCaqS00RyCsCpj2BG58A1JBswNF7b0OKviwxqVrOL/CKyJrLSClrSeqQv5BXNg2RUbPOw==} engines: {node: '>= 9.11.2'} requiresBuild: true @@ -38437,12 +37767,12 @@ packages: magic-string: 0.25.9 sorcery: 0.10.0 strip-indent: 3.0.0 - svelte: 3.53.1 + svelte: 3.54.0 typescript: 4.9.3 dev: true - /svelte/3.53.1: - resolution: {integrity: sha512-Q4/hHkktZogGhN5iqxqSi9sjEVoe/NbIxX4hXEHoasTxj+TxEQVAq66LnDMdAZxjmsodkoI5F3slqsS68U7FNw==} + /svelte/3.54.0: + resolution: {integrity: sha512-tdrgeJU0hob0ZWAMoKXkhcxXA7dpTg6lZGxUeko5YqvPdJBiyRspGsCwV27kIrbrqPP2WUoSV9ca0gnLlw8YzQ==} engines: {node: '>= 8'} dev: true @@ -39395,7 +38725,7 @@ packages: typescript: 4.6.x \|\| 4.7.x \|\| 4.8.x \|\| 4.9.x dependencies: lunr: 2.3.9 - marked: 4.2.3 + marked: 4.2.4 minimatch: 5.1.1 shiki: 0.11.1 typescript: 4.9.3 @@ -39917,15 +39247,6 @@ packages: source-map: 0.7.4 dev: true - /v8-to-istanbul/9.0.1: - resolution: {integrity: sha512-74Y4LqY74kLE6IFyIjPtkSTWzUZmj8tdHT9Ii/26dvQ6K9Dl2NbEfj0XgU2sHCtKgt5VupqhlO/5aWuqS+IY1w==} - engines: {node: '>=10.12.0'} - dependencies: - '@jridgewell/trace-mapping': 0.3.17 - '@types/istanbul-lib-coverage': 2.0.4 - convert-source-map: 1.9.0 - dev: true - /v8flags/3.2.0: resolution: {integrity: sha512-mH8etigqMfiGWdeXpaaqGfs6BndypxusHHcv2qSHyZkGEznCd/qAXCWWRzeowtL54147cktFOC4P5y+kl8d8Jg==} engines: {node: '>= 0.10'} @@ -40725,7 +40046,7 @@ packages: mime-types: 2.1.35 range-parser: 1.2.1 schema-utils: 4.0.0 - webpack: [email protected] + webpack: 5.75.0 /webpack-dev-server/[email protected]: resolution: {integrity: sha512-3x31rjbEQWKMNzacUZRE6wXvUFuGpH7vr0lIEbYpMAG9BOxi0928QU1BBswOAP3kg3H1O4hiS+sq4YyAn6ANnA==} @@ -41104,8 +40425,8 @@ packages: webpack: 5.75.0 dev: true - /webpack-tsparticles-plugin/1.5.0: - resolution: {integrity: sha512-NeieLEoASXwEqq5ETGyiRj1/MHH0G73cSsFevxdAwWIZwOsO/cVkBdBovTRlO8BPLhH1Dfmj8k33HKJedSd3vg==} + /webpack-tsparticles-plugin/1.5.1: + resolution: {integrity: sha512-NsOUP2vAlBBO/5sWD3Cboh4Xn4/ghxBBIQjH7XRBCDPH9M9GbXQ+EJI5a862q/yAdluw8uRHy6Ygy8r8VMJhmw==} dependencies: '@babel/core': 7.20.5 '@babel/preset-env': 7.20.2_@[email protected] @@ -41220,7 +40541,6 @@ packages: - '@swc/core' - esbuild - uglify-js - dev: true /webpack/[email protected]: resolution: {integrity: sha512-piaIaoVJlqMsPtX/+3KTTO6jfvrSYgauFVdt8cr9LTHKmcq/AMd4mhzsiP7ZF/PGRNPGA8336jldh9l2Kt2ogQ==} diff --git a/index.html b/index.html index f5a8460..6a789ec 100644 --- a/index.html +++ b/index.html @@ -701,6 +701,7 @@ <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.path.simplex.noise.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.preset.links.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.shape.bubble.min.js"></script> + <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.shape.cards.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.shape.heart.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.shape.multiline-text.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.shape.rounded-rect.min.js"></script> diff --git a/demo.js b/demo.js index bbf3584..8ec4d7d 100644 --- a/demo.js +++ b/demo.js @@ -497,6 +497,7 @@ await loadPerlinNoisePath(tsParticles); await loadSimplexNoisePath(tsParticles); await loadBubbleShape(tsParticles); + await loadCardsShape(tsParticles); await loadHeartShape(tsParticles); await loadMultilineTextShape(tsParticles); await loadRoundedRectShape(tsParticles); diff --git a/demo.min.js b/demo.min.js index 6ae867c..10b0a2f 100644 --- a/demo.min.js +++ b/demo.min.js @@ -1 +1 @@ -!function(){let t,e={};const o=new Stats;o.addPanel("count","#ff8",0,(()=>{const t=tsParticles.domItem(0);if(t)return n=Math.max(t.particles.count,n),{value:t.particles.count,maxValue:n}}));let n=0;o.showPanel(2),o.dom.style.position="absolute",o.dom.style.left="3px",o.dom.style.top="3px",o.dom.id="stats-graph";function a(t,e,o){return o.indexOf(t)===e}let i=function(t,o,n){const r=o[n],s=function(t,o,n){if(t)if(t.type)switch(t.type){case"boolean":return["true","false"];case"number":case"string":return t.enum;case"array":return getSchemaValuesFromProp(t.items)}else{if(t.$ref){const a=t.$ref.split("/"),r=a[a.length-1],s=e.definitions[r];return i(s,o,n+(/I[A-Z]/.exec(r)?1:0))}if(t.anyOf){let e=[];for(const a of t.anyOf){const t=getSchemaValuesFromProp(a,o,n);for(const o of t)e.push(o)}return e.filter(a)}}}(t.properties?t.properties[r]:t,o,n);return s},r=function(t,o,n,a){try{switch(n){case"field":break;case"value":return i(e,o,0).filter((function(e){return e.includes(t)}))}}catch(t){}return null},s=function(t){tsParticles.domItem(0).refresh().then((()=>{t&&"function"==typeof t&&t()}))},c=function(){const t=document.body.querySelector(".caret-right"),e=document.body.querySelector(".caret-left"),o=document.getElementById("sidebar");o.hasAttribute("hidden")?(t.setAttribute("hidden",""),e.removeAttribute("hidden"),o.removeAttribute("hidden"),o.classList.add("d-md-block")):(e.setAttribute("hidden",""),t.removeAttribute("hidden"),o.setAttribute("hidden",""),o.classList.remove("d-md-block")),s()},d=function(){const t=tsParticles.domItem(0);t&&t.exportImage((function(t){const e=document.body.querySelector("#exportModal .modal-body .modal-body-content"),o=document.getElementById("tsparticles");e.innerHTML="",e.style.backgroundColor=o.style.backgroundColor,e.style.backgroundImage=o.style.backgroundImage,e.style.backgroundPosition=o.style.backgroundPosition,e.style.backgroundRepeat=o.style.backgroundRepeat,e.style.backgroundSize=o.style.backgroundSize;const n=new Image;n.className="img-fluid",n.onload=()=>URL.revokeObjectURL(n.src);const a=URL.createObjectURL(t);n.src=a,e.appendChild(n);new bootstrap.Modal(document.getElementById("exportModal")).show()}))},l=function(){const t=tsParticles.domItem(0);if(t){const e=document.body.querySelector("#exportModal .modal-body .modal-body-content"),o=t.exportConfiguration();e.innerHTML=`<pre>${o}</pre>`;const n=document.querySelector("#exportConfigCopy"),a=document.querySelector("#exportConfigDownload");n.onclick=function(){navigator.clipboard&&navigator.clipboard.writeText(o)},a.onclick=function(){const t="application/json",e=new Blob([o],{type:t}),n=URL.createObjectURL(e),a=document.createElement("a");a.download="particles.json",a.href=n,a.dataset.downloadUrl=[t,a.download,a.href].join(":");const i=document.createEvent("MouseEvents");i.initMouseEvent("click",!0,!1,window,0,0,0,0,0,!1,!1,!1,!1,0,null),a.dispatchEvent(i)};new bootstrap.Modal(document.getElementById("exportModal")).show()}},u=function(){const t=tsParticles.domItem(0);if(t){const e=document.getElementById("code-pen-form"),o=document.getElementById("code-pen-data"),n=(document.getElementById("tsparticles"),{html:'\\x3c!-- tsParticles - https://particles.js.org - https://github.com/matteobruni/tsparticles --\\x3e\\n<div id="tsparticles"></div>',css:"",js:`tsParticles.load("tsparticles", ${JSON.stringify(t.options,((t,e)=>{if("_engine"!==t&&"_container"!==t)return e}))});`,js_external:"https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.bundle.min.js",title:"tsParticles example",description:"This pen was created with tsParticles from https://particles.js.org",tags:"tsparticles, javascript, typescript, design, animation",editors:"001"}),a=JSON.stringify(n).replace(/"/g,""").replace(/'/g,"'");o.value=a,e.submit()}},m=function(){const t=document.body.querySelector("#stats");t.hasAttribute("hidden")?t.removeAttribute("hidden"):t.setAttribute("hidden","")},p=function(){tsParticles.domItem(0).options.load(t.get()),s((()=>{}))},g=function(e){localStorage.presetId;localStorage.presetId=e,window.location.hash=e,function(t){const e=document.body.querySelectorAll(".preset-item"),o=e[Math.floor(Math.random()e.length)].dataset.preset,n=localStorage.presetId\|\|o;document.getElementById("repulse-div").className="divRepulse"===n?"d-block":"d-none",tsParticles.loadJSON("tsparticles",`../presets/${n}.json`).then((e=>{localStorage.presetId=n,window.location.hash=n;const o=t=>_.omitBy(t,((t,e)=>_.startsWith(e,"_"))),a=t=>_.transform(o(t),(function(t,e,n){t[n]=_.isObject(e)?a(o(e)):e}));t.update(a(e.options)),t.expandAll()}))}(t)},h=function(){g(this.dataset.preset)};window.addEventListener("hashchange",(function(){const t=document.body.querySelectorAll(".preset-item");if(window.location.hash)for(let e=0;e<t.length;e++)if(t[e].dataset.preset===window.location.hash.replace("#",""))return localStorage.presetId=window.location.hash.replace("#",""),void g(localStorage.presetId)})),window.addEventListener("load",(async()=>{const n=document.getElementById("editor");t=new JSONEditor(n,{mode:"form",modes:["code","form","view","preview","text"],autocomplete:{filter:"contain",trigger:"focus",getOptions:r},onError:function(t){alert(t.toString())},onModeChange:function(t,e){},onChange:function(){}});const a=document.body.querySelectorAll(".preset-item");if(window.location.hash)for(let t=0;t<a.length;t++)if(a[t].dataset.preset===window.location.hash.replace("#","")){localStorage.presetId=window.location.hash.replace("#","");break}localStorage.presetId\|\|(localStorage.presetId=a[Math.floor(Math.random()a.length)].dataset.preset),g(localStorage.presetId),fetch("../schema/options.schema.json").then((function(o){o.json().then((function(o){e=o,t.setSchema(e)}))})),document.getElementById("btnUpdate").addEventListener("click",p),document.getElementById("btnNavUpdate").addEventListener("click",p),document.getElementById("stats").appendChild(o.dom),document.getElementById("toggle-stats").addEventListener("click",m),document.getElementById("nav-toggle-stats").addEventListener("click",m),document.body.querySelector(".toggle-sidebar").addEventListener("click",c);for(const t of a)t.addEventListener("click",h);document.getElementById("export-image").addEventListener("click",d),document.getElementById("nav-export-image").addEventListener("click",d),document.getElementById("export-config").addEventListener("click",l),document.getElementById("nav-export-config").addEventListener("click",l),document.getElementById("codepen-export").addEventListener("click",u),document.getElementById("nav-codepen-export").addEventListener("click",u),function(){const t=document.body.querySelector(".caret-right"),e=document.body.querySelector(".caret-left");document.getElementById("sidebar").hasAttribute("hidden")?(e.setAttribute("hidden",""),t.removeAttribute("hidden")):(t.setAttribute("hidden",""),e.removeAttribute("hidden"))}(),function(){const t=function(){o.begin(),o.end(),requestAnimationFrame(t)};requestAnimationFrame(t)}(),await loadFull(tsParticles),await loadCanvasMaskPlugin(tsParticles),await loadInfectionPlugin(tsParticles),await loadHsvColorPlugin(tsParticles),await loadPolygonMaskPlugin(tsParticles),await loadLightInteraction(tsParticles),await loadParticlesRepulseInteraction(tsParticles),await loadGradientUpdater(tsParticles),await loadOrbitUpdater(tsParticles),await loadCurvesPath(tsParticles),await loadPolygonPath(tsParticles),await loadPerlinNoisePath(tsParticles),await loadSimplexNoisePath(tsParticles),await loadBubbleShape(tsParticles),await loadHeartShape(tsParticles),await loadMultilineTextShape(tsParticles),await loadRoundedRectShape(tsParticles),await loadSpiralShape(tsParticles)}))}(); +!function(){let t,e={};const o=new Stats;o.addPanel("count","#ff8",0,(()=>{const t=tsParticles.domItem(0);if(t)return n=Math.max(t.particles.count,n),{value:t.particles.count,maxValue:n}}));let n=0;o.showPanel(2),o.dom.style.position="absolute",o.dom.style.left="3px",o.dom.style.top="3px",o.dom.id="stats-graph";function a(t,e,o){return o.indexOf(t)===e}let i=function(t,o,n){const r=o[n],s=function(t,o,n){if(t)if(t.type)switch(t.type){case"boolean":return["true","false"];case"number":case"string":return t.enum;case"array":return getSchemaValuesFromProp(t.items)}else{if(t.$ref){const a=t.$ref.split("/"),r=a[a.length-1],s=e.definitions[r];return i(s,o,n+(/I[A-Z]/.exec(r)?1:0))}if(t.anyOf){let e=[];for(const a of t.anyOf){const t=getSchemaValuesFromProp(a,o,n);for(const o of t)e.push(o)}return e.filter(a)}}}(t.properties?t.properties[r]:t,o,n);return s},r=function(t,o,n,a){try{switch(n){case"field":break;case"value":return i(e,o,0).filter((function(e){return e.includes(t)}))}}catch(t){}return null},s=function(t){tsParticles.domItem(0).refresh().then((()=>{t&&"function"==typeof t&&t()}))},c=function(){const t=document.body.querySelector(".caret-right"),e=document.body.querySelector(".caret-left"),o=document.getElementById("sidebar");o.hasAttribute("hidden")?(t.setAttribute("hidden",""),e.removeAttribute("hidden"),o.removeAttribute("hidden"),o.classList.add("d-md-block")):(e.setAttribute("hidden",""),t.removeAttribute("hidden"),o.setAttribute("hidden",""),o.classList.remove("d-md-block")),s()},d=function(){const t=tsParticles.domItem(0);t&&t.exportImage((function(t){const e=document.body.querySelector("#exportModal .modal-body .modal-body-content"),o=document.getElementById("tsparticles");e.innerHTML="",e.style.backgroundColor=o.style.backgroundColor,e.style.backgroundImage=o.style.backgroundImage,e.style.backgroundPosition=o.style.backgroundPosition,e.style.backgroundRepeat=o.style.backgroundRepeat,e.style.backgroundSize=o.style.backgroundSize;const n=new Image;n.className="img-fluid",n.onload=()=>URL.revokeObjectURL(n.src);const a=URL.createObjectURL(t);n.src=a,e.appendChild(n);new bootstrap.Modal(document.getElementById("exportModal")).show()}))},l=function(){const t=tsParticles.domItem(0);if(t){const e=document.body.querySelector("#exportModal .modal-body .modal-body-content"),o=t.exportConfiguration();e.innerHTML=`<pre>${o}</pre>`;const n=document.querySelector("#exportConfigCopy"),a=document.querySelector("#exportConfigDownload");n.onclick=function(){navigator.clipboard&&navigator.clipboard.writeText(o)},a.onclick=function(){const t="application/json",e=new Blob([o],{type:t}),n=URL.createObjectURL(e),a=document.createElement("a");a.download="particles.json",a.href=n,a.dataset.downloadUrl=[t,a.download,a.href].join(":");const i=document.createEvent("MouseEvents");i.initMouseEvent("click",!0,!1,window,0,0,0,0,0,!1,!1,!1,!1,0,null),a.dispatchEvent(i)};new bootstrap.Modal(document.getElementById("exportModal")).show()}},u=function(){const t=tsParticles.domItem(0);if(t){const e=document.getElementById("code-pen-form"),o=document.getElementById("code-pen-data"),n=(document.getElementById("tsparticles"),{html:'\\x3c!-- tsParticles - https://particles.js.org - https://github.com/matteobruni/tsparticles --\\x3e\\n<div id="tsparticles"></div>',css:"",js:`tsParticles.load("tsparticles", ${JSON.stringify(t.options,((t,e)=>{if("_engine"!==t&&"_container"!==t)return e}))});`,js_external:"https://cdn.jsdelivr.net/npm/[email protected]/tsparticles.bundle.min.js",title:"tsParticles example",description:"This pen was created with tsParticles from https://particles.js.org",tags:"tsparticles, javascript, typescript, design, animation",editors:"001"}),a=JSON.stringify(n).replace(/"/g,""").replace(/'/g,"'");o.value=a,e.submit()}},m=function(){const t=document.body.querySelector("#stats");t.hasAttribute("hidden")?t.removeAttribute("hidden"):t.setAttribute("hidden","")},p=function(){tsParticles.domItem(0).options.load(t.get()),s((()=>{}))},g=function(e){localStorage.presetId;localStorage.presetId=e,window.location.hash=e,function(t){const e=document.body.querySelectorAll(".preset-item"),o=e[Math.floor(Math.random()e.length)].dataset.preset,n=localStorage.presetId\|\|o;document.getElementById("repulse-div").className="divRepulse"===n?"d-block":"d-none",tsParticles.loadJSON("tsparticles",`../presets/${n}.json`).then((e=>{localStorage.presetId=n,window.location.hash=n;const o=t=>_.omitBy(t,((t,e)=>_.startsWith(e,"_"))),a=t=>_.transform(o(t),(function(t,e,n){t[n]=_.isObject(e)?a(o(e)):e}));t.update(a(e.options)),t.expandAll()}))}(t)},h=function(){g(this.dataset.preset)};window.addEventListener("hashchange",(function(){const t=document.body.querySelectorAll(".preset-item");if(window.location.hash)for(let e=0;e<t.length;e++)if(t[e].dataset.preset===window.location.hash.replace("#",""))return localStorage.presetId=window.location.hash.replace("#",""),void g(localStorage.presetId)})),window.addEventListener("load",(async()=>{const n=document.getElementById("editor");t=new JSONEditor(n,{mode:"form",modes:["code","form","view","preview","text"],autocomplete:{filter:"contain",trigger:"focus",getOptions:r},onError:function(t){alert(t.toString())},onModeChange:function(t,e){},onChange:function(){}});const a=document.body.querySelectorAll(".preset-item");if(window.location.hash)for(let t=0;t<a.length;t++)if(a[t].dataset.preset===window.location.hash.replace("#","")){localStorage.presetId=window.location.hash.replace("#","");break}localStorage.presetId\|\|(localStorage.presetId=a[Math.floor(Math.random()a.length)].dataset.preset),g(localStorage.presetId),fetch("../schema/options.schema.json").then((function(o){o.json().then((function(o){e=o,t.setSchema(e)}))})),document.getElementById("btnUpdate").addEventListener("click",p),document.getElementById("btnNavUpdate").addEventListener("click",p),document.getElementById("stats").appendChild(o.dom),document.getElementById("toggle-stats").addEventListener("click",m),document.getElementById("nav-toggle-stats").addEventListener("click",m),document.body.querySelector(".toggle-sidebar").addEventListener("click",c);for(const t of a)t.addEventListener("click",h);document.getElementById("export-image").addEventListener("click",d),document.getElementById("nav-export-image").addEventListener("click",d),document.getElementById("export-config").addEventListener("click",l),document.getElementById("nav-export-config").addEventListener("click",l),document.getElementById("codepen-export").addEventListener("click",u),document.getElementById("nav-codepen-export").addEventListener("click",u),function(){const t=document.body.querySelector(".caret-right"),e=document.body.querySelector(".caret-left");document.getElementById("sidebar").hasAttribute("hidden")?(e.setAttribute("hidden",""),t.removeAttribute("hidden")):(t.setAttribute("hidden",""),e.removeAttribute("hidden"))}(),function(){const t=function(){o.begin(),o.end(),requestAnimationFrame(t)};requestAnimationFrame(t)}(),await loadFull(tsParticles),await loadCanvasMaskPlugin(tsParticles),await loadInfectionPlugin(tsParticles),await loadHsvColorPlugin(tsParticles),await loadPolygonMaskPlugin(tsParticles),await loadLightInteraction(tsParticles),await loadParticlesRepulseInteraction(tsParticles),await loadGradientUpdater(tsParticles),await loadOrbitUpdater(tsParticles),await loadCurvesPath(tsParticles),await loadPolygonPath(tsParticles),await loadPerlinNoisePath(tsParticles),await loadSimplexNoisePath(tsParticles),await loadBubbleShape(tsParticles),await loadCardsShape(tsParticles),await loadHeartShape(tsParticles),await loadMultilineTextShape(tsParticles),await loadRoundedRectShape(tsParticles),await loadSpiralShape(tsParticles)}))}();
test(pandas): ignore array size warning	b7eeced7b372997e079d28d04749080f4f94d542	test	https://github.com/ibis-project/ibis/commit/b7eeced7b372997e079d28d04749080f4f94d542	ignore array size warning	[email protected]	diff --git a/pyproject.toml b/pyproject.toml index 807d3a5..1ee7fe2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -293,6 +293,8 @@ filterwarnings = [ 'ignore:`np\\.bool` is a deprecated alias for the builtin `bool`:DeprecationWarning', # numpy, coming from a pandas call 'ignore:In the future `np\\.bool` will be defined as the corresponding NumPy scalar:FutureWarning', + # pandas by way of polars when comparing arrays + 'ignore:The truth value of an empty array is ambiguous.:DeprecationWarning', # druid 'ignore:Dialect druid.rest will not make use of SQL compilation caching:', # ibis
test(array): add test for #7679	ec979f0a28beb2e25af403fc80c8e1821b99248b	test	https://github.com/rohankumardubey/ibis/commit/ec979f0a28beb2e25af403fc80c8e1821b99248b	add test for #7679	[email protected]	diff --git a/test_array.py b/test_array.py index cb7e82b..a3b641b 100644 --- a/test_array.py +++ b/test_array.py @@ -875,19 +875,20 @@ def test_unnest_empty_array(con): @builtin_array @pytest.mark.notimpl( - ["datafusion", "impala", "mssql", "polars", "snowflake", "sqlite", "mysql"], - raises=com.OperationNotDefinedError, -) [email protected]( - ["dask", "pandas"], + [ + "datafusion", + "impala", + "mssql", + "polars", + "snowflake", + "sqlite", + "mysql", + "dask", + "pandas", + ], raises=com.OperationNotDefinedError, - reason="Operation 'ArrayMap' is not implemented for this backend", -) [email protected]( - ["sqlite"], - raises=NotImplementedError, - reason="Unsupported type: Array: ...", ) [email protected](["sqlite"], raises=NotImplementedError) def test_array_map_with_conflicting_names(backend, con): t = ibis.memtable({"x": [[1, 2]]}, schema=ibis.schema(dict(x="!array<int8>"))) expr = t.select(a=t.x.map(lambda x: x + 1)).select( @@ -896,3 +897,37 @@ def test_array_map_with_conflicting_names(backend, con): result = con.execute(expr) expected = pd.DataFrame({"b": [[3]]}) backend.assert_frame_equal(result, expected) + + +@builtin_array [email protected]( + [ + "datafusion", + "impala", + "mssql", + "polars", + "snowflake", + "sqlite", + "mysql", + "dask", + "pandas", + ], + raises=com.OperationNotDefinedError, +) +def test_complex_array_map(con): + def upper(token): + return token.upper() + + def swap(token): + return token.substitute({"abc": "ABC"}) + + arr = ibis.array(["abc", "xyz"]) + + expr = arr.map(upper) + assert con.execute(expr) == ["ABC", "XYZ"] + + expr = arr.map(swap) + assert con.execute(expr) == ["ABC", "xyz"] + + expr = arr.map(lambda token: token.substitute({"abc": "ABC"})) + assert con.execute(expr) == ["ABC", "xyz"]
build: array in particles object is now private	0b9fcbbd1fd3f2add67721537014d8a823532837	build	https://github.com/tsparticles/tsparticles/commit/0b9fcbbd1fd3f2add67721537014d8a823532837	array in particles object is now private	[email protected]	diff --git a/Particle.ts b/Particle.ts index b2493f3..f5587fe 100644 --- a/Particle.ts +++ b/Particle.ts @@ -715,16 +715,9 @@ export class Particle implements IParticle { throw new Error(`${errorPrefix} particle is overlapping and can't be placed`); } - let overlaps = false; - - for (const particle of this.container.particles.array) { - if (getDistance(pos, particle.position) < radius + particle.getRadius()) { - overlaps = true; - break; - } - } - - return overlaps; + return !!this.container.particles.find( + (particle) => getDistance(pos, particle.position) < radius + particle.getRadius() + ); } private _getRollColor(color?: IHsl): IHsl \| undefined { diff --git a/Particles.ts b/Particles.ts index 741c006..bae3bfc 100644 --- a/Particles.ts +++ b/Particles.ts @@ -63,15 +63,15 @@ describe("Particles", () => { const particle1 = testParticles.particles.addParticle({ x: 1, y: 1 }); expect(testParticles.particles.count).to.equal(1); - expect(testParticles.particles.array).to.eql([particle1]); + expect(testParticles.particles._array).to.eql([particle1]); const particle2 = testParticles.particles.addParticle({ x: 2, y: 2 }); expect(testParticles.particles.count).to.equal(2); - expect(testParticles.particles.array).to.eql([particle1, particle2]); + expect(testParticles.particles._array).to.eql([particle1, particle2]); const particle3 = testParticles.particles.addParticle({ x: 3, y: 3 }); expect(testParticles.particles.count).to.equal(3); - expect(testParticles.particles.array).to.eql([particle1, particle2, particle3]); + expect(testParticles.particles._array).to.eql([particle1, particle2, particle3]); }); it("should remove particles at specified indices", () => { @@ -79,18 +79,18 @@ describe("Particles", () => { testParticles.reset(testContainer.container); testParticles.particles.init(); - const particle1 = testParticles.particles.array[0]; - const particle3 = testParticles.particles.array[2]; - const particle4 = testParticles.particles.array[3]; - const particle5 = testParticles.particles.array[4]; + const particle1 = testParticles.particles._array[0]; + const particle3 = testParticles.particles._array[2]; + const particle4 = testParticles.particles._array[3]; + const particle5 = testParticles.particles._array[4]; testParticles.particles.removeAt(1); - expect(testParticles.particles.array).to.eql([particle1, particle3, particle4, particle5]); - expect(testParticles.particles.array).to.not.eql([particle5, particle4, particle3, particle1]); + expect(testParticles.particles._array).to.eql([particle1, particle3, particle4, particle5]); + expect(testParticles.particles._array).to.not.eql([particle5, particle4, particle3, particle1]); testParticles.particles.removeAt(2); - expect(testParticles.particles.array).to.eql([particle1, particle3, particle5]); - expect(testParticles.particles.array).to.not.eql([particle5, particle3, particle1]); + expect(testParticles.particles._array).to.eql([particle1, particle3, particle5]); + expect(testParticles.particles._array).to.not.eql([particle5, particle3, particle1]); }); it("should remove specified quantity of indices, starting at the specified index", () => { @@ -98,16 +98,16 @@ describe("Particles", () => { testParticles.reset(testContainer.container); testParticles.particles.init(); - const particle1 = testParticles.particles.array[0]; - const particle4 = testParticles.particles.array[3]; - const particle5 = testParticles.particles.array[4]; + const particle1 = testParticles.particles._array[0]; + const particle4 = testParticles.particles._array[3]; + const particle5 = testParticles.particles._array[4]; testParticles.particles.removeAt(1, 2); - expect(testParticles.particles.array).to.eql([particle1, particle4, particle5]); - expect(testParticles.particles.array).to.not.eql([particle5, particle4, particle1]); + expect(testParticles.particles._array).to.eql([particle1, particle4, particle5]); + expect(testParticles.particles._array).to.not.eql([particle5, particle4, particle1]); testParticles.particles.removeAt(0, 2); - expect(testParticles.particles.array).to.eql([particle5]); + expect(testParticles.particles._array).to.eql([particle5]); }); it("should remove specified number of particles", () => { @@ -120,7 +120,7 @@ describe("Particles", () => { expect(testParticles.particles.count).to.equal(numParticles - 3); testParticles.particles.removeQuantity(2); expect(testParticles.particles.count).to.equal(numParticles - 5); - expect(testParticles.particles.array).to.be.empty; + expect(testParticles.particles._array).to.be.empty; }); it("should remove specified particle", () => { @@ -128,19 +128,19 @@ describe("Particles", () => { testParticles.reset(testContainer.container); testParticles.particles.init(); - const particle1 = testParticles.particles.array[0]; - const particle2 = testParticles.particles.array[1]; - const particle3 = testParticles.particles.array[2]; - const particle4 = testParticles.particles.array[3]; - const particle5 = testParticles.particles.array[4]; + const particle1 = testParticles.particles._array[0]; + const particle2 = testParticles.particles._array[1]; + const particle3 = testParticles.particles._array[2]; + const particle4 = testParticles.particles._array[3]; + const particle5 = testParticles.particles._array[4]; testParticles.particles.remove(particle4); - expect(testParticles.particles.array).to.eql([particle1, particle2, particle3, particle5]); - expect(testParticles.particles.array).to.not.eql([particle5, particle3, particle2, particle1]); + expect(testParticles.particles._array).to.eql([particle1, particle2, particle3, particle5]); + expect(testParticles.particles._array).to.not.eql([particle5, particle3, particle2, particle1]); testParticles.particles.remove(particle1); - expect(testParticles.particles.array).to.eql([particle2, particle3, particle5]); - expect(testParticles.particles.array).to.not.eql([particle5, particle3, particle2]); + expect(testParticles.particles._array).to.eql([particle2, particle3, particle5]); + expect(testParticles.particles._array).to.not.eql([particle5, particle3, particle2]); }); it("should remove all particles when calling clear", () => { @@ -151,7 +151,7 @@ describe("Particles", () => { expect(testParticles.particles.count).to.equal(numParticles); testParticles.particles.clear(); expect(testParticles.particles.count).to.equal(0); - expect(testParticles.particles.array).to.be.empty; + expect(testParticles.particles._array).to.be.empty; }); it("should push multiple particles at the specified position", () => { @@ -164,7 +164,7 @@ describe("Particles", () => { expect(testParticles.particles.count).to.equal(numParticles); for (let i = 0; i < numParticles; i++) { - expect(testParticles.particles.array[i].position).to.eql(position); + expect(testParticles.particles._array[i].position).to.eql(position); } }); @@ -178,7 +178,7 @@ describe("Particles", () => { expect(testParticles.particles.count).to.equal(5); let ts = getRandom() * 16.66667; - const logP = testParticles.particles.array[0]; + const logP = testParticles.particles._array[0]; console.log(logP.id); diff --git a/Modes.ts b/Modes.ts index b031d37..e71a1c9 100644 --- a/Modes.ts +++ b/Modes.ts @@ -24,16 +24,22 @@ export class Modes implements IModes, IOptionLoader<IModes> { return; } - if (this._container) { - const interactors = this._engine.plugins.interactors.get(this._container); - - if (interactors) { - for (const interactor of interactors as IExternalInteractor[]) { - if (interactor.loadModeOptions) { - interactor.loadModeOptions(this, data); - } - } + if (!this._container) { + return; + } + + const interactors = this._engine.plugins.interactors.get(this._container); + + if (!interactors) { + return; + } + + for (const interactor of interactors as IExternalInteractor[]) { + if (!interactor.loadModeOptions) { + continue; } + + interactor.loadModeOptions(this, data); } } } diff --git a/engine.ts b/engine.ts index 589ff88..0ef2151 100644 --- a/engine.ts +++ b/engine.ts @@ -37,7 +37,7 @@ declare global { /** * Engine class for creating the singleton on window. - * It's a singleton proxy to the Loader class for initializing {@link Container} instances, + * It's a singleton proxy to the {@link Loader} class for initializing {@link Container} instances, * and for Plugins class responsible for every external feature */ export class Engine {

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.