Add seamless-immutable type definition file

[alex3165]

case 1. Add a new type definition.

• checked compilation succeeds with --target es6 and --noImplicitAny options.
• has correct naming convention
• has a test file with the suffix of -tests.ts or -tests.tsx.

case 2. Improvement to existing type definition.

• documentation or source code reference which provides context for the suggested changes. url http://api.jquery.com/html .
  • it has been reviewed by a DefinitelyTyped member.

[dt-bot]

seamless-immutable/seamless.d.ts

Checklist

• is correct naming convention?
  • https://www.npmjs.com/package/seamless-immutable - https://github.com/rtfeldman/seamless-immutable
• has a test file? (seamless-immutable/seamless-tests.ts or seamless-immutable/seamless-tests.tsx)
• pass the Travis CI test?

[mhegazy]

the file name should be seamless-immutable\seamless-immutable.d.ts

[mhegazy]

For legal reasons, we can not have different licence text for packages. all packages use the MIT licence under: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/LICENSE

[mhegazy]

So we will not be able to accept this PR as long as it has this specialized licence text.

[mhegazy]

I would recommend changing these into one signature with rest args:

update(property: string, updaterFunction: (value: any, ...additionalParamters: any[]) => any, ...additionalArguments: any[]): ImmutableObject<T>;

[mhegazy]

this is already covered by without(...properties: string[]): ImmutableObject<any>;

[alex3165]

@mhegazy Thank you for your advice I have made the changes.

[mhegazy]

thanks. can you please address the failing CI tests.

[alex3165]

@mhegazy Fixed

[toranb]

Anyone have an example app using this w/ TS 2x ? Just looking around for some samples to see how you would import and use use something like SI.ImmutableObject with ES2015+ syntax and TS 2.1

note: mostly asking because I ran into this error building a TS 2.1 app using this type def

import Immutable from 'seamless-immutable';

const initialState = Immutable({
});

Cannot invoke an expression whose type lacks a call signature. Type 'typeof SeamlessImmutable' has no compatible call signatures.

@types/seamless-immutable v6.1.2

UPDATE

I was able to get this working by altering my import like so

import * as SI from 'seamless-immutable';

const initialState = SI.from({
});

My first pass at typescript + seamless immutable (along with redux/and emberJS) for those who may find this later. I had to do an interesting hack to get this working (note this toward the top of the file)

toranb/ember-redux-yelp@0fe9bfa

import * as SI from 'seamless-immutable';

const Immutable = SI['default'] ? SI['default'] : SI;

const initialState = Immutable({
});

UPDATE July 2017

I ended up writing a set of type defs for seamless-immutable 7

https://github.com/toranb/seamless-immutable-tsdefs

I've had success writing product types like you see below

import { ImmutableObject } from 'seamless-immutable';

type ImmutableState<T> = ImmutableObject<T> & T;

export default ((state: ImmutableState<UserState>, action: Action): ImmutableState<UserState> => {
  switch(action.type) {
    case 'ASSIGN_USER': {
      return state.merge({number: action.number});
    }
    default: {
      return state || initialState;
    }
  }
});