0.1.174 • Published 8 months ago

@filen/sdk v0.1.174

Weekly downloads
-
License
AGPLv3
Repository
github
Last release
8 months ago

Contributors Forks Stargazers Issues License

Installation

  1. Install using NPM
npm install @filen/sdk@latest
  1. Initialize the SDK.
import FilenSDK from "@filen/sdk"
import path from "path"
import os from "os"

type FilenSDKConfig = {
	email?: string
	password?: string
	twoFactorCode?: string
	masterKeys?: string[]
	apiKey?: string
	publicKey?: string
	privateKey?: string
	authVersion?: AuthVersion
	baseFolderUUID?: string
	userId?: number
	metadataCache?: boolean // Cache decrypted metadata in memory. Recommended.
	tmpPath?: string // Temporary local path used to store metadata and chunks. Only available in Node.JS.,
	connectToSocket?: boolean // Recommended if you are using the virtual FS class. Keeps the internal item tree up to date with remote changes.
}

// You can either directly supply all needed config parameters to the constructor or call the .login() function to fetch them using your login information.
const filen = new FilenSDK({
	metadataCache: true,
	connectToSocket: true,
	tmpPath: path.join(os.tmpdir(), "filen-sdk")
})

await filen.login({
	email: "your@email.com",
	password: "supersecret123",
	twoFactorCode: "123456"
})
  1. Interact with the cloud
// Create a directory
await filen.fs().mkdir({
	path: "/Pictures"
})

// Upload a file
await filen.fs().upload({
	path: "/Pictures",
	source: "/Local/path/to/a/file.jpg"
})

// Read contents of the directory
const content: string[] = await filen.fs().readdir({
	path: "/Pictures"
})

// Stat a file
const stats: FSStats = await filen.fs().stat({
	path: "/Pictures/file.jpg"
})

// Download a file
await filen.fs().download({
	path: "/Pictures/file.jpg",
	destination: "/Local/path/to/a/file.jpg"
})

// Read a file
const content: Buffer = await filen.fs().readFile({
	path: "/Pictures/file.jpg"
})

// Write to a path
await filen.fs().writeFile({
	path: "/text.txt",
	content: Buffer.from("foobar", "utf-8")
})

License

Distributed under the AGPL-3.0 License. See LICENSE for more information.

0.1.174

8 months ago

0.1.173

8 months ago

0.1.172

8 months ago

0.1.171

9 months ago

0.1.170

9 months ago

0.1.168

9 months ago

0.1.167

10 months ago

0.1.166

10 months ago

0.1.165

10 months ago

0.1.164

10 months ago

0.1.118

1 year ago

0.1.117

1 year ago

0.1.119

1 year ago

0.1.114

1 year ago

0.1.113

1 year ago

0.1.116

1 year ago

0.1.115

1 year ago

0.1.110

1 year ago

0.1.111

1 year ago

0.1.129

1 year ago

0.1.128

1 year ago

0.1.125

1 year ago

0.1.124

1 year ago

0.1.127

1 year ago

0.1.126

1 year ago

0.1.120

1 year ago

0.1.123

1 year ago

0.1.122

1 year ago

0.1.139

11 months ago

0.1.136

12 months ago

0.1.135

12 months ago

0.1.138

11 months ago

0.1.137

11 months ago

0.1.132

1 year ago

0.1.131

1 year ago

0.1.134

1 year ago

0.1.133

1 year ago

0.1.130

1 year ago

0.1.147

11 months ago

0.1.146

11 months ago

0.1.149

11 months ago

0.1.148

11 months ago

0.1.143

11 months ago

0.1.142

11 months ago

0.1.145

11 months ago

0.1.144

11 months ago

0.1.141

11 months ago

0.1.140

11 months ago

0.1.96

1 year ago

0.1.97

1 year ago

0.1.98

1 year ago

0.1.99

1 year ago

0.1.90

1 year ago

0.1.91

1 year ago

0.1.92

1 year ago

0.1.93

1 year ago

0.1.94

1 year ago

0.1.95

1 year ago

0.1.158

10 months ago

0.1.157

10 months ago

0.1.159

10 months ago

0.1.154

11 months ago

0.1.153

11 months ago

0.1.156

10 months ago

0.1.155

10 months ago

0.1.150

11 months ago

0.1.152

11 months ago

0.1.151

11 months ago

0.1.85

1 year ago

0.1.86

1 year ago

0.1.88

1 year ago

0.1.89

1 year ago

0.1.82

1 year ago

0.1.83

1 year ago

0.1.84

1 year ago

0.1.161

10 months ago

0.1.160

10 months ago

0.1.163

10 months ago

0.1.162

10 months ago

0.1.107

1 year ago

0.1.106

1 year ago

0.1.109

1 year ago

0.1.108

1 year ago

0.1.102

1 year ago

0.1.105

1 year ago

0.1.104

1 year ago

0.1.101

1 year ago

0.1.100

1 year ago

0.1.80

1 year ago

0.1.81

1 year ago

0.1.79

1 year ago

0.1.76

1 year ago

0.1.77

1 year ago

0.1.78

1 year ago

0.1.75

1 year ago

0.1.74

1 year ago

0.1.72

1 year ago

0.1.73

1 year ago

0.1.71

1 year ago

0.1.70

1 year ago

0.1.69

1 year ago

0.1.67

1 year ago

0.1.68

1 year ago

0.1.66

1 year ago

0.1.64

1 year ago

0.1.65

1 year ago

0.1.63

1 year ago

0.1.60

1 year ago

0.1.61

1 year ago

0.1.62

1 year ago

0.1.59

1 year ago

0.1.55

1 year ago

0.1.56

1 year ago

0.1.57

1 year ago

0.1.58

1 year ago

0.1.52

1 year ago

0.1.53

1 year ago

0.1.54

1 year ago

0.1.50

1 year ago

0.1.51

1 year ago

0.1.48

1 year ago

0.1.47

1 year ago

0.1.46

1 year ago

0.1.43

1 year ago

0.1.44

1 year ago

0.1.45

1 year ago

0.1.37

1 year ago

0.1.41

1 year ago

0.1.42

1 year ago

0.1.40

1 year ago

0.1.38

1 year ago

0.1.39

1 year ago

0.1.33

1 year ago

0.1.34

1 year ago

0.1.35

1 year ago

0.1.36

1 year ago

0.1.30

1 year ago

0.1.31

1 year ago

0.1.32

1 year ago

0.1.28

1 year ago

0.1.27

1 year ago

0.1.26

1 year ago

0.1.22

1 year ago

0.1.23

1 year ago

0.1.24

1 year ago

0.1.25

1 year ago

0.1.20

1 year ago

0.1.17

1 year ago

0.1.18

1 year ago

0.1.19

1 year ago

0.1.15

1 year ago

0.1.16

1 year ago

0.1.13

1 year ago

0.1.14

1 year ago

0.1.10

1 year ago

0.1.11

1 year ago

0.1.12

1 year ago

0.1.2

1 year ago

0.1.8

1 year ago

0.1.7

1 year ago

0.1.9

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.6

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago