7.14.0 • Published 1 month ago

@enonic-types/lib-auth v7.14.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 month ago

Enonic XP lib-auth TS types

TypeScript definitions for lib-auth library of Enonic XP

Install

npm i --save-dev @enonic-types/lib-auth

Use

Require and custom imports

To make require work out of the box, you must install and add the @enonic-types/global types. Aside from providing definitions for XP global objects, e.g. log, app, __, etc, requiring a library by the default path will return typed object.

tsconfig.json

{
  "compilerOptions": {
    "types": [
      "@enonic-types/global"
    ]
  }
}

example.ts

const {login, logout, getUser, generatePassword} = require('/lib/xp/auth');

More detailed explanation on how it works and how to type custom import function can be found here.

ES6-style import

If you are planning to use import in your code and transpile it with the default tsc TypeScript compiler, you'll need to add proper types mapping to your configuration.

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "/lib/xp/auth": ["node_modules/@enonic-types/lib-auth"]
    }
  }
}

example.ts

import {login, logout, getUser, generatePassword} from '/lib/xp/auth';

Setting baseUrl and paths will allow the tsc to keep the valid paths in the resulting JavaScript files.

7.14.0

1 month ago

7.14.0-B3

1 month ago

7.14.0-RC1

1 month ago

7.14.0-B2

2 months ago

7.14.0-B1

2 months ago

7.13.5

3 months ago

7.13.3

5 months ago

7.13.4

4 months ago

7.13.1

7 months ago

7.13.2

7 months ago

7.13.0

8 months ago

7.13.0-RC1

8 months ago

7.13.0-B2

9 months ago

7.13.0-B3

8 months ago

7.13.0-B1

9 months ago

7.12.0-RC2

1 year ago

7.12.0-RC3

12 months ago

7.12.0-RC1

1 year ago

7.12.0-RC4

12 months ago

7.12.0-RC5

12 months ago

7.12.2

11 months ago

7.12.0

12 months ago

7.12.1

11 months ago

7.12.0-B1

1 year ago

7.11.3

1 year ago

7.11.1

1 year ago

7.11.2

1 year ago

7.11.0-RC1

1 year ago

7.11.0-RC3

1 year ago

7.11.0-RC4

1 year ago

7.11.0-B1

1 year ago

7.11.0-B3

1 year ago

7.11.0-B4

1 year ago

7.11.0

1 year ago

0.1.1

2 years ago

0.1.0

2 years ago