json-ptr - v3.0.1

Type aliases

Decoder

Decoder: (ptr: Pointer) => PathSegments

Type declaration

- (ptr: Pointer): PathSegments
- Parameters
  - ptr: Pointer
  Returns PathSegments

Dereference

Dereference: (it: unknown) => unknown

Type declaration

- (it: unknown): unknown
- Parameters
  - it: unknown
  Returns unknown

Encoder

Encoder: (ptr: PathSegments) => Pointer

Type declaration

- (ptr: PathSegments): Pointer
- Parameters
  - ptr: PathSegments
  Returns Pointer

JsonStringPointer

JsonStringPointer: string

PathSegment

PathSegment: string | number

PathSegments

PathSegments: PathSegment[]

Pointer

Pointer: JsonStringPointer | UriFragmentIdentifierPointer

RelativeJsonPointer

RelativeJsonPointer: string

UriFragmentIdentifierPointer

UriFragmentIdentifierPointer: string

Visitor

Visitor: (ptr: JsonStringPointer, val: unknown) => void

Type declaration

- (ptr: JsonStringPointer, val: unknown): void
- Signature of visitor functions, used with JsonPointer.visit method. Visitors are callbacks invoked for every segment/branch of a target's object graph.
  
  Tree descent occurs in-order, breadth first.
  
  Parameters
  - ptr: JsonStringPointer
  - val: unknown
  Returns void

Functions

compilePointerDereference

compilePointerDereference(path: PathSegments): Dereference

- Defined in util.ts:208
Parameters
- path: PathSegments
Returns Dereference

decodeFragmentSegments

decodeFragmentSegments(segments: PathSegments): PathSegments

- Defined in util.ts:27
Parameters
- segments: PathSegments
Returns PathSegments

decodePointer

decodePointer(ptr: string): PathSegments

- Defined in util.ts:89
Parameters
- ptr: string
Returns PathSegments

decodePointerSegments

decodePointerSegments(segments: PathSegments): PathSegments

- Defined in util.ts:61
Parameters
- segments: PathSegments
Returns PathSegments

decodePtrInit

decodePtrInit(ptr: string | PathSegments): PathSegments

- Defined in util.ts:373
Parameters
- ptr: string | PathSegments
Returns PathSegments

decodeRelativePointer

decodeRelativePointer(ptr: string): PathSegments

- Defined in util.ts:153
Parameters
- ptr: string
Returns PathSegments

decodeUriFragmentIdentifier

decodeUriFragmentIdentifier(ptr: string): PathSegments

- Defined in util.ts:116
Parameters
- ptr: string
Returns PathSegments

encodeFragmentSegments

encodeFragmentSegments(segments: PathSegments): PathSegments

- Defined in util.ts:45
Parameters
- segments: PathSegments
Returns PathSegments

encodePointer

encodePointer(path: PathSegments): JsonStringPointer

- Defined in util.ts:106
Parameters
- path: PathSegments
Returns JsonStringPointer

encodePointerSegments

encodePointerSegments(segments: PathSegments): PathSegments

- Defined in util.ts:75
Parameters
- segments: PathSegments
Returns PathSegments

encodeUriFragmentIdentifier

encodeUriFragmentIdentifier(path: PathSegments): UriFragmentIdentifierPointer

- Defined in util.ts:138
Parameters
- path: PathSegments
Returns UriFragmentIdentifierPointer

looksLikeFragment

looksLikeFragment(ptr: string): boolean

- Defined in util.ts:365
Parameters
- ptr: string
Returns boolean

pickDecoder

pickDecoder(ptr: string): Decoder

- Defined in util.ts:369
Parameters
- ptr: string
Returns Decoder

replace

replace(source: string, find: string, repl: string): string

- Defined in util.ts:11
Parameters
- source: string
- find: string
- repl: string
Returns string

setValueAtPath

setValueAtPath(target: unknown, val: unknown, path: PathSegments, force?: boolean): unknown

- Defined in util.ts:226
Parameters
- target: unknown
- val: unknown
- path: PathSegments
- force: boolean = false
Returns unknown

toArrayIndexReference

toArrayIndexReference(arr: readonly unknown[], idx: PathSegment): number

- Defined in util.ts:184
Parameters
- arr: readonly unknown[]
- idx: PathSegment
Returns number

unsetValueAtPath

unsetValueAtPath(target: unknown, path: PathSegments): unknown

- Defined in util.ts:314
Parameters
- target: unknown
- path: PathSegments
Returns unknown

Generated using TypeDoc