Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(Guards): Improve guards API based on common usage #62

Merged
merged 1 commit into from
Apr 22, 2016

Conversation

MikeRyanDev
Copy link
Member

Change guard factory from createGuard to provideGuard to clarify what the factory is doing. Re-order guard params to receive route params first.

BREAKING CHANGE:

Before:

  const auth = createGuard(function(http: Http) {

    return function(route: Route, params: any, isTerminal: boolean) {
      return http.get(...);
    };

  }, [ Http ]);

After:

  const auth = provideGuard(function(http: Http) {

    return function(params: any, route: Route, isTerminal: boolean) {
      return http.get(...);
    };

  }, [ Http ]);

Change guard factory from `createGuard` to `provideGuard` to clarify what the factory is doing. Re-order guard params to receive route params first.

BREAKING CHANGE:

  Before:
  ```ts
  const auth = createGuard(function(http: Http) {

    return function(route: Route, params: any, isTerminal: boolean) {
      return http.get(...);
    };

  }, [ Http ]);
  ```

  After:
  ```ts
  const auth = provideGuard(function(http: Http) {

    return function(params: any, route: Route, isTerminal: boolean) {
      return http.get(...);
    };

  }, [ Http ]);
  ```
@brandonroberts
Copy link
Member

Docs need updating also

@brandonroberts
Copy link
Member

Docs will be updated before next release

@brandonroberts brandonroberts merged commit 1ea2806 into ngrx:master Apr 22, 2016
@MikeRyanDev MikeRyanDev deleted the refactor/guards-api branch April 25, 2016 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants