Commit 63c27e2

authored

feat: deprecate detectChanges in favor of detectChangesOnRender (#340)

1 parent 65cccbe commit 63c27e2Copy full SHA for 63c27e2

File tree

+21

-1

lines changed

+21

-1

lines changed

Lines changed: 17 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -78,8 +78,25 @@ export interface RenderComponentOptions<ComponentType, Q extends Queries = typeo`
`78`	`78`	`* const component = await render(AppComponent, {`
`79`	`79`	`* detectChanges: false`
`80`	`80`	`* })`
	`81`	`+ *`
	`82`	`+ * @deprecated`
	`83`	+ * Use `detectChangesOnRender` instead
`81`	`84`	`*/`
`82`	`85`	`detectChanges?: boolean;`
	`86`	`+ /**`
	`87`	`+ * @description`
	`88`	+ * Invokes `detectChanges` after the component is rendered
	`89`	`+ *`
	`90`	`+ * @default`
	`91`	`+ * true`
	`92`	`+ *`
	`93`	`+ * @example`
	`94`	`+ * const component = await render(AppComponent, {`
	`95`	`+ * detectChangesOnRender: false`
	`96`	`+ * })`
	`97`	`+ */`
	`98`	`+ detectChangesOnRender?: boolean;`
	`99`	`+`
`83`	`100`	`/**`
`84`	`101`	`* @description`
`85`	`102`	`* A collection of components, directives and pipes needed to render the component, for example, nested components of the component.`

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,8 @@ export async function render<SutType, WrapperType = SutType>(`
`46`	`46`	`): Promise<RenderResult<SutType>> {`
`47`	`47`	`const { dom: domConfig, ...globalConfig } = getConfig();`
`48`	`48`	`const {`
`49`		`- detectChanges: detectChangesOnRender = true,`
	`49`	`+ detectChanges: detectChangesDeprecated = true,`
	`50`	`+ detectChangesOnRender: detectChangesOnRenderInput,`
`50`	`51`	`declarations = [],`
`51`	`52`	`imports = [],`
`52`	`53`	`providers = [],`
`@@ -63,6 +64,8 @@ export async function render<SutType, WrapperType = SutType>(`
`63`	`64`	`defaultImports = [],`
`64`	`65`	`} = { ...globalConfig, ...renderOptions };`
`65`	`66`
	`67`	`+ const detectChangesOnRender =`
	`68`	`+ detectChangesOnRenderInput === undefined ? detectChangesDeprecated : detectChangesOnRenderInput;`
`66`	`69`	`dtlConfigure({`
`67`	`70`	`eventWrapper: (cb) => {`
`68`	`71`	`const result = cb();`

Comments

(0)