DefinitelyTyped/n3/n3.d.ts

// Type definitions for N3 v0.8.1 
// Project: https://github.com/RubenVerborgh/N3.js
// Definitions by: Fred Eisele <https://github.com/phreed>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../node/node.d.ts" />

declare module "n3" {
    import * as fs from "fs";
    import * as stream from "stream";

    namespace N3 {

        type ErrorCallback = (err: Error, result: any) => void;

        interface Prefixes {
            [key: string]: string;
        }

        interface LiteralValue {
            value: string | number;
        }

        interface Triple {
            subject: string,
            predicate: string,
            object: string
        }

        interface BlankTriple {
            predicate: string,
            object: string
        }

        // class Parser {
        //    constructor(options?: ParserOptions);
        // }
        function Parser(options?: ParserOptions): N3Parser;
        // class StreamParser extends Parser {
        //    constructor(options?: ParserOptions);
        //}
        function StreamParser(options?: ParserOptions): N3StreamParser;

        interface ParserOptions {
            format?: string,
            prefixes?: string[]
        }

        interface ParseCallback {
            (error: Error, triple: Triple, prefixes: Prefixes): void;
        }

        interface Logger {
            (message?: any, ...optionalParams: any[]): void;
        }
        interface N3Parser {
            parse(input: string, callback: ParseCallback): void;
            parse(subject: string, predicate: string, object: string): void;
            parse(triple: Triple): void;
            parse(stream: fs.ReadStream, log: Logger): void;
        }

        interface N3StreamParser extends N3Parser {
            pipe(consumer: stream.Writable | N3StreamWriter): void;
        }

        // interface fs.ReadStream {
        //     pipe(parser: StreamParser): void;
        // }


        function Writer(options: WriterOptions): N3Writer;
        function Writer(fd: any, options: WriterOptions): N3Writer;

        function StreamWriter(options: WriterOptions): N3StreamWriter;

        interface N3Writer {
            addTriple(subject: string, predicate: string, object: string): void;
            addTriple(subject: string, predicate: string, object: string[]): void;
            addTriple(triple: Triple): void;
            end(err?: ErrorCallback, result?: any): void;
            blank(ns: string, name: string): string;
            blank(triple: BlankTriple[]): string;
            list(triple: string[]): string[];
        }

        interface N3StreamWriter extends N3Writer {
            pipe(consumer: stream.Writable): void;
        }

        interface WriterOptions {
            format?: string,
            prefixes?: Prefixes
        }

        interface N3StoreWriter extends N3Writer {
            find(subject: string, predicate: string, object: string): Triple[];
        }
        function Store(): N3StoreWriter;

        namespace Util {
            function createLiteral(value: any): string;
            function createLiteral(value: any, type: string): string;

            function isIRI(value: string): boolean;
            function isLiteral(value: string): boolean;
            function getLiteralValue(value: string): string;
            function getLiteralLanguage(value: string): string;
            function getLiteralType(value: string): string;
            function isBlank(value: string): boolean;
            function isPrefixedName(name: string): boolean;
            function expandPrefixedName(name: string, prefixes: Prefixes): string;
        }
    }
    export = N3;
}