pxt-common-packages/libs/storage/shims.d.ts

Microsoft MakeCode (PXT) common packages

// Auto-generated. Do not edit.
declare namespace storage {

    /** 
     * Append a buffer to a new or existing file. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage" shim=storage::appendBuffer
    function appendBuffer(filename: string, data: Buffer): void;

    /** 
     * Overwrite file with a buffer. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage" shim=storage::overwriteWithBuffer
    function overwriteWithBuffer(filename: string, data: Buffer): void;

    /** 
     * Return true if the file already exists. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage"
    //% blockId="storage_exists" block="file $filename exists" shim=storage::exists
    function exists(filename: string): boolean;

    /** 
     * Delete a file, or do nothing if it doesn't exist. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage"
    //% blockId="storage_remove" block="remove file $filename" shim=storage::remove
    function remove(filename: string): void;

    /** 
     * Return the size of the file, or -1 if it doesn't exists. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage"
    //% blockId="storage_size" block="size of file $filename" shim=storage::size
    function size(filename: string): int32;

    /** 
     * Read contents of file as a buffer. 
     * @param filename name of the file, eg: "log.txt"
     */
    //% parts="storage" shim=storage::readAsBuffer
    function readAsBuffer(filename: string): Buffer;
}

// Auto-generated. Do not edit. Really.