Headers

Mô tả

Một đối tượng Headers có một danh sách header liên kết, ban đầu rỗng và gồm không hoặc nhiều cặp tên-giá trị. Bạn có thể thêm vào danh sách này bằng các phương thức như append() (xem Ví dụ). Trong mọi phương thức của giao diện này, tên header được so khớp theo chuỗi byte không phân biệt hoa thường.

Một object triển khai Headers có thể được dùng trực tiếp trong cấu trúc for...of thay vì entries(): for (const p of myHeaders) tương đương với for (const p of myHeaders.entries()).

Hạn chế sửa đổi

Một số đối tượng Headers có hạn chế đối với việc các phương thức set(), delete() và append() có thể sửa đổi header hay không. Các hạn chế này được thiết lập tùy theo cách đối tượng Headers được tạo.

• Với header được tạo bằng constructor Headers(), không có hạn chế sửa đổi nào.
• Với header của đối tượng Request:
  • Nếu mode của request là no-cors, bạn có thể sửa đổi mọi tên/giá trị của CORS-safelisted request header.
  • Nếu không, bạn có thể sửa đổi mọi tên/giá trị của non-forbidden request header.
• Với header của đối tượng Response:
  • Nếu response được tạo bằng Response.error() hoặc Response.redirect(), hoặc được nhận từ một lời gọi fetch(), các header là bất biến và không thể sửa đổi.
  • Nếu không, nếu response được tạo bằng Response() hoặc Response.json(), bạn có thể sửa đổi mọi tên/giá trị của non-forbidden response header.

Tất cả các phương thức của Headers sẽ ném ra TypeError nếu bạn cố truyền vào một tham chiếu đến tên không phải là tên HTTP header hợp lệ. Các thao tác sửa đổi sẽ ném TypeError nếu header là bất biến. Trong mọi trường hợp thất bại khác, chúng sẽ thất bại một cách lặng lẽ.

Constructor

Headers()

Tạo một đối tượng Headers mới.

Phương thức thể hiện

Headers.append()

Thêm một giá trị mới vào một header hiện có bên trong đối tượng Headers, hoặc thêm header nếu nó chưa tồn tại.

Headers.delete()

Xóa một header khỏi đối tượng Headers.

Headers.entries()

Trả về một iterator cho phép duyệt qua tất cả các cặp khóa/giá trị chứa trong đối tượng này.

Headers.forEach()

Thực thi một hàm được cung cấp một lần cho mỗi cặp khóa/giá trị trong đối tượng Headers này.

Headers.get()

Trả về một chuỗi byte của tất cả các giá trị của một header trong đối tượng Headers với tên đã cho.

Headers.getSetCookie()

Trả về một mảng chứa các giá trị của tất cả header Set-Cookie gắn với một response.

Headers.has()

Trả về giá trị boolean cho biết một đối tượng Headers có chứa một header nhất định hay không.

Headers.keys()

Trả về một iterator cho phép bạn duyệt qua tất cả các khóa của các cặp khóa/giá trị chứa trong đối tượng này.

Headers.set()

Đặt một giá trị mới cho một header hiện có bên trong đối tượng Headers, hoặc thêm header nếu nó chưa tồn tại.

Headers.values()

Trả về một iterator cho phép bạn duyệt qua tất cả các giá trị của các cặp khóa/giá trị chứa trong đối tượng này.

Ví dụ

Trong đoạn mã sau, chúng ta tạo một header mới bằng constructor Headers(), thêm một header mới vào đó bằng append(), rồi trả về giá trị header đó bằng get():

const myHeaders = new Headers();

myHeaders.append("Content-Type", "text/xml");
myHeaders.get("Content-Type"); // should return 'text/xml'

Ta cũng có thể thực hiện điều tương tự bằng cách truyền một mảng các mảng hoặc một object literal vào constructor:

let myHeaders = new Headers({
  "Content-Type": "text/xml",
});

// or, using an array of arrays:
myHeaders = new Headers([["Content-Type", "text/xml"]]);

myHeaders.get("Content-Type"); // should return 'text/xml'

Thông số kỹ thuật

Tương thích trình duyệt

Xem thêm

• ServiceWorker API
• HTTP access control (CORS)
• HTTP