Как читать документацию по node.js?

Question

[dron112]

Если тут есть опытный бэкенд-js разработчики, то подскажи по поводу официальной документации node.js.
Пример: я хочу узнать про метод fs.writeFile(), какие параметры он принимает. Я перехожу на официальный сайт и нахожу этот метод.

И почему там не указано, что
первый параметр - это имя файла который нужно создать,
второй параметр - это данные которые нужно записать,
а третий - это коллбэк

Но на неофициальных сайтах эти моменты расписаны более подробно.

Почему пишут такую документацию?

Comments

[shurshur]

На "неофициальных сайтах" разжёвывают до уровня мягкой пюрешки тем, кто не смог сам понять.

[Роман]

shurshur, ну тут другое, по обоим ссылкам приведенным ТС основные части описания метода fs.writeFile() идентичны. Просто автор на оф сайте вместо описания метода fs.writeFile() смотрит описание filehandle.writeFile(data, options) и удивляется (видимо не умеет пользоваться оглавлением или по невнимательности ткнул не по той ссылке)))

Answer 1

[Роман]

на официальномй сайте, проматываю чуть ниже и вижу

fs.writeFile(file, data[, options], callback)#
History:

• file <string> | <Buffer> | <URL> | <integer> filename or file descriptor
  
• data

  <string> | <Buffer> | <TypedArray> | <DataView> | <Object>

  
  
• options <Object> | <string>
  • encoding <string> | <null> Default: 'utf8'
    
  • mode <integer> Default: 0o666
    
  • flag <string> See support of file system flags. Default: 'w'.
    
  • signal <AbortSignal> allows aborting an in-progress writeFile
    
  
  
• callback <Function>
  • err <Error> | <AggregateError>
    
  
  
  

When file is a filename, asynchronously writes data to the file, replacing the file if it already exists. data can be a string or a buffer.

When file is a file descriptor, the behavior is similar to calling fs.write() directly (which is recommended). See the notes below on using a file descriptor.

The encoding option is ignored if data is a buffer.

If data is a plain object, it must have an own (not inherited) toString function property.
...

откуда следует что:
первый параметр - это имя файла который нужно создать,
второй параметр - это данные которые нужно записать,
третий (необязательный) - это объект с опциями
а четвертый (или третий если предыдущий параметр не был указан) - это коллбэк

ЗЫ: уважаемый ТС, я понимаю что вопрос скорее всего был задан из-за вашей невнимательности, но тем не менее ответ вы получили, отметьте его решением)))

Вот вам способ быстро найти информацию на странице:
- открыв нужную страницу с большим объемом текста, перемотайте страницу в начала (до оглавления) и затем нажмите комбинацию кнопок CTRL+F (поиск по тексту страницы) и в появившемся окошке вбивайте искомый текст (в данном случае fs.write). После этого нужные пункты оглавления подсветятся желтым и вы легко найдете нужный.

Comments

[Османов Осман]

а что такое ТС?

[Роман]

Османов Осман, TC - (Топик Сендер) Topic Sender, другими словами в данном конкретном случае - автор вопроса

[goleon]

Роман, да это расписано. А вот насчет флагов ссылочку искать надо, про них отдельно. Меня очень напрягает, что везде где есть флаги, нет этой ссылочки.

[goleon]

Роман, dron112 если что в самом конце документации
https://nodejs.org/api/fs.html#fs_file_system_flags

[Роман]

goleon, я обычно даже не парюсь по этому поводу, просто ctrl+F и ищу "fs.wrireFile" или "flags" по оглавлению (желтым подсвечивает)

[shurshur]

Роман, всё-таки topic starter обычно.

[Роман]

shurshur, да, действительно, topic starter и topic creator наиболее часто встречающиеся)

[Игорь]

Роман вопрос у ТС скорее не в этом, наверное, был.
Какие, например, значения допустимы для encoding? Тут этого нет и приходится копаться дальше ...
https://github.com/nodejs/node/blob/master/lib/buf...

[Роман]

Игорь, даже не знаю что вам ответить. Приведу вам цитату того, что я вижу в вопросе автора:

Я перехожу на официальный сайт и нахожу этот метод.

И почему там не указано, что
первый параметр - это имя файла который нужно создать,
второй параметр - это данные которые нужно записать,
а третий - это коллбэк

Но на неофициальных сайтах эти моменты расписаны более подробно.

И на мой взгляд это однозначно говорит что вопрос у ТС абсолютно точно был в этом.

Но вы не стесняйтесь и поправьте меня если я вижу то чего нет. Если я не прав, то не поленюсь и сам схожу к окулисту

[Роман]

Игорь, ну и насчет encoding. Следующее легко находится на офсайте https://nodejs.org/en/knowledge/file-system/how-to...

encoding = (optional string) the encoding of the data. Possible encodings are 'ascii', 'utf8', and 'base64'. If no encoding provided, then 'utf8' is assumed.

[Игорь]

Роман, о том и речь, в описании API этого нет, ни в каком виде, и приходится искать дальше где-то еще

[Роман]

Игорь, но об этом в вопросе автора ни слова)