From 7bd032512891eb17be1c195d0a0b21ba7d07b50f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Breitbart?= Date: Thu, 4 Jul 2019 12:42:43 +0200 Subject: [PATCH] remove example snippet from docs --- src/common/parser/Params.ts | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/src/common/parser/Params.ts b/src/common/parser/Params.ts index 1ded5dcf..8fd86afc 100644 --- a/src/common/parser/Params.ts +++ b/src/common/parser/Params.ts @@ -14,23 +14,6 @@ const MAX_SUBPARAMS = 256; * This type is used by the parser to accumulate sequence parameters and sub parameters * and transmit them to the input handler actions. * - * Usage in action handler: - * ```typescript - * function handler(params: IParams): void { - * for (let i = 0; i < params.length; ++i) { - * // get single param - * const param = params.params[i]; - * ... - * // check for sub params - * if (Params.hasSubParams(i)) { - * // get sub params - * const subparams = params.getSubParams(i); - * ... - * } - * } - * } - * ``` - * * NOTES: * - params object for action handlers is borrowed, use `.toArray` or `.clone` to get a copy * - never read beyond `params.length - 1` (likely to contain arbitrary data)