filein API

Install

npm i filein

Table of Contents

Models

• User
• File

Methods

• Upload
• Get File
• Get User

Models

User

interface User {
	id: string
	slug: string
	name: string
	files: number
	comments: number
}

File

interface File {
	id: string
	name: string
	type: string
	size: number
	owner: string | null
	comments: number
	uploaded: Date
	public: boolean
	link: string
	url: string
	secureUrl: string
}

Methods

Upload

Definition

interface UploadOptions {
	name: string
	type: string
	public: boolean
	data: Buffer
}

function upload(options: UploadOptions): Promise<File>

Example

const { upload } = require('filein')
const { readFileSync } = require('fs')
const { join } = require('path')

const file = await upload({
	name: 'me.png',
	type: 'image/png',
	public: false,
	data: readFileSync(join(__dirname, 'me.png'))
})

console.log(file)

Get File

Definition

function getFile(id: string): Promise<File | null>

Example

const { getFile } = require('filein')

console.log(await getFile('EMppZ8g3Fu.jpg'))

Get User

Definition

// Faster
function getUserFromId(id: string): Promise<User | null>

// Slower
function getUserFromSlug(slug: string): Promise<User | null>

Example

const { getUserFromId, getUserFromSlug } = require('filein')

console.log(await getUserFromId('R61liLnxF4bojbAtmjgtsSl9PMt2'))
console.log(await getUserFromSlug('ken-mueller'))