Аргумент в виде массива в документации функций - PullRequest
Новая
       6

Аргумент в виде массива в документации функций

0 голосов
/ 26 января 2019

Извините, если мой вопрос глуп, все мы видели много аргументов функций для методов, задокументированных как это

redis.createClient(port[, host][, options])

Я не могу понять, как это работает port и почему host аргумент находится в массиве и начинается с ,.Выше приведен фрагмент от

https://github.com/NodeRedis/node_redis

Спасибо

1 Ответ

0 голосов
/ 26 января 2019

Это не массив. Квадратные скобки обычно используются таким образом, чтобы указывать необязательные параметры.

В основном это означает, что вы можете использовать его как одно из следующих:

  • redis.createClient(port)
  • redis.createClient(port, host)
  • redis.createClient(port, options)
  • redis.createClient(port, host, options)

Иногда вместо этого используется обозначение redis.createClient(port[, host[, options]]), что означает, что его нельзя использовать как redis.createClient(port, options).

Аналогичные обозначения также используются при документировании команд. (например, из ls руководство: ls [OPTION]... [FILE]...)

...