From 522b2fca620dcc89b410d5a4af6dfb5ac0790a6d Mon Sep 17 00:00:00 2001 From: Alexander Cerutti Date: Wed, 14 Aug 2019 15:51:04 +0200 Subject: [PATCH] Added comments --- src/abstract.ts | 6 ++++++ src/factory.ts | 8 ++++++++ 2 files changed, 14 insertions(+) diff --git a/src/abstract.ts b/src/abstract.ts index 7f76d15..699e7a0 100644 --- a/src/abstract.ts +++ b/src/abstract.ts @@ -16,6 +16,12 @@ interface AbstractModelOptions { overrides?: OverridesSupportedOptions; } +/** + * Creates an abstract model to keep data + * in memory for future passes creation + * @param options + */ + export async function createAbstractModel(options: AbstractFactoryOptions) { if (!(options && Object.keys(options).length)) { throw new Error(formatMessage("CP_NO_OPTS")); diff --git a/src/factory.ts b/src/factory.ts index 988b4e9..9c92ac2 100644 --- a/src/factory.ts +++ b/src/factory.ts @@ -5,6 +5,14 @@ import { getModelContents, readCertificatesFromOptions } from "./parser"; import { splitBufferBundle } from "./utils"; import { AbstractModel, AbstractFactoryOptions } from "./abstract"; +/** + * Creates a new Pass instance. + * + * @param options Options to be used to create the instance or an Abstract Model reference + * @param additionalBuffers More buffers (with file name) to be added on runtime (if you are downloading some files from the web) + * @param abstractMissingData Additional data for abstract models, that might vary from pass to pass. + */ + export async function createPass( options: FactoryOptions | AbstractModel, additionalBuffers?: BundleUnit,