json_pointer 0.1.0

Dart native js
Flutter Android iOS web

A simple library for creating and using json-pointer (See [rfc6901:https://tools.ietf.org/html/rfc6901]).

example/example.dart

import 'package:json_pointer/json_pointer.dart';

main() {
  
  compose(['one', 'two']); // '/one/two'
  compose(['one/two']); // '/one~1two'
  compose([]); // ''
  compose(['', '', '']); // '///'

  // Split is the opposite of compose
  split('/one/two'); // ['one', 'two']
  split('/one~1two'); // ['one/two'] 
  split(''); // []
  split('///'); // ['', '', '']

  // Other helpers
  parent('/one/two'); // '/one'
  parent('/one'); // ''
  parent(''); // null

  append('/one', 'two'); // '/one/two'
  append('/one', '~');   // '/one/~0'  append escapes the appended item 


  // Get and Set values
  get$('', [{'foo': 'bar'}]); // [{'foo': 'bar'}]
  get$('/0', [{'foo': 'bar'}]); // {'foo': 'bar'}
  get$('/0/foo', [{'foo': 'bar'}]); // 'bar'

  set$('', [{'foo': 'bar'}], 'baz'); // 'baz'
  set$('/0', [{'foo': 'bar'}], 'baz'); // ['baz']
  set$('/0/foo', [{'foo': 'bar'}], 'baz'); // [{'foo': 'baz'}]

  // Contains
  contains('', [{'foo': 'bar'}]); // true
  contains('/0', [{'foo': 'bar'}]); // true
  contains('/0/foo', [{'foo': 'bar'}]); // true

  contains('/a/5', [{'foo': 'bar'}]); // false
  contains('/1', [{'foo': 'bar'}]); // false
  contains('/0/foo/baz', [{'foo': 'bar'}]); // false

  // Escape part of a path
  escape('one/two'); // 'one~1two'
  escape('name'); // 'name'

  unescape('name'); // 'name'
  unescape('one~1two'); // 'one/two'

  // Validation
  isValid('/one/two'); // true
  isValid(''); // true
  isValid('/one~1two'); // true

  isValid(null); // false: null pointer
  isValid('/~2'); // false: '~' must be followed by either '0' or '1'
  isValid('0/foo'); // false: should start with '/'
}
0
likes
110
pub points
35%
popularity

A simple library for creating and using json-pointer (See [rfc6901:https://tools.ietf.org/html/rfc6901]).

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

petedmc0@gmail.com

License

BSD (LICENSE)

More

Packages that depend on json_pointer