0.2.3 • Published 21 days ago
@diograph/diograph v0.2.3
Diograph
Install
npm install @diograph/diograph
# or
yarn add @diograph/diograph
Usage
import { Diograph } from '@diograph/diograph'
const diograph = new Diograph()
diograph.createDiory({ text: 'Hello diory!' })
console.log('Hello Diograph!', diograph)
API
const diograph = new Diograph(diographObject)
Diograph
diograph.addDiograph(diographObject)
diograph.queryDiograph({ text: 'some-text' })
diograph.resetDiograph()
diograph.toObject()
diograph.toJson()
diograph.getDiory(someDiory)
diograph.addDiory(someDiory)
diograph.updateDiory(someDiory)
diograph.removeDiory(someDiory)
diograph.addDioryLink(someDiory, linkedDiory)
diograph.removeDioryLink(someDiory, linkedDiory)
Diory
const diory = new Diory()
diory.updateDiory(dioryObject)
diory.addLink(linkedDiory)
diory.removeLink(linkedDiory)
diory.toObject()
diory.toJson()
Room
loadRoom(clients)
- set room object contents from room.json: connections & diograph
- initiate connections if proper client is passed
initiateRoom(clients, connections, diographObject)
- set room object contents from arguments: connections & diograph
addConnection(connection)
- attach a connection to room
removeConnection(connection)
- de-attach connection from room
readContent(contentUrl)
- read buffer of the given content
addContent(fileContent)
- adds content to nativeConnection
deleteRoom()
- delete room.json and diograph.json
- delete the folder in room.address
saveRoom()
- save room.json and diograph.json to room's writable media
toObject()
- room as RoomObject
toJson()
- room as JSON string
Connection
initiateConnection()
- set connection object contens from arguments: contentUrls & diograph
addContentUrl(contentId)
- used when listing a content folder contents to connection
- in this case content is not added to connection (as it already exists!)
addContent(fileContent, contentId)
- saves content to connection writable media
- adds contentUrl to connection contentUrls
readContent(contentId)
- content buffer
- loaded using the connection client
deleteContent(contentId)
- deletes contentId
- removes contentId from connection contentUrls listing
deleteConnection()
- calls deleteContent for each contentUrl
- delete the folder in connection.address
toObject()
- connection as ConnectionObject
Development
Compile typescript in real time to /dist
folder:
yarn build-watch
Run unit tests in the background:
yarn test-watch
0.2.3
21 days ago
0.3.0-rc13
25 days ago
0.3.0-rc14
25 days ago
0.3.0-rc12
29 days ago
0.3.0-rc10
29 days ago
0.3.0-rc11
29 days ago
0.3.0-rc8
29 days ago
0.3.0-rc7
29 days ago
0.3.0-rc9
29 days ago
0.3.0-rc6
29 days ago
0.3.0-rc5
29 days ago
0.1.3-rc5
1 month ago
0.3.0-rc4
1 month ago
0.1.3-rc6
1 month ago
0.3.0-rc3
1 month ago
0.1.3-rc7
1 month ago
0.1.3-rc8
1 month ago
0.2.3-rc2
1 month ago
0.3.0-rc2
1 month ago
0.3.0-rc1
1 month ago
0.1.3-rc2
1 month ago
0.1.3-rc3
1 month ago
0.1.3-rc4
1 month ago
0.2.3-rc1
1 month ago
0.2.2
2 months ago
0.1.3-rc1
2 months ago
0.1.2
2 months ago
0.1.2-rc3
2 months ago
0.1.2-rc1
2 months ago
0.1.2-rc2
2 months ago
0.2.2-rc3
3 months ago
0.2.2-rc2
4 months ago
0.2.2-rc1
4 months ago
0.2.1-rc3
4 months ago
0.2.1-rc2
4 months ago
0.2.1-rc1
4 months ago
0.2.0
5 months ago
0.2.0-rc4
6 months ago
0.2.0-rc1
6 months ago
0.2.0-rc2
6 months ago
0.2.0-rc3
6 months ago
0.1.0
7 months ago
0.1.1
7 months ago
0.0.2-rc13
7 months ago
0.0.2-rc11
7 months ago
0.0.2-rc12
7 months ago
0.0.2-rc8
1 year ago
0.0.2-rc9
1 year ago
0.0.2-rc4
1 year ago
0.0.2-rc5
1 year ago
0.0.2-rc6
1 year ago
0.0.2-rc7
1 year ago
0.0.2-rc3
1 year ago
0.0.2-rc2
1 year ago
0.0.2-rc1
1 year ago