Class Patch

Parse the given XML patch document, according to RFC 5261.

Hierarchy

Patch

Index

Constructors

constructor

Properties

SupportedActions

Accessors

Methods

Constructors

constructor

new Patch(patch?: string | XmlWrapper): Patch

- Defined in src/patch/patch.ts:57
Parameters
- Optional patch: string | XmlWrapper
  
  This can be an XML string, of a XmlWrapper instance.
Returns Patch

Properties

Static SupportedActions

SupportedActions: string[] = ['add', 'remove', 'replace']

List of defined patch directives (actions).

Accessors

actions

get actions(): (null | Action)[]

- Defined in src/patch/patch.ts:48
List of actions to be performed.

Returns (null | Action)[]

encoding

get encoding(): string

- Defined in src/patch/patch.ts:55
Encoding of the load XML.

Returns string

Methods

apply

apply(xml: string | XmlWrapper): Patch

- Defined in src/patch/patch.ts:85
Applies the patch to target document.

Parameters
- xml: string | XmlWrapper
  
  the target XML document
Returns Patch

load

load(patch: string | XmlWrapper): Patch

- Defined in src/patch/patch.ts:73
Parameters
- patch: string | XmlWrapper
  
  can be an XML string, of a XmlWrapper instance.
Returns Patch

this instance

lookupNamespaceURI

lookupNamespaceURI(prefix: string | null, node?: NodeImpl): string | null

- Defined in src/patch/patch.ts:100
Pass through to underlining XML document's XmlWrapper.lookupNamespaceURI

Parameters
- prefix: string | null
- Optional node: NodeImpl
  
  the node to be looked up
Returns string | null

lookupPrefix

lookupPrefix(uri: string | null, node?: NodeImpl): string | null

- Defined in src/patch/patch.ts:109
Pass through to underlining XML document's XmlWrapper.lookupPrefix

Parameters
- uri: string | null
- Optional node: NodeImpl
  
  the node to be looked up
Returns string | null

toLocaleString

toLocaleString(options?: FormatOptions): string

- Defined in src/patch/patch.ts:117
Parameters
- Optional options: FormatOptions
Returns string

toString

toString(options?: FormatOptions): string

- Defined in src/patch/patch.ts:113
Parameters
- Optional options: FormatOptions
Returns string

Generated using TypeDoc