0.2.0 - Separated IO classes with and without fs dependent (#4)

* Restructured IO directory

* Separated feed reader classes

* Update writer classes

* Updated documents

* Updated exporting

CHANGES.md

@@ -1 +1 @@
-Added .js to relative module paths
+Splited IO classes between `fs` dependent (for Node) and `fs` independent (for Browser).

README.md

@@ -14,17 +14,17 @@ npm i gtfs-io
 
 ```ts
 // Synchronously
-import { GTFSFeedReader } from 'gtfs-io';
-const reader = GTFSFeedReader.fromZip('gtfs.zip');
-const reader = GTFSFeedReader.fromDirectory('path/to/dir');
+import { GTFSFeedReaderFromFile } from 'gtfs-io';
+const reader = GTFSFeedReaderFromFile.fromZip('gtfs.zip');
+const reader = GTFSFeedReaderFromFile.fromDirectory('path/to/dir');
 const feed = reader.loadFeed();
 console.log(feed.stops[0].stop_id);
 console.log(feed.trips[1].trip_id);
 
 // Asynchronously
-import { GTFSAsyncFeedReader } from 'gtfs-io';
-const reader = GTFSAsyncFeedReader.fromZip('gtfs.zip');
-const reader = GTFSAsyncFeedReader.fromDirectory('path/to/dir');
+import { GTFSAsyncFeedReaderFromFile } from 'gtfs-io';
+const reader = GTFSAsyncFeedReaderFromFile.fromZip('gtfs.zip');
+const reader = GTFSAsyncFeedReaderFromFile.fromDirectory('path/to/dir');
 const feed = await reader.loadFeed();
 console.log(feed.stops[0].stop_id);
 console.log(feed.trips[1].trip_id);
@@ -43,14 +43,14 @@ const feed = new GTFSLoadedFeed({
 });
 
 // Synchronously
-import { GTFSFeedWriter } from 'gtfs-io';
-GTFSFeedWriter.writeZip(feed, 'gtfs.zip');
-GTFSFeedWriter.writeDirectory(feed, 'path/to/dir');
+import { GTFSFeedWriterToFile } from 'gtfs-io';
+GTFSFeedWriterToFile.asZip(feed, 'gtfs.zip');
+GTFSFeedWriterToFile.asDirectory(feed, 'path/to/dir');
 
 // Asynchronously
-import { GTFSAsyncFeedWriter } from 'gtfs-io';
-await GTFSAsyncFeedWriter.writeZip(feed, 'gtfs.zip');
-await GTFSAsyncFeedWriter.writeDirectory(feed, 'path/to/dir');
+import { GTFSAsyncFeedWriterToFile } from 'gtfs-io';
+await GTFSAsyncFeedWriterToFile.asZip(feed, 'gtfs.zip');
+await GTFSAsyncFeedWriterToFiler.asDirectory(feed, 'path/to/dir');
 ```
 
 ---

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gtfs-io",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "IO operations for reading and writing GTFS datasets and GTFS type definitions.",
   "main": "dist/index.js",
   "keywords": [

src/index.ts

@@ -1,7 +1,9 @@
-export { GTFSFileIO, GTFSAsyncFileIO } from './io/file.js';
-export * from './io/feed-file.js';
-export { GTFSFeedReader, GTFSAsyncFeedReader } from './io/feed-reader.js';
-export { GTFSFeedWriter, GTFSAsyncFeedWriter } from './io/feed-writer.js';
+export { GTFSFileIO, GTFSAsyncFileIO } from './io/file/main.js';
+export * from './io/feed/file.js';
+export { GTFSFeedReaderFromFile, GTFSAsyncFeedReaderFromFile } from './io/feed/reader-fs.js';
+export { GTFSFeedReaderFromMemory, GTFSAsyncFeedReaderFromMemory } from './io/feed/reader-memory.js';
+export { GTFSFeedWriter, GTFSAsyncFeedWriter } from './io/feed/writer.js';
+export { GTFSFeedWriterToFile, GTFSAsyncFeedWriterToFile } from './io/feed/writer-fs.js';
 
 export * from './feed/iterable.js';
 export * from './feed/loaded.js';
@@ -24,7 +26,7 @@ export { GTFSTripDirection, GTFSTripBikesAllowed } from './files/trip.js';
 export type * from './file-info';
 export type * from './types';
 
-export type * from './io/types';
+export type * from './io/file/types';
 
 export type * from './files/agency';
 export type * from './files/area';