如何使用facebook / immutable-js创建自定义不可变类型?

时间:2015-08-04 17:55:51

标签: javascript immutability immutable.js

我试图创建一个简单的不可变Interval类型。它有一个开始和结束属性。有没有一种直接的方法来利用immutable-js库来创建自己的自定义不可变类型?

我目前尝试使用包含Immutable.Map和Immutable.List的包含模式的效果不是很好。例如,difference应返回一个不可变的Intervals列表,但由于它创建了Interval的新实例,它返回的List将不会传递相等。

感觉我采取了错误的方法,但我不确定如何。我可以使用Immutable.Map轻松表示数据,但我希望在其公共接口中包含difference,而不包括get和set等常规Map方法。即我希望它是不可变的,但它是自己的类型,有自己的接口。

var Immutable = require('immutable')

function Interval(start, end) {
  this.value = Immutable.Map({
    start: start,
    end: end
  })
}

Interval.prototype.start = function () {
  return this.value.get('start')
}

Interval.prototype.end = function () {
  return this.value.get('end')
}

Interval.prototype.equals = function(interval) {
  return this.value.equals(interval.value)
}

Interval.prototype.difference = function (subtrahend) {
  var nonoverlapping = subtrahend.start() > this.end() || subtrahend.end() < this.start()

  return nonoverlapping ? Immutable.List.of(this) :
    Immutable.List.of(
      new Interval(this.start(), subtrahend.start()),
      new Interval(subtrahend.end(), this.end())
    )
    .filter(function(interval) {
      return interval.end() > interval.start()
    })
}

一些测试:

it('should return an empty array for an exact difference', function() {
  var interval = new Interval(80, 90)
  interval.difference(interval)
    .equals(Immutable.List())
    .should.be.true
})

it('should return an array with the same Interval for a missed difference', function() {
  var interval = new Interval(80, 90)
  console.log(interval.difference(new Interval(50, 60)).toJS());
  interval.difference(new Interval(50, 60))
    .equals(Immutable.List.of([
      { value: Immutable.Map({ start: 80, end: 90 }) }
    ]))
    .should.be.true
})

3 个答案:

答案 0 :(得分:2)

为什么不使用Record类型:

var Interval = Immutable.Record({start: 0, end: 1})

这会为您创建记录类型,分别定义默认值为0和1的startend属性。

现在要创建Interval的实例,只需执行:

var newInterval = new Interval() //will have default values above
var newInterval = new Interval({start: 10, end: 30)

请注意,Record类型的实例只是值类型,因此它们应该只包含数据。当然,您可以定义对此数据值进行操作的函数。

var difference = function (interval1, interval2) {
  var nonoverlapping = interval2.start > interval1.end || interval2.end < interval1.start

  return nonoverlapping ? Immutable.List.of(interval1) :
    Immutable.List([
      new Interval({start: interval1.start, end: interval2.start}),
      new Interval({start: interval2.end, end: interval1.end})
    ])
    .filter(function(interval) {
      return interval.end > interval.start
    });
}

使用Immutable.is(interval1, interval2)

免费获得平等

有关记录类型的更多信息:http://facebook.github.io/immutable-js/docs/#/Record

答案 1 :(得分:0)

您可以使用"extendable-immutable" library

然后很容易:

const {Map} = require('extendable-immutable');

class Interval extends Map {
    constructor(start, end) {
        super({
            value: new Map({start: start, end: end})
        });
    }

    start() {
        return this.get('value').get('start');
    }

    end() {
        return this.get('value').get('end');
    }

    //...
}

如果您在像我这样的字段上选择方法(例如开始,结束),我不建议使用Record。如果使用Record实现它,您将拥有自动显示的字段。

您可能希望使用value字段创建记录自定义类,而不是公开_value字段,但并非总是可行。参见:

https://github.com/facebook/immutable-js/issues/970

答案 2 :(得分:0)

实施方法valueOf

例如:

Interval.prototype.valueOf = function() {
  return Map({ class: Interval, value: this.value });
}

并进行测试:

Immutable.is(new Interval(80, 90), new Interval(80, 90)); // true

另一种选择是通过实现方法equalshashCode将类转换为ValueObject(使用函数Immutable.isImmutable.hash进行实现) )。