Class Drive

Hierarchy (view full)

EventEmitter<EventMap>
- Drive
  - EncryptedDrive

Index

Constructors

constructor

new Drive(signer, publisher): Drive
Parameters
- signer: Signer
- publisher: Publisher
Returns Drive
Overrides EventEmitter<EventMap>.constructor
- Defined in src/Drive.ts:129

Properties

`Protected` _metadata

_metadata: DriveMetadata = ...

`Optional` event

event?: EventTemplate | SignedEvent

modified

modified: boolean = false

whether the drive has been modified and needs to be saved

publisher

publisher: Publisher

signer

signer: Signer

tree

tree: TreeFolder

`Static` prefixed

prefixed: string | boolean

Accessors

address

get address(): "" | `naddr1${string}`
Returns "" | `naddr1${string}`
- Defined in src/Drive.ts:112

description

get description(): string
Returns string
- Defined in src/Drive.ts:92
set description(v): void
Parameters
- v: string
Returns void
- Defined in src/Drive.ts:95

identifier

get identifier(): string
Returns string
- Defined in src/Drive.ts:76
set identifier(v): void
Parameters
- v: string
Returns void
- Defined in src/Drive.ts:79

name

get name(): string
Returns string
- Defined in src/Drive.ts:84
set name(v): void
Parameters
- v: string
Returns void
- Defined in src/Drive.ts:87

pubkey

get pubkey(): undefined | string
Returns undefined | string
- Defined in src/Drive.ts:73

servers

get servers(): string[]
Returns string[]
- Defined in src/Drive.ts:100
set servers(v): void
Parameters
- v: string[]
Returns void
- Defined in src/Drive.ts:103

Methods

[iterator]

[iterator](): IterableIterator<TreeFile | TreeFolder>

Iterate over the files

Returns IterableIterator<TreeFile | TreeFolder>

Example

for(let fileOrFolder of drive){
  if(fileOrFolder instanceof TreeFolder){
    // keep looping
  }
  else if(fileOrFolder instanceof TreeFile){
    console.log(fileOrFolder.path)
  }
}

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

`Protected` createEventTemplate

createEventTemplate(): EventTemplate
Returns EventTemplate
- Defined in src/Drive.ts:136

downloadFile

downloadFile(path, additionalServers?): Promise<null | File>
Downloads the file at the path
Parameters
- path: Path
- additionalServers: string[] = []
Returns Promise<null | File>
- Defined in src/Drive.ts:247

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof EventMap)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof EventMap)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getFile

getFile(path): TreeFile
Parameters
- path: Path
Returns TreeFile
- Defined in src/Drive.ts:231

getFileURL

getFileURL(path, additionalServers?): string
Parameters
- path: Path
- additionalServers: string[] = []
Returns string
- Defined in src/Drive.ts:235

getFolder

getFolder(path, create?): TreeFolder
Gets the folder at the path, pass create=true in to create an empty folder
Parameters
- path: Path
- create: boolean = false
Returns TreeFolder
- Defined in src/Drive.ts:226

getPath

getPath(path, create?): TreeFile | TreeFolder
Gets the file or folder at the path
Parameters
- path: Path
- create: boolean = false
Returns TreeFile | TreeFolder
- Defined in src/Drive.ts:221

hasHash

hasHash(sha256): boolean
Checks if there is a file with a matching sha256 hash
Parameters
- sha256: string
Returns boolean
- Defined in src/Drive.ts:286

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof EventMap
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

move

move(src, dest): void
Moves the file or folder from src to dest
Parameters
- src: Path
- dest: Path
Returns void
- Defined in src/Drive.ts:271

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

`Protected` readEvent

readEvent(event): DriveMetadata
Parameters
- event: EventTemplate | SignedEvent
Returns DriveMetadata
- Defined in src/Drive.ts:160

remove

remove(path): void
Removes the file or folder at the path
Parameters
- path: Path
Returns void
- Defined in src/Drive.ts:264

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof EventMap
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof EventMap
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

reset

reset(): void
Reset any pending changes

Returns void
- Defined in src/Drive.ts:212

`Protected` resetFromEvent

resetFromEvent(): void
Returns void
- Defined in src/Drive.ts:204

save

save(): Promise<undefined | SignedEvent>
Save any pending changes to nostr

Returns Promise<undefined | SignedEvent>
- Defined in src/Drive.ts:185

setFile

setFile(path, metadata): TreeFile
Updates or creates a new file at the path
Parameters
- path: Path
- metadata: FileMetadata
Returns TreeFile
- Defined in src/Drive.ts:278

update

update(event): boolean
Parameters
- event: EventTemplate | SignedEvent
Returns boolean
- Defined in src/Drive.ts:193

`Static` fromEvent

fromEvent(event, signer, publisher): Drive
Parameters
- event: SignedEvent
- signer: Signer
- publisher: Publisher
Returns Drive
- Defined in src/Drive.ts:123

Class Drive

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Drive

Properties

Protected _metadata

Optional event

modified

publisher

signer

tree

Static prefixed

Accessors

address

Returns "" | `naddr1${string}`

description

Returns string

Parameters

Returns void

identifier

Returns string

Parameters

Returns void

name

Returns string

Parameters

Returns void

pubkey

Returns undefined | string

servers

Returns string[]

Parameters

Returns void

Methods

[iterator]

Returns IterableIterator<TreeFile | TreeFolder>

Example

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

Protected createEventTemplate

Returns EventTemplate

downloadFile

Parameters

Returns Promise<null | File>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof EventMap)[]

getFile

Parameters

Returns TreeFile

getFileURL

Parameters

Returns string

getFolder

Parameters

Returns TreeFolder

getPath

Parameters

Returns TreeFile | TreeFolder

hasHash

Parameters

Returns boolean

listenerCount

Parameters

Returns number

listeners

`Protected` _metadata

`Optional` event

`Static` prefixed

`Protected` createEventTemplate

`Protected` readEvent

`Protected` resetFromEvent

`Static` fromEvent