# cacha

**Repository Path**: mirrors_floatdrop/cacha

## Basic Information

- **Project Name**: cacha
- **Description**: Cache on file-system
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cacha [![Build Status](https://travis-ci.org/floatdrop/cacha.svg?branch=master)](https://travis-ci.org/floatdrop/cacha)

> Cache on file-system


## Install

```
$ npm install --save cacha
```


## Usage

```js
const Cache = require('cacha');
const cache = new Cacha('.my/cache');

cache.set('id', 'content');
//=> Promise

cache.get('id');
//=> Promise with 'content'
```


## API

### cacha(namespace, [options])

#### namespace

Type: `string`

Directory in HOME or TMP directory of current user.

If namespace begins with `/` it will be interpreted as absolute path.

#### options

##### ttl

Type: `Number`  
Default: `86400000`

How long (in milliseconds) keep entries in cache.


### cache.get(id, [options])

### cache.getSync(id, [options])

### cache.set(id, content, [options])

### cache.setSync(id, content, [options])

Get and set methods for cache entries. `options` are passed to `fs` write and read methods (for example to specify encoding).

### cache.clean()

Removes outdated entries in cache.

## License

MIT © [Vsevolod Strukchinsky](http://github.com/floatdrop)