docs: optionalInteger|String|Duration (#8729)
Marcin Rataj committed
Feb 10, 2022 at 23:52 UTC
f9643a61d73ac300db8c915cdac750436c6d8674
1 file changed
+23
-3
docs/config.md
+23
-3
@@ -16,6 +16,8 @@ config file at runtime.
16
- [`strings`](#strings)
17
- [`duration`](#duration)
18
- [`optionalInteger`](#optionalinteger)
19
+ - [`optionalString`](#optionalstring)
20
+ - [`optionalDuration`](#optionalduration)
21
- [`Addresses`](#addresses)
22
- [`Addresses.API`](#addressesapi)
23
- [`Addresses.Gateway`](#addressesgateway)
@@ -270,12 +272,30 @@ does (e.g, `"1d2h4m40.01s"`).
272
273
### `optionalInteger`
274
273
-Optional Integers allow specifying some numerical value which has
274
-an implicit default when `null` or missing from the config file:
275
+Optional integers allow specifying some numerical value which has
276
+an implicit default when missing from the config file:
277
276
-- `null`/missing (apply the default value defined in go-ipfs sources)
278
+- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault(value)`)
279
- an integer between `-2^63` and `2^63-1` (i.e. `-9223372036854775808` to `9223372036854775807`)
280
281
+
282
+### `optionalString`
283
+
284
+Optional strings allow specifying some string value which has
285
+an implicit default when missing from the config file:
286
+
287
+- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("value")`)
288
+- a string
289
+
290
+
291
+### `optionalDuration`
292
+
293
+Optional durations allow specifying some duration value which has
294
+an implicit default when missing from the config file:
295
+
296
+- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("1h2m3s")`)
297
+- a string with a valid [go duration](#duration) (e.g, `"1d2h4m40.01s"`).
298
+
299
## `Addresses`
300
301
Contains information about various listener addresses to be used by this node.