Extends
Constructor
- options
- Type:
Object
- id
- Type:
string
orinteger
- prefix
- Type:
string
- postfix
- Type:
string
- Default:
""
- delimiter
- Type:
string
- Default:
"_"
- caseSensitive
- Type:
Boolean
- Default:
true
- ref
- Type:
Array
- Default:
[
array of document's properties from refDoc definition object
KeyError
new RefDocKey(options)
RefDocKey
Parameters:
Throws:
Methods
- Instance
instance
- string|Array
id
generate(Instance)
generates new key This method is called before inserting new document to a bucket The method must return a prosime
Parameters:
getOptions()
RefDocKeyOptionsObject
Returns:
RefDocKeyOptionsObject
setId(string|Array)
Parameters:
toString()
returns the key
Returns: stringInherited Methods
- <undefined>
- Type:
string
getId()
Parameters:
isGenerated()
boolean
Returns:
boolean