Mandatory String type is hard to manage with typescript

[neilime]

Hi,

I have an issue with your plugin, used with typescript.
Typing a property as String is mandatory and your plugin throws an exception if not.
However, your plugin transform the property that is not a string, but an object like :

{ en: 'string', fr: 'string' }

The typescript definition should be something like that :

IntlString = {
    [key: string]: String;
};

Can you provide these interface and allows it as property type, it may be helps us to fix this related issue : szokodiakos/typegoose#85

Thanks

[kalicki]

Check my module for this... @neilime

/// <reference types="mongoose" />

declare module 'mongoose' {
  import mongoose = require('mongoose');
  import mongooseIntl = require('mongoose-intl');

  // methods
  export interface MongooseIntlDocument extends Document {
    getLanguages(): [string];
    getLanguage(): string;
    setLanguage(lang: string): void;
    unsetLanguage(): void;
  }

  // statics
  interface MongooseIntlModel<T extends Document> extends Model<T> {
    getLanguages(): [string];
    getDefaultLanguage(): string;
    setDefaultLanguage(lang: string): void;
  }

  interface mongoose extends NodeJS.EventEmitter, ModelProperties {
    getLanguages(): [string];
    getDefaultLanguage(): string;
    setDefaultLanguage(lang: string): void;
  }

  export interface MongooseIntlOptions {
    languages: [string];
    defaultLanguage: string;
  }

  export interface MongooseIntlSchema extends Schema {
    plugin(
      plugin: (
        schema: MongooseIntlSchema,
        options: MongooseIntlOptions
      ) => void,
      options: MongooseIntlOptions
    ): this;

    // overload for the default mongoose plugin function
    plugin(
      plugin: (schema: Schema, options: Object) => void,
      opts?: Object
    ): this;
  }

  export function model(
    name: string,
    schema?: Schema,
    collection?: string,
    skipIntl?: boolean
  ): MongooseIntlModel<any>;

  export function setDefaultLanguage(lang: string): typeof mongoose;
}

declare module 'mongoose-intl' {
  import mongoose = require('mongoose');
  var _: (schema: mongoose.Schema, options: Object) => void;
  export = _;
}

[manishoo]

@kalicki How do I use that code?

[shahidcodes]

@manishoo put the above module declaration in global.d.ts. Typescript will automatically pick it.