Function prop

prop<T extends AnyNode>(this: Cheerio<T>, name: "tagName" | "nodeName"): string
Method for getting and setting properties. Gets the property value for only the first element in the matched set.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: "tagName" | "nodeName"
  Name of the property.
Returns string
If value is specified the instance itself, otherwise the prop's value.
Example
```
$('input[type="checkbox"]').prop('checked');
//=> false

$('input[type="checkbox"]').prop('checked', true).val();
//=> ok
```
See
https://api.jquery.com/prop/
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:103
prop<T extends AnyNode>(
this: Cheerio<T>,
name: "innerHTML" | "outerHTML" | "innerText" | "textContent",
): string
Method for getting and setting properties. Gets the property value for only the first element in the matched set.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: "innerHTML" | "outerHTML" | "innerText" | "textContent"
  Name of the property.
Returns string
If value is specified the instance itself, otherwise the prop's value.
Example
```
$('input[type="checkbox"]').prop('checked');
//=> false

$('input[type="checkbox"]').prop('checked', true).val();
//=> ok
```
See
https://api.jquery.com/prop/
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:104
prop<T extends AnyNode>(this: Cheerio<T>, name: "style"): StyleProp
Get a parsed CSS style object.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: "style"
  Name of the property.
Returns StyleProp
The style object, or undefined if the element has no style attribute.
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:112
prop<T extends AnyNode>(this: Cheerio<T>, name: "href" | "src"): string
Resolve href or src of supported elements. Requires the baseURI option to be set, and a global URL object to be part of the environment.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: "href" | "src"
  Name of the property.
Returns string
The resolved URL, or undefined if the element is not supported.
Example: With `baseURI` set to `'https://example.com'`:
```
$('<img src="image.png">').prop('src');
//=> 'https://example.com/image.png'
```
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:127
prop<T extends AnyNode, K extends keyof Element>(
this: Cheerio<T>,
name: K,
): Element[K]
Get a property of an element.
Type Parameters
- T extends AnyNode
- K extends keyof Element
Parameters
- this: Cheerio<T>
- name: K
  Name of the property.
Returns Element[K]
The property's value.
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:134
prop<T extends AnyNode, K extends keyof Element>(
    this: Cheerio<T>,
    name: K,
    value:
        | Element[K]
        | (
            (
                this: Element,
                i: number,
                prop: K,
            ) =>
                | string
                | number
                | Document
                | Element
                | CDATA
                | Text
                | Comment
                | ProcessingInstruction
                | Record<string, string>
                | ChildNode[]
                | { [name: string]: string }
                | TagSourceCodeLocation
                | Attribute[]
                | (<T extends Node>(this: T, recursive?: boolean) => T)
        ),
): Cheerio<T>
Set a property of an element.
Type Parameters
- T extends AnyNode
- K extends keyof Element
Parameters
- this: Cheerio<T>
- name: K
  Name of the property.
- value:
      | Element[K]
      | (
          (
              this: Element,
              i: number,
              prop: K,
          ) =>
              | string
              | number
              | Document
              | Element
              | CDATA
              | Text
              | Comment
              | ProcessingInstruction
              | Record<string, string>
              | ChildNode[]
              | { [name: string]: string }
              | TagSourceCodeLocation
              | Attribute[]
              | (<T extends Node>(this: T, recursive?: boolean) => T)
      )
  Value to set the property to.
Returns Cheerio<T>
The instance itself.
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:142
prop<T extends AnyNode>(
this: Cheerio<T>,
map: Record<string, string | Element[keyof Element] | boolean>,
): Cheerio<T>
Set multiple properties of an element.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- map: Record<string, string | Element[keyof Element] | boolean>
  Object of properties to set.
Returns Cheerio<T>
The instance itself.
Example
```
$('input[type="checkbox"]').prop({
  checked: true,
  disabled: false,
});
```
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:158
prop<T extends AnyNode>(
    this: Cheerio<T>,
    name: string,
    value:
        | string
        | boolean
        | ((this: Element, i: number, prop: string) => string | boolean),
): Cheerio<T>
Set a property of an element.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: string
  Name of the property.
- value:
      | string
      | boolean
      | ((this: Element, i: number, prop: string) => string | boolean)
  Value to set the property to.
Returns Cheerio<T>
The instance itself.
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:166
prop<T extends AnyNode>(this: Cheerio<T>, name: string): string
Get a property of an element.
Type Parameters
- T extends AnyNode
Parameters
- this: Cheerio<T>
- name: string
  The property's name.
Returns string
The property's value.
- Defined in node_modules/cheerio/dist/esm/api/attributes.d.ts:173

Function prop

Type Parameters

Parameters

Returns string

Example

See

Type Parameters

Parameters

Returns string

Example

See

Type Parameters

Parameters

Returns StyleProp

Type Parameters

Parameters

Returns string

Example: With `baseURI` set to `'https://example.com'`:

Type Parameters

Parameters

Returns Element[K]

Type Parameters

Parameters

Returns Cheerio<T>

Type Parameters

Parameters

Returns Cheerio<T>

Example

Type Parameters

Parameters

Returns Cheerio<T>

Type Parameters

Parameters

Returns string

Settings