Class Key

A Key represents the unique identifier of an object. Our Key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. Keys are hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:

new Key('/Comedy')
new Key('/Comedy/MontyPython') Also, every namespace can be parametrized to embed relevant object information. For example, the Key name (most specific namespace) could include the object type:
new Key('/Comedy/MontyPython/Actor:JohnCleese')
new Key('/Comedy/MontyPython/Sketch:CheeseShop')
new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')

Index

Constructors

constructor

new Key(s: string | Uint8Array<ArrayBufferLike>, clean?: boolean): Key
Parameters
- s: string | Uint8Array<ArrayBufferLike>
- Optionalclean: boolean
Returns Key
- Defined in interface-datastore/src/key.ts:32

Accessors

[toStringTag]

get "[toStringTag]"(): string
Return string representation of the key

Returns string
- Defined in interface-datastore/src/key.ts:78

Methods

baseNamespace

baseNamespace(): string
Returns the "base" namespace of this key.

Returns string
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').baseNamespace()
// => 'Actor:JohnCleese'
```
- Defined in interface-datastore/src/key.ts:216

child

child(key: Key): Key
Returns the child Key of this Key.
Parameters
- key: Key
  The child Key to add
Returns Key
Example
```
new Key('/Comedy/MontyPython').child(new Key('Actor:JohnCleese'))
// => Key('/Comedy/MontyPython/Actor:JohnCleese')
```
- Defined in interface-datastore/src/key.ts:334

clean

clean(): void
Cleanup the current key

Returns void
- Defined in interface-datastore/src/key.ts:135

concat

concat(...keys: Key[]): Key
Concats one or more Keys into one new Key.
Parameters
- ...keys: Key[]
  The array of keys to concatenate
Returns Key
- Defined in interface-datastore/src/key.ts:399

instance

instance(s: string): Key
Returns an "instance" of this type key (appends value to namespace).
Parameters
- s: string
  The string to append.
Returns Key
Example
```
new Key('/Comedy/MontyPython/Actor').instance('JohnClesse')
// => Key('/Comedy/MontyPython/Actor:JohnCleese')
```
- Defined in interface-datastore/src/key.ts:278

isAncestorOf

isAncestorOf(other: Key): boolean
Returns whether this key is a prefix of other
Parameters
- other: Key
  The other key to test against
Returns boolean
Example
```
new Key('/Comedy').isAncestorOf('/Comedy/MontyPython')
// => true
```
- Defined in interface-datastore/src/key.ts:356

isDecendantOf

isDecendantOf(other: Key): boolean
Returns whether this key is a contains another as prefix.
Parameters
- other: Key
  The other Key to test against
Returns boolean
Example
```
new Key('/Comedy/MontyPython').isDecendantOf('/Comedy')
// => true
```
- Defined in interface-datastore/src/key.ts:376

isTopLevel

isTopLevel(): boolean
Checks if this key has only one namespace.

Returns boolean
- Defined in interface-datastore/src/key.ts:389

less

less(key: Key): boolean
Check if the given key is sorted lower than ourself.
Parameters
- key: Key
  The other Key to check against
Returns boolean
- Defined in interface-datastore/src/key.ts:159

list

list(): string[]
Returns the list representation of this key.

Returns string[]
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').list()
// => ['Comedy', 'MontyPythong', 'Actor:JohnCleese']
```
- Defined in interface-datastore/src/key.ts:232

name

name(): string
Returns the "name" of this key (field of last namespace).

Returns string
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').name()
// => 'JohnCleese'
```
- Defined in interface-datastore/src/key.ts:262

namespaces

namespaces(): string[]
Returns the namespaces making up this Key.

Returns string[]
- Defined in interface-datastore/src/key.ts:201

parent

parent(): Key
Returns the parent Key of this Key.

Returns Key
Example
```
new Key("/Comedy/MontyPython/Actor:JohnCleese").parent()
// => Key("/Comedy/MontyPython")
```
- Defined in interface-datastore/src/key.ts:313

path

path(): Key
Returns the "path" of this key (parent + type).

Returns Key
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').path()
// => Key('/Comedy/MontyPython/Actor')
```
- Defined in interface-datastore/src/key.ts:293

reverse

reverse(): Key
Returns the key with all parts in reversed order.

Returns Key
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').reverse()
// => Key('/Actor:JohnCleese/MontyPython/Comedy')
```
- Defined in interface-datastore/src/key.ts:192

toString

toString(encoding?: SupportedEncodings): string
Convert to the string representation
Parameters
- Optionalencoding: SupportedEncodings = 'utf8'
  The encoding to use.
Returns string
- Defined in interface-datastore/src/key.ts:60

type

type(): string
Returns the "type" of this key (value of last namespace).

Returns string
Example
```
new Key('/Comedy/MontyPython/Actor:JohnCleese').type()
// => 'Actor'
```
- Defined in interface-datastore/src/key.ts:247

uint8Array

uint8Array(): Uint8Array
Return the Uint8Array representation of the key

Returns Uint8Array
- Defined in interface-datastore/src/key.ts:69

`Static`asKey

asKey(other: any): null | Key
Parameters
- other: any
Returns null | Key
- Defined in interface-datastore/src/key.ts:116

`Static`random

random(): Key
Returns a randomly (uuid) generated key.

Returns Key
Example
```
Key.random()
// => Key('/344502982398')
```
- Defined in interface-datastore/src/key.ts:109

`Static`withNamespaces

withNamespaces(list: string[]): Key
Constructs a key out of a namespace array.
Parameters
- list: string[]
  The array of namespaces
Returns Key
Example
```
Key.withNamespaces(['one', 'two'])
// => Key('/one/two')
```
- Defined in interface-datastore/src/key.ts:94

Class Key

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Key

Accessors

[toStringTag]

Returns string

Methods

baseNamespace

Returns string

Example

child

Parameters

Returns Key

Example

clean

Returns void

concat

Parameters

Returns Key

instance

Parameters

Returns Key

Example

isAncestorOf

Parameters

Returns boolean

Example

isDecendantOf

Parameters

Returns boolean

Example

isTopLevel

Returns boolean

less

Parameters

Returns boolean

list

Returns string[]

Example

name

Returns string

Example

namespaces

Returns string[]

parent

Returns Key

Example

path

Returns Key

Example

reverse

Returns Key

Example

toString

Parameters

Returns string

type

Returns string

Example

uint8Array

Returns Uint8Array

StaticasKey

Parameters

Returns null | Key

Staticrandom

Returns Key

Example

StaticwithNamespaces

Parameters

Returns Key

Example

Settings

On This Page

`Static`asKey

`Static`random

`Static`withNamespaces