v0.4 Cleanup ​

This release is technical. It includes only deletions of deprecated features and general refactoring of the API. This release intentionally does not include any new features, so you can upgrade your codebase without any pressure.

Migration guide ​

There are a bunch of breaking changes, but they are all minor and should not affect your code much. Furthermore, they are the soundness as promised. Please read the migration guide carefully before upgrading.

Effector 22.4 ​

This release requires with Effector 22.4 or higher. If you are using Effector 22.3, you have to upgrade to 22.4.

Use modern overload of retry ​

retry(config) overload has been deleted in favor of retry(operation, config) to support retrying of Mutations as well as Queries.

retry(
  someQuery, 
  {
    query: someQuery, 
    times: 3,
    delay: 1000,
  }
);

Change signature of mapParams option in retry ​

mapData now accepts { result, params } object instead of two separate arguments to be consistent with .finished.* Events and Validator.

function mapper(
  {
    error,
    params,
    meta, 
  },
  meta 
) {
  // ...
}

const mapper = {
  source: $externalStore,
  fn(
    {
      error,
      params,
      meta, 
    },
    meta, 
    externalSource
  ) {
    // ...
  },
};

Change signature of .finished.success ​

.finished.success now has a payload of type { result: Data, params: Params } instead of { data: Data, params: Params } to be consistent with .done of Effect.

query.finished.success.watch(
  ({
    data, 
    result, 
  }) => {
    // ...
  }
);

Change signature of Validator ​

Validator now accepts { result, params } object instead of two separate arguments to be consistent with .finished.* Events.

function validator(
  result, 
  params, 
  { result, params } 
) {
  // ...
}

const validator = {
  source: $externalStore,
  fn(
    result, 
    params, 
    { result, params }, 
    externalSource
  ) {
    // ...
  },
};

Change signature of mapper in mapData ​

mapData now accepts { result, params } object instead of two separate arguments to be consistent with .finished.* Events and Validator.

function mapper(
  result, 
  params, 
  { result, params } 
) {
  // ...
}

const mapper = {
  source: $externalStore,
  fn(
    result, 
    params, 
    { result, params }, 
    externalSource
  ) {
    // ...
  },
};

Change signature of mapper in connectQuery ​

fn now accepts { result } object instead of just a result as first argument in single-parent more. In multi-parent mode, fn now accepts { parentName: { result } } object instead of object with results as first argument.

It will allow us to add more properties to the object in the future without breaking changes, e.g. params of the parent Query.

connectQuery({
  source: languagesQuery,
  fn(language) {
    return { params: { lang: language } }; 
    return { params: { lang: language.result } }; 
  },
  target: contentQuery,
});

connectQuery({
  source: { language: languagesQuery, blocks: blocksQuery },
  fn({ language, blocks }) {
    return { params: { lang: language, ids: blocks } }; 
    return { params: { lang: language.result, ids: blocks.result } }; 
  },
  target: contentQuery,
});

Change signature of mappers in mapParams ​

mapParams now accepts { result, params } object instead of two separate arguments to be consistent with .finished.* Events and Validator.

function mapper(
  result, 
  params, 
  { result, params } 
) {
  // ...
}

const mapper = {
  source: $externalStore,
  fn(
    result, 
    params, 
    { result, params }, 
    externalSource
  ) {
    // ...
  },
};

Full changelog ​

0.4.1 ​

0.4.0 ​