JavaScript метод document.writeln()

Определение и применение

JavaScript метод .writeln() объекта document записывает в поток документа строку текста за которой следует символ новой строки. Чтобы открыть поток для записи документа необходимо воспользоваться методом open() объекта document.

Для завершения записи документа (закрыть поток открытый с помощью метода .open() объекта document) необходимо воспользоваться методом close() объекта document.

Данные в поток могут быть переданы также с помощью метода write(). Основное отличие методов write() и .writeln() заключается в том, что метод .writeln() дополнительно добавляет символ новой строки.

Имейте в виду, что если документ существует, то метод open() очистит его содержимое (автоматический вызов метода open() объекта document происходит когда методы write(), или .writeln() вызываются после загрузки страницы, это поведение определено в HTML Standard).

Методы write() и .writeln() объекта document не работают в документах XHTML, и игнорируются в асинхронных и отложенных (deferred) скриптах.

Поддержка браузерами

Устарела

Спецификация: multipage

Поддерживается во всех основных браузерах с 2020 года.

Показать браузеры
Совместимостьapi.Document.writeln
ВозможностьКомпьютерыМобильные
ChromeEdgeFirefoxOperaSafariChrome AndroidFirefox for AndroidOpera AndroidSafari on iOSSamsung BrowserWebView AndroidWebView on iOS
writeln✓45✓12✓69✓51✓11✓45✓79✓47✓11✓5.0✓45✓11
Requires TrustedHTML instance when trusted types are enforced✓86✓86✓148✓72✓26✓86✓148✓61✓26✓14.0✓86✓26

поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31

JavaScript синтаксис

JavaScript
document.writeln(exp1, exp2, ...expN);

Спецификация

HTML Standard.

Значения параметров

Параметры document.writeln()
Параметр Описание
exp1, exp2, ...expN Текстовое содержимое, которое будет добавлено в поток. Допускается указать несколько аргументов через запятую, данные в аргументах будут добавлены в документ в порядке их нахождения. Необязательный параметр.

Пример старого кода

Пример создания документа в новом окне

Статический листинг: пример открывает новое окно через window.open(), а учебный раннер не открывает окна. Скопируйте код в отдельный HTML-документ, чтобы запустить его.

Исходный код для изучения. Запуск на этой странице недоступен.

index.html
HTML
<button data-migration-click-0="">Нажми меня</button>
main.js
JavaScript
function myFunc() {
    let newWindow = window.open(),
        newWindowDocument = newWindow.document

    newWindowDocument.open('text/html', 'replace')
    newWindowDocument.write('<html><head><title>My document</title></head><body>')
    newWindowDocument.write('<h1>Hello</h1>')
    newWindowDocument.write('<pre>')

    newWindowDocument.write('1')
    newWindowDocument.write('2')
    newWindowDocument.write('3<br>')

    newWindowDocument.writeln('1')
    newWindowDocument.writeln('2')
    newWindowDocument.writeln('3')

    newWindowDocument.write('</pre>')
    newWindowDocument.write('</body></html>')
    newWindowDocument.close()
}

// Обработчики кнопок перенесены из HTML для запуска с CSP без inline-скриптов.
document.querySelector('[data-migration-click-0]').addEventListener('click', function () {
    myFunc()
})
document.querySelector('[data-migration-click-0]').removeAttribute('data-migration-click-0')

В этом примере с использованием метода addEventListener() при нажатии на кнопку (HTML элемент <button>) вызываем функцию myFunc(), которая с использованием JavaScript метода .open() объекта window открывает новое окно браузера, а с помощью метода .open() объекта document открывает поток для записи этого документа. В этот документ с помощью методов write() и .writeln() записываем в поток необходимые строки текста.

Основное отличие методов write() и .writeln() заключается в том, что метод .writeln() дополнительно добавляет символ новой строки. Это полезно, например, при работе с HTML элементом <pre>, который сохраняет как пробелы, так и разрывы строк.

После того как мы записали в документ необходимое текстовое содержимое, мы с помощью метода close() объекта document закрываем поток открытый с помощью метода .open() объекта document.

Обратите внимание, что мы дополнительно передали в метод .open() объекта document два аргумента: "text/html" и "replace". Это исторический синтаксис: раньше первый аргумент задавал тип документа, а второй — замену записи в истории браузера. Современная спецификация игнорирует оба аргумента, поэтому вызов document.open() без аргументов работает так же.

Результат нашего примера:

Пример создания документа в новом окне
Пример создания документа в новом окне