Skip to content
This repository has been archived by the owner on Mar 16, 2020. It is now read-only.

Latest commit

 

History

History
71 lines (54 loc) · 1.6 KB

README.md

File metadata and controls

71 lines (54 loc) · 1.6 KB

Now

CircleCI AppVeyor Build status TravisCI Build status

Works with:

Vue 2 Vue 1

This mixin will create a computed property with a Moment.js instance. The computed property will be updated at a given interval to stay up to date.

Installation

npm install @skyrpex/now

Usage

Minimal setup

<template>
  <div>
    <!-- Print the current time, and update each second. -->
    <p>{{ now }}</p>
  </div>
</template>

<script>
import now from '@skyrpex/now';

export default {
  mixins: [
    // Will inject a 'now' computed property
    now({ /* options... */ }),
  ],
};
</script>

Another use case

<template>
  <div>
    <!-- You can use any Moment.js method -->
    <p>{{ now.from(createdAt) }}</p>
  </div>
</template>

<script>
import moment from 'moment';
import now from '@skyrpex/now';

export default {
  mixins: [now()],
  data: () => ({
    createdAt: moment([2007, 0, 28]),
  }),
};
</script>

Options

import now from '@skyrpex/now';

now({
  name: 'now', // Name of the computed property
  interval: 1000, // Update interval
});