git-documentdb
Version:
Offline-first database that syncs with Git
47 lines • 1.86 kB
TypeScript
/**
* GitDocumentDB
* Copyright (c) Hidekazu Kubota
*
* This source code is licensed under the Mozilla Public License Version 2.0
* found in the LICENSE file in the root directory of this source tree.
*/
import { ReadBlobResult } from 'isomorphic-git';
import { FatBinaryDoc, FatDoc, FatJsonDoc, FatTextDoc, JsonDoc, SerializeFormat } from '../types';
/**
* textToJsonDoc
* @throws {@link Err.InvalidJsonObjectError}
*/
export declare function textToJsonDoc(text: string, serializeFormat: SerializeFormat, extension: string, shortId?: string): JsonDoc;
/**
* blobToJsonDoc
*
* @throws {@link Err.InvalidJsonObjectError}
*/
export declare function blobToJsonDoc(shortId: string, readBlobResult: ReadBlobResult, withMetadata: boolean, serializeFormat: SerializeFormat, extension: string): FatJsonDoc | JsonDoc;
/**
* blobToJsonDocWithoutOverwrittenId
*
* @throws {@link Err.InvalidJsonObjectError}
*/
export declare function blobToJsonDocWithoutOverwrittenId(readBlobResult: ReadBlobResult, serializeFormat: SerializeFormat, extension: string): JsonDoc;
/**
* blobToText
*/
export declare function blobToText(shortName: string, readBlobResult: ReadBlobResult, withMetadata: boolean): FatTextDoc | string;
/**
* blobToBinary
*/
export declare function blobToBinary(shortName: string, readBlobResult: ReadBlobResult, withMetadata: boolean): FatBinaryDoc | Uint8Array;
/**
* readBlobByOid
*/
export declare function readBlobByOid(workingDir: string, oid: string): Promise<ReadBlobResult | undefined>;
/**
* readLatestBlob
*/
export declare function readLatestBlob(workingDir: string, fullDocPath: string): Promise<ReadBlobResult | undefined>;
/**
* Check if two FatDocs are the same.
*/
export declare function isSameFatDoc(a: FatDoc, b: FatDoc): boolean;
//# sourceMappingURL=blob.d.ts.map