Jak czytać MDN i dokumentację API
Rozkładamy typowe frazy i strukturę stron docs
Фрази що зустрічаються в кожній документації
| Фраза | Переклад |
|---|---|
| Returns a string | Повертає рядок |
| Throws an error | Кидає помилку |
| Accepts / Takes a parameter | Приймає параметр |
| Optional parameter | Необов'язковий параметр |
| Defaults to null | За замовчуванням дорівнює null |
| Deprecated | Застаріле (не використовуй) |
| See also | Дивись також |
| Since version 2.0 | Доступно з версії 2.0 |
| Note: | Примітка: |
| Warning: | Увага: |
Deprecated — це важливо!
Deprecated (депрекейтед) — як «зняти з виробництва». Функція ще працює, але скоро зникне. Якщо бачиш це слово в документації — шукай сучасну альтернативу. Зазвичай docs напишуть 'Use X instead' — використовуй X замість цього.
Типова структура опису функції в MDN
''' Array.prototype.map()
The map() method creates a new array populated with the results of calling a provided function on every element in the calling array.
Syntax map(callbackFn) map(callbackFn, thisArg)
Parameters callbackFn — A function to execute for each element. thisArg (Optional) — A value to use as this.
Return value A new array with each element being the result of the callback function. '''
Переклад: 'map()' — метод масиву. Приймає функцію 'callbackFn' (обов'язково) і 'thisArg' (необов'язково). Повертає новий масив.
Читаючи документацію, шукай Returns і Parameters — це головне.