From e0f533b469b29a99d6039b07a0ac737ad0031e9e Mon Sep 17 00:00:00 2001 From: Jorge Shirai Date: Wed, 15 Jan 2020 15:24:32 +0100 Subject: [PATCH] Require logger argument in Aquarius constructor. Improve Aquarius constructor comment/documentation. --- src/aquarius/Aquarius.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/aquarius/Aquarius.ts b/src/aquarius/Aquarius.ts index d6984f8..cd52a2f 100644 --- a/src/aquarius/Aquarius.ts +++ b/src/aquarius/Aquarius.ts @@ -22,7 +22,7 @@ export interface SearchQuery { } /** - * Provides a interface with Aquarius. + * Provides an interface with Aquarius. * Aquarius provides an off-chain database store for metadata about data assets. */ export class Aquarius { @@ -34,7 +34,12 @@ export class Aquarius { return this.aquariusUri } - constructor(aquariusUri: string, logger?: Logger) { + /** + * Instantiate Aquarius (independently of Ocean) for off-chain interaction. + * @param {String} aquariusUri + * @param {Logger} logger + */ + constructor(aquariusUri: string, logger: Logger) { this.fetch = new WebServiceConnector(logger) this.logger = logger this.aquariusUri = aquariusUri