Arguments
subject: Object|number|string|boolean|null A json value.resolve: Jst.Resolver A function to resolve a schema by its id.resolve:Resolver` A function to resolve a schema by its id.Returns
import * as has from 'lodash.has';
-import { isPointer } from './isPointer';export const get: Jst.getPointer = (schema, pointer) => {export const get: GetPointer = (schema, pointer) => {A JSON pointer must begin with the symbols ‘#’, ‘/‘ or be an empty string ‘’.
The isPointer function determines if its argument is a valid json pointer
+or not returning a boolean indicating the result of the operation.
export const isPointer = (input: string): boolean => {
+
+
+ import { isPointer } from '@jdw/jst';
+
+isPointer('#/foo'); // true
+isPointer({}) // false
+
+
+
+
+
+ Dependencies
+
+
+
+import { IsPointer } from './types';
+
+
+
+ Implementation
+
+
+
+export const isPointer: IsPointer = (input) => {
+
+
+
+ A JSON pointer must begin with the symbols ‘#’, ‘/‘ or be an empty string
+‘’.
+
+
+
if (typeof input !== 'string') {
return false;
}
@@ -84,9 +114,14 @@ Table of Contents
if (/^#|^\//.test(input)) {
return true;
- }
+ }
+
+
+
+ If it is not one of these values then input is not a json pointer.
- return false;
+
+ return false;
};
diff --git a/docs/set.html b/docs/set.html
index 4fd5bef..d420ca2 100644
--- a/docs/set.html
+++ b/docs/set.html
@@ -56,13 +56,6 @@ Table of Contents
-
- import * as has from 'lodash.has';
import { isPointer } from './isPointer';
+import { SetPointer } from './types';
-export const set: Jst.setPointer = (obj, pointer, value) => {JST is a library for working with JSON Schema. It aims to be both simple and -performant. We begin by covering JST internal data-structures and interfaces.
- - -declare module Jst {A Resolver function takes a schema ID as its argument and looks it
-up, returning them schema as an Object if found or undefined if not.
export type resolve = (schemaId: string) => Object | undefined;A Dereferencer function takes a schema and a resolver function
-and then dereferences schema in accordance with the IETF JSON
-Reference Draft v3
-Specification.
export type dereference =
- (schema: Object | Array<any>, resolver: resolve) => Object | Array<any>;A Getter function dereferences a JSON pointer in accordance with the
-IETF RFC6901 specification
-returning its value if path is found in schema or throw an error
-otherwise.
export type getPointer = (schema: Object, path: string) => any;
- export type setPointer = (schema: Object, path: string, value: any) => void;
-}