Skip to content

First pass at adding encoding support #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CWSpear wants to merge 1 commit into
base: master
Choose a base branch
from
Open

First pass at adding encoding support #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { resolve } from 'path';
import { goferTests } from 'goferfs-test-suite';

import LocalAdapter from './.';
import { LocalAdapter } from './.';

describe('Local Adapter', () => {
const adapter = new LocalAdapter({
Expand Down
22 changes: 11 additions & 11 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ import { resolve, basename, dirname, extname, relative } from 'path';
import { lookup as mimeLookup } from 'mime';
import * as Bluebird from 'bluebird';

import { IAdapter } from 'goferfs-types/interfaces';
import { Visibility, Metadata, File, StreamFile } from 'goferfs-types';
import { IAdapter, Visibility, Metadata, File, StreamFile, WriteOptions, ReadOptions } from 'goferfs-types';

export default class LocalAdapter implements IAdapter {
export class LocalAdapter implements IAdapter<LocalAdapter> {
private rootPath: string;
private publicVisibilityMode: number;
private privateVisibilityMode: number;

adapterName = 'local';
targetVersion = '1.0';

constructor({
Expand All @@ -28,20 +28,20 @@ export default class LocalAdapter implements IAdapter {
this.privateVisibilityMode = privateVisibilityMode;
}

async write(path: string, contents: string, { visibility }: { visibility: Visibility } = { visibility: Visibility.Public }): Promise<Metadata> {
async write(path: string, contents: string, { visibility, encoding }: WriteOptions): Promise<Metadata> {
path = this.fullPath(path);

// @TODO broken type here (mode isn't accepted)
const writeFileAsync: any = fs.writeFileAsync;
await writeFileAsync(path, contents, { mode: this.getMode(visibility) });
await writeFileAsync(path, contents, { mode: this.getMode(visibility), encoding });

return this.getMetadata(path);
}

async writeStream(path: string, stream: Stream, { visibility }: { visibility: Visibility } = { visibility: Visibility.Public }): Promise<Metadata> {
async writeStream(path: string, stream: Stream, { visibility, encoding }: WriteOptions): Promise<Metadata> {
path = this.fullPath(path);

stream.pipe(fs.createWriteStream(path, { mode: this.getMode(visibility) }));
stream.pipe(fs.createWriteStream(path, { mode: this.getMode(visibility), encoding }));

await new Bluebird((resolve, reject) => {
stream.on('end', resolve);
Expand Down Expand Up @@ -113,18 +113,18 @@ export default class LocalAdapter implements IAdapter {
return fs.existsAsync(path);
}

async read(path: string): Promise<any> {
async read(path: string, { encoding }: ReadOptions): Promise<any> {
path = this.fullPath(path);

const contents = await fs.readFileAsync(path, 'utf8');
const contents = await fs.readFileAsync(path, encoding);

return new File(await this.getMetadata(path), contents);
}

async readStream(path: string): Promise<StreamFile> {
async readStream(path: string, { encoding }: ReadOptions): Promise<StreamFile> {
path = this.fullPath(path);

return new StreamFile(await this.getMetadata(path), fs.createReadStream(path));
return new StreamFile(await this.getMetadata(path), fs.createReadStream(path, { encoding }));
}

async getMetadata(path: string): Promise<Metadata> {
Expand Down