loggedin-mixin

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 23 Open GitHub ↗

A simple logged-in and roles check minxin to use with mdg:validated-method package

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# loggedin-mixin

## Install

```sh
$ meteor add tunifight:loggedin-mixin
```

## Usage

```js
// Method definition
const method = new ValidatedMethod({
  name, // DDP method name
  mixins : [LoggedInMixin],
  checkLoggedInError: {
    error: 'notLogged',
    message: 'You need to be logged in to call this method',//Optional
    reason: 'You need to login' //Optional
  },
  validate, // argument validation
  run // Method body
});
```

The LoggedInMixin mixin requires the new `checkLoggedInError` option which includes
the required informations to throw an Error. Note that `message` and `reason` are optional.

## Roles check
If you are using `alanning:roles` package in your application, you can add
roles check to the basic logged-in check.

For that, you need to add the new `checkRoles` option which includes the required
informations about `roles`, `group` and the error to throw.

```js
// Method definition
const method = new ValidatedMethod({
  name, // DDP method name
  mixins : [LoggedInMixin],
  checkRoles: {
    roles: ['admin'],
    group: 'group1', // Optional
    rolesError: {
      error: 'not-allowed',
      message: 'You are not allowed to call this method',//Optional
      reason: 'You are not allowed to call this method' //Optional
    }
  }
  checkLoggedInError: {
    error: 'notLogged',
    message: 'You need to be logged in to call this method',//Optional
    reason: 'You need to login' //Optional
  },
  validate, // argument validation
  run // Method body
});
```

loggedin-mixin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README