@twin.org/node-core 0.0.1-next.10
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/LICENSE +201 -0
- package/README.md +21 -0
- package/dist/cjs/index.cjs +1718 -0
- package/dist/esm/index.mjs +1681 -0
- package/dist/types/bootstrap.d.ts +59 -0
- package/dist/types/builders/engineEnvBuilder.d.ts +8 -0
- package/dist/types/builders/engineServerEnvBuilder.d.ts +13 -0
- package/dist/types/index.d.ts +10 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +389 -0
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +45 -0
- package/dist/types/models/INodeEnvironmentVariables.d.ts +29 -0
- package/dist/types/models/INodeOptions.d.ts +69 -0
- package/dist/types/models/nodeFeatures.d.ts +17 -0
- package/dist/types/node.d.ts +26 -0
- package/dist/types/server.d.ts +17 -0
- package/dist/types/utils.d.ts +30 -0
- package/docs/changelog.md +76 -0
- package/docs/examples.md +1 -0
- package/docs/reference/functions/bootstrap.md +29 -0
- package/docs/reference/functions/bootstrapAttestationMethod.md +35 -0
- package/docs/reference/functions/bootstrapAuth.md +35 -0
- package/docs/reference/functions/bootstrapBlobEncryption.md +35 -0
- package/docs/reference/functions/bootstrapImmutableProofMethod.md +35 -0
- package/docs/reference/functions/bootstrapNodeIdentity.md +35 -0
- package/docs/reference/functions/bootstrapNodeUser.md +35 -0
- package/docs/reference/functions/buildConfiguration.md +30 -0
- package/docs/reference/functions/buildEngineConfiguration.md +19 -0
- package/docs/reference/functions/fileExists.md +19 -0
- package/docs/reference/functions/getExecutionDirectory.md +11 -0
- package/docs/reference/functions/getFeatures.md +19 -0
- package/docs/reference/functions/initialiseLocales.md +17 -0
- package/docs/reference/functions/loadJsonFile.md +25 -0
- package/docs/reference/functions/run.md +19 -0
- package/docs/reference/functions/start.md +31 -0
- package/docs/reference/index.md +35 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +775 -0
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +87 -0
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +1331 -0
- package/docs/reference/interfaces/INodeOptions.md +165 -0
- package/docs/reference/type-aliases/NodeFeatures.md +5 -0
- package/docs/reference/variables/NodeFeatures.md +19 -0
- package/locales/en.json +34 -0
- package/package.json +52 -0
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Interface: IEngineServerEnvironmentVariables
|
|
2
|
+
|
|
3
|
+
The engine server environment variables.
|
|
4
|
+
|
|
5
|
+
## Extended by
|
|
6
|
+
|
|
7
|
+
- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### port?
|
|
12
|
+
|
|
13
|
+
> `optional` **port**: `string`
|
|
14
|
+
|
|
15
|
+
The port to serve the API from.
|
|
16
|
+
|
|
17
|
+
***
|
|
18
|
+
|
|
19
|
+
### host?
|
|
20
|
+
|
|
21
|
+
> `optional` **host**: `string`
|
|
22
|
+
|
|
23
|
+
The host to serve the API from.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### corsOrigins?
|
|
28
|
+
|
|
29
|
+
> `optional` **corsOrigins**: `string`
|
|
30
|
+
|
|
31
|
+
The CORS origins to allow, defaults to *.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### httpMethods?
|
|
36
|
+
|
|
37
|
+
> `optional` **httpMethods**: `string`
|
|
38
|
+
|
|
39
|
+
The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### httpAllowedHeaders?
|
|
44
|
+
|
|
45
|
+
> `optional` **httpAllowedHeaders**: `string`
|
|
46
|
+
|
|
47
|
+
The CORS headers to allow.
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### httpExposedHeaders?
|
|
52
|
+
|
|
53
|
+
> `optional` **httpExposedHeaders**: `string`
|
|
54
|
+
|
|
55
|
+
The CORS headers to expose.
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### authProcessorType?
|
|
60
|
+
|
|
61
|
+
> `optional` **authProcessorType**: `string`
|
|
62
|
+
|
|
63
|
+
The type of auth processor to use on the API: entity-storage.
|
|
64
|
+
|
|
65
|
+
***
|
|
66
|
+
|
|
67
|
+
### authSigningKeyId?
|
|
68
|
+
|
|
69
|
+
> `optional` **authSigningKeyId**: `string`
|
|
70
|
+
|
|
71
|
+
The id of the key in the vault to use for signing in auth operations.
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### mimeTypeProcessors?
|
|
76
|
+
|
|
77
|
+
> `optional` **mimeTypeProcessors**: `string`
|
|
78
|
+
|
|
79
|
+
Additional MIME type processors to include, comma separated.
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### disableNodeIdentity?
|
|
84
|
+
|
|
85
|
+
> `optional` **disableNodeIdentity**: `string`
|
|
86
|
+
|
|
87
|
+
Disable Node Identity route processors.
|