@twin.org/api-auth-entity-storage-models 0.0.1-next.25 → 0.0.1-next.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/changelog.md
CHANGED
|
@@ -10,34 +10,30 @@ Contract definition for authentication component.
|
|
|
10
10
|
|
|
11
11
|
### login()
|
|
12
12
|
|
|
13
|
-
> **login**(`email`, `password`): `Promise
|
|
13
|
+
> **login**(`email`, `password`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
|
|
14
14
|
|
|
15
15
|
Perform a login for the user.
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
##### email
|
|
20
|
+
|
|
21
|
+
`string`
|
|
20
22
|
|
|
21
23
|
The email address for the user.
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
##### password
|
|
26
|
+
|
|
27
|
+
`string`
|
|
24
28
|
|
|
25
29
|
The password for the user.
|
|
26
30
|
|
|
27
31
|
#### Returns
|
|
28
32
|
|
|
29
|
-
`Promise
|
|
33
|
+
`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
|
|
30
34
|
|
|
31
35
|
The authentication token for the user, if it uses a mechanism with public access.
|
|
32
36
|
|
|
33
|
-
##### token?
|
|
34
|
-
|
|
35
|
-
> `optional` **token**: `string`
|
|
36
|
-
|
|
37
|
-
##### expiry
|
|
38
|
-
|
|
39
|
-
> **expiry**: `number`
|
|
40
|
-
|
|
41
37
|
***
|
|
42
38
|
|
|
43
39
|
### logout()
|
|
@@ -48,7 +44,9 @@ Logout the current user.
|
|
|
48
44
|
|
|
49
45
|
#### Parameters
|
|
50
46
|
|
|
51
|
-
|
|
47
|
+
##### token?
|
|
48
|
+
|
|
49
|
+
`string`
|
|
52
50
|
|
|
53
51
|
The token to logout, if it uses a mechanism with public access.
|
|
54
52
|
|
|
@@ -62,26 +60,20 @@ Nothing.
|
|
|
62
60
|
|
|
63
61
|
### refresh()
|
|
64
62
|
|
|
65
|
-
> **refresh**(`token`?): `Promise
|
|
63
|
+
> **refresh**(`token`?): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
|
|
66
64
|
|
|
67
65
|
Refresh the token.
|
|
68
66
|
|
|
69
67
|
#### Parameters
|
|
70
68
|
|
|
71
|
-
|
|
69
|
+
##### token?
|
|
70
|
+
|
|
71
|
+
`string`
|
|
72
72
|
|
|
73
73
|
The token to refresh, if it uses a mechanism with public access.
|
|
74
74
|
|
|
75
75
|
#### Returns
|
|
76
76
|
|
|
77
|
-
`Promise
|
|
77
|
+
`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
|
|
78
78
|
|
|
79
79
|
The refreshed token, if it uses a mechanism with public access.
|
|
80
|
-
|
|
81
|
-
##### token?
|
|
82
|
-
|
|
83
|
-
> `optional` **token**: `string`
|
|
84
|
-
|
|
85
|
-
##### expiry
|
|
86
|
-
|
|
87
|
-
> **expiry**: `number`
|
package/package.json
CHANGED