HeadersPattern: HeadersPattern

In webmockr: Stubbing and Setting Expectations on 'HTTP' Requests

HeadersPattern

Description

headers matcher

Details

webmockr normalises headers and treats all forms of same headers as equal: i.e the following two sets of headers are equal: list(Header1 = "value1", content_length = 123, X_CuStOm_hEAder = "foo") and list(header1 = "value1", "Content-Length" = 123, "x-cuSTOM-HeAder" = "foo")

Public fields

pattern

a list

Methods

Public methods

• HeadersPattern$new()

• HeadersPattern$matches()

• HeadersPattern$empty_headers()

• HeadersPattern$to_s()

• HeadersPattern$clone()

---

Method new()

Create a new HeadersPattern object

Usage

HeadersPattern$new(pattern)

Arguments

pattern

(list) a pattern, as a named list, must be named, e.g,. list(a = 5, b = 6)

Returns

A new HeadersPattern object

---

Method matches()

Match a list of headers against that stored

Usage

HeadersPattern$matches(headers)

Arguments

headers

(list) named list of headers, e.g,. list(a = 5, b = 6)

Returns

a boolean

---

Method empty_headers()

Are headers empty? tests if null or length==0

Usage

HeadersPattern$empty_headers(headers)

Arguments

headers

named list of headers

Returns

a boolean

---

Method to_s()

Print pattern for easy human consumption

Usage

HeadersPattern$to_s()

Returns

a string

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HeadersPattern$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

(x <- HeadersPattern$new(pattern = list(a = 5)))
x$pattern
x$matches(list(a = 5))

# different cases
(x <- HeadersPattern$new(pattern = list(Header1 = "value1")))
x$pattern
x$matches(list(header1 = "value1"))
x$matches(list(header1 = "value2"))

# different symbols
(x <- HeadersPattern$new(pattern = list(`Hello_World` = "yep")))
x$pattern
x$matches(list(`hello-world` = "yep"))
x$matches(list(`hello-worlds` = "yep"))

headers <- list(
  "User-Agent" = "Apple",
  "Accept-Encoding" = "gzip, deflate",
  "Accept" = "application/json, text/xml, application/xml, */*"
)
(x <- HeadersPattern$new(pattern = headers))
x$to_s()
x$pattern
x$matches(headers)

webmockr documentation built on April 4, 2025, 12:08 a.m.