From 032355e73e8da0dc2fb0e0d43a1b82d4166d63a1 Mon Sep 17 00:00:00 2001 From: Nicolas DUBIEN Date: Wed, 27 Mar 2019 00:21:36 +0100 Subject: [PATCH] Document ipV4/ipV6 arbiraries --- documentation/Arbitraries.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/Arbitraries.md b/documentation/Arbitraries.md index faa4fe029dd..f3973a4a89e 100644 --- a/documentation/Arbitraries.md +++ b/documentation/Arbitraries.md @@ -63,11 +63,13 @@ Multiple characters: - `fc.fullUnicodeString()`, `fc.fullUnicodeString(maxLength: number)` or `fc.fullUnicodeString(minLength: number, maxLength: number)` string based on characters generated by `fc.fullUnicode()`. Be aware that the length is considered in terms of the number of glyphs in the string and not the number of UTF-16 characters - `fc.stringOf(charArb: Arbitrary)`, `fc.stringOf(charArb: Arbitrary, maxLength: number)` or `fc.stringOf(charArb: Arbitrary, minLength: number, maxLength: number)` string based on characters generated by `charArb`. `minLength` and `maxLength` define bounds of the number of elements generated using `charArb` that can be found in the final string -Strings that mimic real strings, with words and sentences: +More specific strings: - `fc.json()` or `fc.json(maxDepth: number)` json strings having keys generated using `fc.string()`. String values are also produced by `fc.string()` - `fc.unicodeJson()` or `fc.unicodeJson(maxDepth: number)` json strings having keys generated using `fc.unicodeString()`. String values are also produced by `fc.unicodeString()` - `fc.lorem()`, `fc.lorem(maxWordsCount: number)` or `fc.lorem(maxWordsCount: number, sentencesMode: boolean)` lorem ipsum strings. Generator can be configured by giving it a maximum number of characters by using `maxWordsCount` or switching the mode to sentences by setting `sentencesMode` to `true` in which case `maxWordsCount` is used to cap the number of sentences allowed +- `fc.ipV4()` IP v4 strings +- `fc.ipV6()` IP v6 strings ## Combinors of arbitraries (:T)