@twin.org/logging-rest-client 0.0.1-next.6 → 0.0.1-next.8
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
|
@@ -20,7 +20,9 @@ Create a new instance of LoggingClient.
|
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
##### config
|
|
24
|
+
|
|
25
|
+
`IBaseRestClientConfig`
|
|
24
26
|
|
|
25
27
|
The configuration for the client.
|
|
26
28
|
|
|
@@ -54,7 +56,9 @@ Log an entry to the connector.
|
|
|
54
56
|
|
|
55
57
|
#### Parameters
|
|
56
58
|
|
|
57
|
-
|
|
59
|
+
##### logEntry
|
|
60
|
+
|
|
61
|
+
`ILogEntry`
|
|
58
62
|
|
|
59
63
|
The entry to log.
|
|
60
64
|
|
|
@@ -72,55 +76,55 @@ Nothing.
|
|
|
72
76
|
|
|
73
77
|
### query()
|
|
74
78
|
|
|
75
|
-
> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise
|
|
79
|
+
> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
|
|
76
80
|
|
|
77
81
|
Query the log entries.
|
|
78
82
|
|
|
79
83
|
#### Parameters
|
|
80
84
|
|
|
81
|
-
|
|
85
|
+
##### level?
|
|
86
|
+
|
|
87
|
+
`LogLevel`
|
|
82
88
|
|
|
83
89
|
The level of the log entries.
|
|
84
90
|
|
|
85
|
-
|
|
91
|
+
##### source?
|
|
92
|
+
|
|
93
|
+
`string`
|
|
86
94
|
|
|
87
95
|
The source of the log entries.
|
|
88
96
|
|
|
89
|
-
|
|
97
|
+
##### timeStart?
|
|
98
|
+
|
|
99
|
+
`number`
|
|
90
100
|
|
|
91
101
|
The inclusive time as the start of the log entries.
|
|
92
102
|
|
|
93
|
-
|
|
103
|
+
##### timeEnd?
|
|
104
|
+
|
|
105
|
+
`number`
|
|
94
106
|
|
|
95
107
|
The inclusive time as the end of the log entries.
|
|
96
108
|
|
|
97
|
-
|
|
109
|
+
##### cursor?
|
|
110
|
+
|
|
111
|
+
`string`
|
|
98
112
|
|
|
99
113
|
The cursor to request the next page of entities.
|
|
100
114
|
|
|
101
|
-
|
|
115
|
+
##### pageSize?
|
|
116
|
+
|
|
117
|
+
`number`
|
|
102
118
|
|
|
103
119
|
The maximum number of entities in a page.
|
|
104
120
|
|
|
105
121
|
#### Returns
|
|
106
122
|
|
|
107
|
-
`Promise
|
|
123
|
+
`Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
|
|
108
124
|
|
|
109
125
|
All the entities for the storage matching the conditions,
|
|
110
126
|
and a cursor which can be used to request more entities.
|
|
111
127
|
|
|
112
|
-
##### entities
|
|
113
|
-
|
|
114
|
-
> **entities**: `ILogEntry`[]
|
|
115
|
-
|
|
116
|
-
The entities, which can be partial if a limited keys list was provided.
|
|
117
|
-
|
|
118
|
-
##### cursor?
|
|
119
|
-
|
|
120
|
-
> `optional` **cursor**: `string`
|
|
121
|
-
|
|
122
|
-
An optional cursor, when defined can be used to call find to get more entities.
|
|
123
|
-
|
|
124
128
|
#### Throws
|
|
125
129
|
|
|
126
130
|
NotImplementedError if the implementation does not support retrieval.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/logging-rest-client",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.8",
|
|
4
4
|
"description": "Logging contract implementation which can connect to REST endpoints",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"@twin.org/api-models": "next",
|
|
19
19
|
"@twin.org/core": "next",
|
|
20
20
|
"@twin.org/entity": "next",
|
|
21
|
-
"@twin.org/logging-models": "0.0.1-next.
|
|
21
|
+
"@twin.org/logging-models": "0.0.1-next.8",
|
|
22
22
|
"@twin.org/nameof": "next"
|
|
23
23
|
},
|
|
24
24
|
"main": "./dist/cjs/index.cjs",
|