summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2020-07-12 13:16:57 -0700
committerMatthew Miller <matthew@millerti.me>2020-07-12 13:16:57 -0700
commit463a888331489872f4807c27d881041ffeab7e22 (patch)
tree5453524a181f773c47c89b758485d1e239470154
parent5122a9c772e6afd692671a014dd65622ecbdc382 (diff)
Clarify comments on MetadataService
-rw-r--r--packages/server/src/metadata/metadataService.ts7
1 files changed, 2 insertions, 5 deletions
diff --git a/packages/server/src/metadata/metadataService.ts b/packages/server/src/metadata/metadataService.ts
index 38ef21d..efbc53a 100644
--- a/packages/server/src/metadata/metadataService.ts
+++ b/packages/server/src/metadata/metadataService.ts
@@ -51,14 +51,11 @@ class MetadataService {
private state: SERVICE_STATE = SERVICE_STATE.DISABLED;
/**
- * Prepare the service to handle live data, or prepared data.
- *
- * If `process.env.ENABLE_MDS` is `'true'`, then the actual MDS API will be queried. Otherwise
- * known metadata statements can be provided as arguments.
+ * Prepare the service to handle remote MDS servers and/or cache local metadata statements.
*/
async initialize(opts: {
- statements?: MetadataStatement[];
mdsServers: Pick<CachedMDS, 'url' | 'rootCertURL' | 'metadataURLSuffix'>[];
+ statements?: MetadataStatement[];
}): Promise<void> {
if (!opts) {
throw new Error('MetadataService initialization options are missing');