What are the appropriate method signatures to use in Aurelia's pipeline configuration?

Question

What are the appropriate method signatures to use in Aurelia's pipeline configuration?

If you want to customize your pipeline steps, you can do so by using addPipelineStep. Just remember that the step's name needs to match one of the default slots in the pipeline: authorize, preActivate, preRender, and postRender. Aurelia provides functions for creating a pipeline step for each of these slots.

The authorize step is triggered between loading the route's step and calling the canActivate function of the route view-model (if defined). The preActivate step is called between the canActivate function and the deactivate function of the previous route view-model (if defined). The preRender step occurs between the activate function of the route view-model and rendering/composing the component. Finally, the postRender step happens after the component has been rendered/composed.

So should it be public canActivate(): void {? Or public canActivate(): boolean {?

typescript aurelia

Answer 1

Answer №1

It is required that the step includes a method called run which should return a Promise representing a navigation result.

export class MyStep {
  run(routingContext, next) {

    // perform tasks here!

    return next();
  }
}

in another part of the code:

this.router.configure(config => 
  config.addPipelineStep('authorize', new MyStep ()));

The navigation result object consists of an attribute called completed and/or an attribute called output. The value of result.output can either be an Error or an object with a method named navigate.

For more information on what is expected from your step Promise by the router, refer to this link: https://github.com/aurelia/router/blob/34119d1ce827f10fe5d3c7c97133d83ad922eab6/src/app-router.js#L174

Answer 2

It is required that the step includes a method called run which should return a Promise representing a navigation result.

export class MyStep {
  run(routingContext, next) {

    // perform tasks here!

    return next();
  }
}

in another part of the code:

this.router.configure(config => 
  config.addPipelineStep('authorize', new MyStep ()));

The navigation result object consists of an attribute called completed and/or an attribute called output. The value of result.output can either be an Error or an object with a method named navigate.

For more information on what is expected from your step Promise by the router, refer to this link: https://github.com/aurelia/router/blob/34119d1ce827f10fe5d3c7c97133d83ad922eab6/src/app-router.js#L174

What are the appropriate method signatures to use in Aurelia's pipeline configuration?

Answer №1

Similar questions

Determining the data type of a property within an interface using TypeScript

Is it necessary to upload the node_modules folder to Bitbucket?

When choosing the child option, it starts acting abnormally if the parent option is already selected in Angular

Is there a method to ensure the strong typing of sagas for dispatching actions?

Utilize Array in Form Input with Index and Spread Operator

Combining two observables into one and returning it may cause Angular guards to malfunction

How can I effectively filter the data returned by consuming an API in JSON through an Angular service?

Transform a JSON array into an array of objects using typescript

What is the best way to update properties in a child component using React hooks?

When multiple input fields with an iterative design are using the same onChange() function, the specific event.target.values for each input

Creating a custom Object Type based on the values of an array of objects using Typescript

The Angular project seems to be experiencing technical difficulties following a recent update and is

A mistake has occurred: Unhandled promise rejection TypeError: Unable to assign the property 'devices' to an undefined object in Ionic 4 with Angular

"Encountered an error: Unable to interpret URL from (URL).vercel.app/api/getMessages" while deploying Next.js 13 using TypeScript on Vercel

Creating a function generator using a string parameter in TypeScript

employing a variable within a function that is nested within another function

Error code TS2749 is indicating that the identifier 'XXX' is being interpreted as a value instead of a type. Perhaps you intended to use 'typeof XXX' instead

Discovering the functionality of es6 object.assign and find methods within a typescript file

Leverage the power of mathematical functions within Angular to convert numbers into integers

Assign a specific value to the sub-component within the grid using Angular 2+