[Suggestion] Add Typescript definition file

[someone1]

First off, thanks for the project!

Thought I'd share this and hope to make this package typescript friendly. Not sure if this is all that's required to get this working, but it did a lot for me. This assumes that the 'name' option is left at 'ls'. I still had to import like const Storage = require('vue-ls') - not sure if the fix is with a definitions file or modification of the shipped package.

import _Vue, { PluginFunction } from 'vue';

declare module 'vue/types/vue' {
  interface Vue {
    $ls: WebStorage;
  }

  interface VueConstructor {
    ls: WebStorage;
  }
}

declare class WebStorage {
  public length: number;

  constructor(storage: Storage);
  get(name: string, def?: any): any | null;
  set(name: string, value: any, expire?: number): void;
  key(index: number): string | null;
  remove(name: string): void;
  clear(): void;
  on(name: string, callback: Function): void;
  off(name: string, callback: Function): void;
}

declare interface StorageOptions {
  namespace?: string;
  name?: string;
  storage?: StorageTypes;
}

export enum StorageTypes {
  Session = 'session',
  Local = 'local',
  Memory = 'memory',
}

declare const _default: {
  install: PluginFunction<StorageOptions>;
};

export default _default;

[RobinCK]

Thank you!
I will soon study the question and think about what can be done

[demiro]

Yeah, TS support is important... I am getting erros while using it with TS

INE/timeline-vue/src/main.ts
3:21 Could not find a declaration file for module 'vue-ls'. 'C:/xx/_xx/xx-vue/node_modules/vue-ls/dist/vue-ls.js' implicitly has an 'any' type.
Try npm install @types/vue-ls if it exists or add a new declaration (.d.ts) file containing declare module 'vue-ls';

[mzhukovs]

@RobinCK any plans for this? would be much appreciated

[RobinCK]

At the moment I don't have plans to add typings.
But PR is always welcome

[gopalakrishnanr-paypaycorp]

@RobinCK Do you have any idea about below error?

Yes need typescript support, i have also facing that issue only

#23 (comment)

I did that now im not getting that issue after declaring like declare module 'vue-ls'; But below error still getting

147:9 Element implicitly has an 'any' type because expression of type '"$ls"' can't be used to index type BannerComponent

Property '$ls' does not exist on type 'BannerComponent'.