Giter VIP home page Giter VIP logo

expo-cached-remote-files's Introduction

Expo Remote File Cache

Expo remote file cache for caching string files from a given uri.

Installation

npm install @meecode/expo-cached-remote-files --save

Peer Dependencies

  • expo-file-system

Methods

 /**
     * Caches a file with the given uri and key when the timestamp is newer
     *
     * @param uri the uri of the file to cache
     * @param key the cache key to use. must be unique for every file
     * @param changedTimestamp the timestamp to check if the cached file is newer or not. default is undefined
     *
     * @returns the file path
     */
    static getOrCache(uri: string, key: string, changedTimestamp?: number): Promise<string>;

    /**
     * Gets a cached file uri by the cache key
     *
     * @param key the cache key to use
     *
     * @returns the file path
     */
    static get(key: string): Promise<string>;

    /**
     * Gets the cached file content by cache key
     *
     * @param key the cache key to use
     *
     * @returns the file content as string
     */
    static getContentAsString(key: string): Promise<string>;

    /**
     * Gets the last modified timestamp for a given cache key
     *
     * @param key the cache key to use
     *
     * @return the last modified timestamp
     */
    static getLastModifiedTimeStamp(key): Promise<number>;

Usage

getOrCache

Saves the file from the given URI or retrieves the cached file content if already present. Note that the key must be unique, otherwise files will be overwritten with different content.

import {FileCacheManager} from '@meecode/expo-cached-remote-files'

  FileCacheManager
    .getOrCache(`https://xyz.test.at/api/v1/faqs?language=${i18n.locale}`, `faq-${i18n.locale}`)
    .then((response: any) => {
        if (response) {
           //TODO: implement
        } else {
            console.error('Response is empty', response);
        }
    });

get

Get a cached file uri by the key

import {FileCacheManager} from '@meecode/expo-cached-remote-files'

  FileCacheManager
    .get(`faq-${i18n.locale}`)
    .then((response: any) => {
        //TODO: implement
    });

getContentAsString

getLastModifiedTimeStamp

TODOs

See TODOs

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.