@deep-foundation/object-to-links-async-converter
v0.0.1
Published
A deep package for converting object to links
Downloads
17
Maintainers
Keywords
Readme
A deep package for converting object to links
Usage
- Install the package
- Give permissions to the package
- Insert
Root
link - Update object value of
Root
link - Insert
ParseIt
link fromRoot
toRoot
- See links created around
Root
link
FAQ
Must I use Root
type
It is not required to use Root
type but it is recommended to use it because this type is added to the tree
If you want to use your own type you should add it to tree of this package by creating TreeIncludeNode
from tree of this package to your type
Must ParseIt.from
and ParseIt.to
be equal?
ParseIt.from
must point to a link with object value, ParseIt.to
can point to any link and new links will be created around ParseIt.to
How new links will look like?
Let us imagine we have this object and it is called MyLink
:
{
"myObject": {
"myStringField": "myStringValue",
"myNumberField": 123,
"myBooleanField": true
}
}
These links will be created:Object
around MyLink
(from
and to
are pointing to your link)Contain
with value myObject
from MyLink
to Object
String
with value myStringValue
from Object
to Object
Contain
with value myStringField
from Object
to String
Number
with value 123
from Object
to Object
Contain
with value myNumberField
from Object
to Number
Boolean
from Object
to true
or false
(from the @deep-foundation/boolean
package)Contain
with value myBooleanField
from Object
to Boolean
How to programmatically wait until converting is done?
Use DeepClient.await
method:
await deep.await(parseItLinkId);
Links are not created, nothing happened after inserting ParseIt
See PromiseResult for your ParseIt
link
Using DeepCase
- Press right mouse button on
ParseIt
link and selectTraveller
- Select
Down
- Select
PromiseTree
You will see all the links down by promiseTree
for "parent" ParseIt
:
Then
fromYourLink
toPromise
Promise
Rejected
orResolved
fromPromise
toPromiseResult
PromiseResult
If you see Resolved
link then handler was executed successfully, if you see Rejected
link then handler was executed with error
You can see the error in PromiseResult
link value
Limitations
If you delete field in your object value and parse it again - link associated with that field will not be deleted. This feature will be implemented in the future!
Feedback
Feel free to open issues to write there about bugs, improvement requests, questions