text stringlengths 9 39.2M | dir stringlengths 26 295 | lang stringclasses 185
values | created_date timestamp[us] | updated_date timestamp[us] | repo_name stringlengths 1 97 | repo_full_name stringlengths 7 106 | star int64 1k 183k | len_tokens int64 1 13.8M |
|---|---|---|---|---|---|---|---|---|
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class ColumnFillSpaceStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
if (abstractLayouter.getRowSize() == 1) return;
int difference = GravityUtil.getVerticalDifference(abstractLayouter) / (abstractLayouter.getRowSize() - 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
if (childRect.top == abstractLayouter.getCanvasTopBorder()) {
//highest view of row
int topDif = childRect.top - abstractLayouter.getCanvasTopBorder();
//press view to top border
childRect.top = abstractLayouter.getCanvasTopBorder();
childRect.bottom -= topDif;
continue;
}
offsetDifference += difference;
childRect.top += offsetDifference;
childRect.bottom += offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/ColumnFillSpaceStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 252 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import android.support.annotation.IntRange;
public interface IGravityModifier {
/** @return created rect based on modified input rect due to concrete gravity modifier.
* @param childRect input rect. Immutable*/
Rect modifyChildRect(@IntRange(from = 0) int minTop, @IntRange(from = 0) int maxBottom, Rect childRect);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/IGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 92 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.SpanLayoutChildGravity;
/** class which determines child gravity inside row from child position */
public interface IChildGravityResolver {
@SpanLayoutChildGravity
int getItemGravity(int position);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/IChildGravityResolver.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 60 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
class CenterInColumnGravityModifier implements IGravityModifier {
@Override
public Rect modifyChildRect(int minStart, int maxEnd, Rect childRect) {
childRect = new Rect(childRect);
int placeWidth = maxEnd - minStart;
int rectWidth = childRect.right - childRect.left;
int halfOffset = (placeWidth - rectWidth)/2;
childRect.left = minStart + halfOffset;
childRect.right = maxEnd - halfOffset;
return childRect;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/CenterInColumnGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 128 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.ChipsLayoutManager;
import com.beloo.widget.chipslayoutmanager.RowStrategy;
public class RTLRowStrategyFactory implements IRowStrategyFactory {
@Override
public IRowStrategy createRowStrategy(@RowStrategy int rowStrategy) {
switch (rowStrategy) {
case ChipsLayoutManager.STRATEGY_CENTER:
return new RTLRowFillSpaceCenterStrategy();
case ChipsLayoutManager.STRATEGY_FILL_SPACE:
return new RTLRowFillSpaceStrategy();
case ChipsLayoutManager.STRATEGY_FILL_VIEW:
return new RTLRowFillStrategy();
case ChipsLayoutManager.STRATEGY_CENTER_DENSE:
return new RTLRowFillSpaceCenterDenseStrategy();
case ChipsLayoutManager.STRATEGY_DEFAULT:
default:
return new EmptyRowStrategy();
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/RTLRowStrategyFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 179 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class RTLRowFillSpaceCenterStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
int difference = GravityUtil.getHorizontalDifference(abstractLayouter) / (abstractLayouter.getRowSize() + 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
offsetDifference += difference;
childRect.right -= offsetDifference;
childRect.left -= offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/RTLRowFillSpaceCenterStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 163 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class ColumnFillSpaceCenterDenseStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
int difference = GravityUtil.getVerticalDifference(abstractLayouter) / 2;
for (Item item : row) {
Rect childRect = item.getViewRect();
childRect.top += difference;
childRect.bottom += difference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/ColumnFillSpaceCenterDenseStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 140 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class LTRRowFillSpaceStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
if (abstractLayouter.getRowSize() == 1) return;
int difference = GravityUtil.getHorizontalDifference(abstractLayouter) / (abstractLayouter.getRowSize() - 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
if (childRect.left == abstractLayouter.getCanvasLeftBorder()) {
//left view of row
int leftDif = childRect.left - abstractLayouter.getCanvasLeftBorder();
//press view to left border
childRect.left = abstractLayouter.getCanvasLeftBorder();
childRect.right -= leftDif;
continue;
}
offsetDifference += difference;
childRect.left += offsetDifference;
childRect.right += offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/LTRRowFillSpaceStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 254 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
class TopGravityModifier implements IGravityModifier {
@Override
public Rect modifyChildRect(int minStart, int maxEnd, Rect childRect) {
if (childRect.left < minStart) {
throw new IllegalArgumentException("top point of input rect can't be lower than minTop");
}
if (childRect.right > maxEnd) {
throw new IllegalArgumentException("bottom point of input rect can't be bigger than maxTop");
}
childRect = new Rect(childRect);
if (childRect.top > minStart) {
childRect.bottom -= (childRect.top - minStart);
childRect.top = minStart;
}
return childRect;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/TopGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 162 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.view.Gravity;
import com.beloo.widget.chipslayoutmanager.SpanLayoutChildGravity;
public class CenterChildGravity implements IChildGravityResolver {
@Override
@SpanLayoutChildGravity
public int getItemGravity(int position) {
return Gravity.CENTER_VERTICAL;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/CenterChildGravity.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 71 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.ChipsLayoutManager;
import com.beloo.widget.chipslayoutmanager.RowStrategy;
public class ColumnStrategyFactory implements IRowStrategyFactory {
@Override
public IRowStrategy createRowStrategy(@RowStrategy int rowStrategy) {
switch (rowStrategy) {
case ChipsLayoutManager.STRATEGY_CENTER:
return new ColumnFillSpaceCenterStrategy();
case ChipsLayoutManager.STRATEGY_CENTER_DENSE:
return new ColumnFillSpaceCenterDenseStrategy();
case ChipsLayoutManager.STRATEGY_FILL_SPACE:
return new ColumnFillSpaceStrategy();
case ChipsLayoutManager.STRATEGY_FILL_VIEW:
return new ColumnFillStrategy();
case ChipsLayoutManager.STRATEGY_DEFAULT:
default:
return new EmptyRowStrategy();
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/ColumnStrategyFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 174 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.util.SparseArray;
import android.view.Gravity;
import com.beloo.widget.chipslayoutmanager.SpanLayoutChildGravity;
public class ColumnGravityModifiersFactory implements IGravityModifiersFactory {
private SparseArray<IGravityModifier> gravityModifierMap;
public ColumnGravityModifiersFactory() {
gravityModifierMap = new SparseArray<>();
CenterInColumnGravityModifier centerGravityModifier = new CenterInColumnGravityModifier();
gravityModifierMap.put(Gravity.CENTER, centerGravityModifier);
gravityModifierMap.put(Gravity.CENTER_HORIZONTAL, centerGravityModifier);
gravityModifierMap.put(Gravity.LEFT, new LeftGravityModifier());
gravityModifierMap.put(Gravity.RIGHT, new RightGravityModifier());
}
public IGravityModifier getGravityModifier(@SpanLayoutChildGravity int gravity) {
IGravityModifier gravityModifier = gravityModifierMap.get(gravity);
if (gravityModifier == null) {
gravityModifier = gravityModifierMap.get(Gravity.CENTER_HORIZONTAL);
}
return gravityModifier;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/ColumnGravityModifiersFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 213 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class LTRRowFillSpaceCenterDenseStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
int difference = GravityUtil.getHorizontalDifference(abstractLayouter) / 2;
for (Item item : row) {
Rect childRect = item.getViewRect();
childRect.left += difference;
childRect.right += difference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/LTRRowFillSpaceCenterDenseStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 142 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
abstract class GravityUtil {
static int getHorizontalDifference(AbstractLayouter layouter) {
return layouter.getCanvasRightBorder() - layouter.getCanvasLeftBorder() - layouter.getRowLength();
}
static int getVerticalDifference(AbstractLayouter layouter) {
return layouter.getCanvasBottomBorder() - layouter.getCanvasTopBorder() - layouter.getRowLength();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/GravityUtil.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 109 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.SpanLayoutChildGravity;
public class CustomGravityResolver implements IChildGravityResolver {
@SpanLayoutChildGravity
private int gravity;
public CustomGravityResolver(int gravity) {
this.gravity = gravity;
}
@Override
@SpanLayoutChildGravity
public int getItemGravity(int position) {
return gravity;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/CustomGravityResolver.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 93 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class RTLRowFillSpaceStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
if (abstractLayouter.getRowSize() == 1) return;
int difference = GravityUtil.getHorizontalDifference(abstractLayouter) / (abstractLayouter.getRowSize() - 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
if (childRect.right == abstractLayouter.getCanvasRightBorder()) {
//right view of row
int rightDif = abstractLayouter.getCanvasRightBorder() - childRect.right;
//press view to right border
childRect.left += rightDif;
childRect.right = abstractLayouter.getCanvasRightBorder();
continue;
}
offsetDifference += difference;
childRect.right -= offsetDifference;
childRect.left -= offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/RTLRowFillSpaceStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 254 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import com.beloo.widget.chipslayoutmanager.SpanLayoutChildGravity;
public interface IGravityModifiersFactory {
IGravityModifier getGravityModifier(@SpanLayoutChildGravity int gravity);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/IGravityModifiersFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 49 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
class CenterInRowGravityModifier implements IGravityModifier {
@Override
public Rect modifyChildRect(int minStart, int maxEnd, Rect childRect) {
if (childRect.top < minStart) {
throw new IllegalArgumentException("top point of input rect can't be lower than minTop");
}
if (childRect.bottom > maxEnd) {
throw new IllegalArgumentException("bottom point of input rect can't be bigger than maxTop");
}
childRect = new Rect(childRect);
int placeHeight = maxEnd - minStart;
int rectHeight = childRect.bottom - childRect.top;
//calculate needed offset
int halfOffset = (placeHeight - rectHeight)/2;
childRect.top = minStart + halfOffset;
childRect.bottom = maxEnd - halfOffset;
return childRect;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/CenterInRowGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 196 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class LTRRowFillSpaceCenterStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
int difference = GravityUtil.getHorizontalDifference(abstractLayouter) / (abstractLayouter.getRowSize() + 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
offsetDifference += difference;
childRect.left += offsetDifference;
childRect.right += offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/LTRRowFillSpaceCenterStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 164 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
class LeftGravityModifier implements IGravityModifier {
@Override
public Rect modifyChildRect(int minStart, int maxEnd, Rect childRect) {
childRect = new Rect(childRect);
if (childRect.left > minStart) {
childRect.right -= (childRect.left - minStart);
childRect.left = minStart;
}
return childRect;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/LeftGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 100 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
class RightGravityModifier implements IGravityModifier {
@Override
public Rect modifyChildRect(int minStart, int maxEnd, Rect childRect) {
childRect = new Rect(childRect);
if (childRect.right < maxEnd) {
childRect.left += maxEnd - childRect.right;
childRect.right = maxEnd;
}
return childRect;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/RightGravityModifier.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 99 |
```java
package com.beloo.widget.chipslayoutmanager.util;
import android.view.View;
import com.beloo.widget.chipslayoutmanager.layouter.IStateFactory;
public class StateHelper {
public static boolean isInfinite(IStateFactory stateFactory) {
return stateFactory.getSizeMode() == View.MeasureSpec.UNSPECIFIED
&& stateFactory.getEnd() == 0;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/StateHelper.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 78 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.layouter.AbstractLayouter;
import com.beloo.widget.chipslayoutmanager.layouter.Item;
import java.util.List;
class ColumnFillSpaceCenterStrategy implements IRowStrategy {
@Override
public void applyStrategy(AbstractLayouter abstractLayouter, List<Item> row) {
int difference = GravityUtil.getVerticalDifference(abstractLayouter) / (abstractLayouter.getRowSize() + 1);
int offsetDifference = 0;
for (Item item : row) {
Rect childRect = item.getViewRect();
offsetDifference += difference;
childRect.top += offsetDifference;
childRect.bottom += offsetDifference;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/gravity/ColumnFillSpaceCenterStrategy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 162 |
```java
package com.beloo.widget.chipslayoutmanager.util;
import android.support.v7.widget.RecyclerView;
public class LayoutManagerUtil {
/**
* perform changing layout with playing RecyclerView animations
*/
public static void requestLayoutWithAnimations(final RecyclerView.LayoutManager lm) {
lm.postOnAnimation(new Runnable() {
@Override
public void run() {
lm.requestLayout();
lm.requestSimpleAnimationsInNextLayout();
}
});
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/LayoutManagerUtil.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 95 |
```java
package com.beloo.widget.chipslayoutmanager.util.testing;
import android.support.v7.widget.RecyclerView;
public class EmptySpy implements ISpy {
@Override
public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
//do nothing
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/testing/EmptySpy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 59 |
```java
package com.beloo.widget.chipslayoutmanager.util;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.text.TextUtils;
public class AssertionUtils {
private AssertionUtils() {}
public static <T> void assertNotNull(@Nullable T object, @NonNull String parameterName) throws AssertionError {
if (object == null)
throw new AssertionError(parameterName + " can't be null.");
}
public static <T> void assertInstanceOf(@NonNull T object, @NonNull Class<?> clazz, @NonNull String parameterName) throws AssertionError {
check(!clazz.isInstance(object), parameterName + " is not instance of " + clazz.getName() + ".");
}
public static <T> void assertNotEquals(@NonNull T object, @NonNull T anotherObject, @NonNull String parameterName) throws AssertionError {
check(object == anotherObject || object.equals(anotherObject), parameterName + " can't be equal to " + String.valueOf(anotherObject) + ".");
}
public static void assertNotEmpty(String text, String parameterName) throws AssertionError {
check(TextUtils.isEmpty(text) || TextUtils.isEmpty(text.trim()), parameterName + " can't be empty.");
}
public static void check(boolean b, @NonNull String message) {
if (b)
throw new AssertionError(message);
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/AssertionUtils.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 271 |
```java
package com.beloo.widget.chipslayoutmanager.util.testing;
import android.support.v7.widget.RecyclerView;
public interface ISpy {
void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/testing/ISpy.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 43 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
interface LogWrapper {
int d (String tag, String msg);
int v (String tag, String msg);
int w (String tag, String msg);
int i (String tag, String msg);
int e (String tag, String msg);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/LogWrapper.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 68 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
public class LogSwitcherFactory {
public static final int ADAPTER_ACTIONS = 1;
public static final int ANCHOR_SCROLLING = 2;
public static final int FILL = 3;
public static final int PREDICTIVE_ANIMATIONS = 4;
public static final int SCROLLING = 5;
public static final int START_POSITION_LOGGER = 6;
Log.LogSwitcher logSwitcher(){
return new Log.LogSwitcher();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/LogSwitcherFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 117 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
class SilentLog implements LogWrapper {
@Override
public int d(String tag, String msg) {
//no op
return 0;
}
@Override
public int v(String tag, String msg) {
//no op
return 0;
}
@Override
public int w(String tag, String msg) {
//no op
return 0;
}
@Override
public int i(String tag, String msg) {
//no op
return 0;
}
@Override
public int e(String tag, String msg) {
//no op
return 0;
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/SilentLog.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 156 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
import android.util.Log;
class AndroidLog implements LogWrapper {
@Override
public int d(String tag, String msg) {
return Log.d(tag, msg);
}
@Override
public int v(String tag, String msg) {
return Log.v(tag, msg);
}
@Override
public int w(String tag, String msg) {
return Log.w(tag, msg);
}
@Override
public int i(String tag, String msg) {
return Log.i(tag, msg);
}
@Override
public int e(String tag, String msg) {
return Log.e(tag, msg);
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/AndroidLog.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 151 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
import com.beloo.widget.chipslayoutmanager.anchor.AnchorViewState;
public interface IFillLogger {
void onStartLayouter(int startPosition);
void onItemRequested();
void onItemRecycled();
void onFinishedLayouter();
void onAfterLayouter();
void onRemovedAndRecycled(int position);
void onAfterRemovingViews();
void onBeforeLayouter(AnchorViewState state);
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/IFillLogger.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 96 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
import android.util.SparseArray;
import android.view.View;
import com.beloo.widget.chipslayoutmanager.anchor.AnchorViewState;
import java.util.Locale;
class FillLogger implements IFillLogger {
private SparseArray<View> viewCache;
private int requestedItems;
private int recycledItems;
private int startCacheSize;
private int recycledSize;
FillLogger(SparseArray<View> viewCache) {
this.viewCache = viewCache;
}
@Override
public void onStartLayouter(int startPosition) {
requestedItems = 0;
recycledItems = 0;
startCacheSize = viewCache.size();
Log.d("fillWithLayouter", "start position = " + startPosition, LogSwitcherFactory.FILL);
Log.d("fillWithLayouter", "cached items = " + startCacheSize, LogSwitcherFactory.FILL);
}
@Override
public void onItemRequested() {
requestedItems++;
}
@Override
public void onItemRecycled() {
recycledItems++;
}
@Override
public void onFinishedLayouter() {
Log.d("fillWithLayouter",
String.format(Locale.getDefault(), "reattached items = %d : requested items = %d recycledItems = %d", startCacheSize - viewCache.size(), requestedItems, recycledItems),
LogSwitcherFactory.FILL);
}
@Override
public void onAfterLayouter() {
recycledSize = viewCache.size();
}
@Override
public void onRemovedAndRecycled(int position) {
Log.d("fillWithLayouter", " recycle position =" + viewCache.keyAt(position), LogSwitcherFactory.FILL);
recycledSize++;
}
@Override
public void onAfterRemovingViews() {
Log.d("fillWithLayouter", "recycled count = " + recycledSize, LogSwitcherFactory.FILL);
}
@Override
public void onBeforeLayouter(AnchorViewState anchorView) {
if (anchorView.getAnchorViewRect() != null) {
Log.d("fill", "anchorPos " + anchorView.getPosition(), LogSwitcherFactory.FILL);
Log.d("fill", "anchorTop " + anchorView.getAnchorViewRect().top, LogSwitcherFactory.FILL);
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/FillLogger.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 498 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
import com.beloo.widget.chipslayoutmanager.BuildConfig;
import java.util.HashSet;
import java.util.Set;
/** this class with static methods created only for fast replace of default android log */
public class Log {
private static LogSwitcher logSwitcher = new LogSwitcher();
@SuppressWarnings("ConstantConditions")
private static LogWrapper log = BuildConfig.isLogEnabled ? new AndroidLog() : new SilentLog();
///////////////////////////////////////////////////////////////////////////
// default android log delegates
///////////////////////////////////////////////////////////////////////////
@SuppressWarnings("WeakerAccess")
public static int d (String tag, String msg) {
return log.d(tag, msg);
}
@SuppressWarnings("WeakerAccess")
public static int v (String tag, String msg) {
return log.v(tag, msg);
}
@SuppressWarnings("WeakerAccess")
public static int w (String tag, String msg) {
return log.w(tag, msg);
}
@SuppressWarnings("WeakerAccess")
public static int i (String tag, String msg) {
return log.i(tag, msg);
}
public static int e (String tag, String msg) {
return log.e(tag, msg);
}
///////////////////////////////////////////////////////////////////////////
// android log delegates with switcher
///////////////////////////////////////////////////////////////////////////
@SuppressWarnings("WeakerAccess")
public static int d (String tag, String msg, int logCode) {
return logSwitcher.isEnabled(logCode) ? d(tag, msg) : 0;
}
@SuppressWarnings("WeakerAccess")
public static int v (String tag, String msg, int logCode) {
return logSwitcher.isEnabled(logCode) ? v(tag, msg) : 0;
}
@SuppressWarnings("WeakerAccess")
public static int w (String tag, String msg, int logCode) {
return logSwitcher.isEnabled(logCode) ? w(tag, msg) : 0;
}
@SuppressWarnings("WeakerAccess")
public static int i (String tag, String msg, int logCode) {
return logSwitcher.isEnabled(logCode) ? i(tag, msg) : 0;
}
public static void with(LogSwitcher logSwitcher) {
Log.logSwitcher = logSwitcher;
}
public static class LogSwitcher {
private Set<Integer> enabledLogs = new HashSet<>();
boolean isEnabled(int logCode) {
return enabledLogs.contains(logCode);
}
public LogSwitcher with(int logCode) {
enabledLogs.add(logCode);
return this;
}
public LogSwitcher without(int logCode) {
enabledLogs.remove(logCode);
return this;
}
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/Log.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 571 |
```java
package com.beloo.widget.chipslayoutmanager.util.log;
import android.support.annotation.NonNull;
import android.util.SparseArray;
import android.view.View;
public class LoggerFactory {
@NonNull
public IFillLogger getFillLogger(SparseArray<View> viewCache) {
return new FillLogger(viewCache);
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/main/java/com/beloo/widget/chipslayoutmanager/util/log/LoggerFactory.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 67 |
```java
package com.beloo.widget.chipslayoutmanager.layouter;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import static org.junit.Assert.*;
@RunWith(JUnit4.class)
public class DecrementalPositionIteratorTest extends AbstractPositionIteratorTest {
@Override
AbstractPositionIterator providePositionIterator(int maxPosition) {
return new DecrementalPositionIterator(maxPosition);
}
@Test(expected = IllegalStateException.class)
public void callingNextWhenNegativePositionReachedShouldThrowException() {
AbstractPositionIterator iterator = providePositionIterator(5);
assertTrue(iterator.next() == 0);
iterator.next();
}
@Test
public void nextShouldDecreaseResultPosition() {
AbstractPositionIterator iterator = providePositionIterator(5);
iterator.move(3);
assertTrue(iterator.next() == 3);
assertTrue(iterator.next() == 2);
}
@Test
public void hasNextShouldReturnTrueIfZeroPositionIsNotPrevious() {
AbstractPositionIterator iterator = providePositionIterator(2);
iterator.move(1);
assertTrue(iterator.hasNext());
iterator.next();
assertTrue(iterator.hasNext());
iterator.next();
assertFalse(iterator.hasNext());
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/test/java/com/beloo/widget/chipslayoutmanager/layouter/DecrementalPositionIteratorTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 252 |
```java
package com.beloo.widget.chipslayoutmanager.layouter;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import static org.junit.Assert.assertTrue;
@RunWith(JUnit4.class)
abstract class AbstractPositionIteratorTest {
abstract AbstractPositionIterator providePositionIterator(int maxPosition);
@Before
public void setUp() {}
@Test
public void moveShouldSetCurrentPosition() {
AbstractPositionIterator iterator = providePositionIterator(20);
iterator.move(10);
assertTrue(iterator.pos == 10);
iterator.move(0);
assertTrue(iterator.pos == 0);
iterator.move(19);
assertTrue(iterator.pos == 19);
}
@Test
public void nextAfterMoveShouldReturnTargetMovePosition() {
AbstractPositionIterator iterator = providePositionIterator(20);
iterator.move(10);
assertTrue(iterator.next() == 10);
iterator.move(0);
assertTrue(iterator.next() == 0);
iterator.move(19);
assertTrue(iterator.next() == 19);
}
@Test(expected = IllegalArgumentException.class)
public void negativeCountInitializationShouldThrowException() {
//arrange
providePositionIterator(-5);
}
@Test(expected = IllegalArgumentException.class)
public void negativePositionMoveShouldThrowException() {
//arrange
AbstractPositionIterator incrementalIterator = providePositionIterator(5);
incrementalIterator.move(-5);
}
@Test(expected = IllegalArgumentException.class)
public void movementEqualMaxCountShouldThrowException() {
AbstractPositionIterator iterator = providePositionIterator(5);
iterator.move(5);
}
@Test(expected = IllegalArgumentException.class)
public void movementAboveMaxCountShouldThrowException() {
AbstractPositionIterator iterator = providePositionIterator(5);
iterator.move(7);
}
@Test(expected = Exception.class)
public void testRemoveNotSupported() {
AbstractPositionIterator iterator = providePositionIterator(5);
iterator.remove();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/test/java/com/beloo/widget/chipslayoutmanager/layouter/AbstractPositionIteratorTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 420 |
```java
package com.beloo.widget.chipslayoutmanager;
public enum ParamsType {
VALID, INVALID
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/ParamsType.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 22 |
```java
package com.beloo.widget.chipslayoutmanager.layouter;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import static org.junit.Assert.*;
@RunWith(JUnit4.class)
public class IncrementalPositionIteratorTest extends AbstractPositionIteratorTest {
@Override
AbstractPositionIterator providePositionIterator(int maxPosition) {
return new IncrementalPositionIterator(maxPosition);
}
@Test
public void nextShouldReturnCurrentAndThanIncreasedValue() {
AbstractPositionIterator iterator = providePositionIterator(5);
int result = iterator.next();
assertTrue(result == 0);
result = iterator.next();
assertTrue(result == 1);
result = iterator.next();
assertTrue(result == 2);
}
@Test
public void hasNextShouldReturnTrueIfMaxCountNotReached() {
AbstractPositionIterator iteratorEmpty = providePositionIterator(0);
AbstractPositionIterator iterator = providePositionIterator(2);
assertTrue(iterator.hasNext());
assertFalse(iteratorEmpty.hasNext());
iterator.next();
assertTrue(iterator.hasNext());
iterator.next();
assertFalse(iterator.hasNext());
}
@Test(expected = IllegalStateException.class)
public void nextWhenMaxCountReachedShouldThrowException() {
AbstractPositionIterator iterator = providePositionIterator(2);
int result = iterator.next();
assertTrue(result == 0);
result = iterator.next();
assertTrue(result == 1);
iterator.next();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/test/java/com/beloo/widget/chipslayoutmanager/layouter/IncrementalPositionIteratorTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 297 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.ParamsType;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static com.beloo.widget.chipslayoutmanager.ParamsType.VALID;
@RunWith(Parameterized.class)
public class CenterInRowGravityModifierTest extends GravityModifierTest {
@Parameterized.Parameters
public static Iterable<Object[]> data() {
List<Object[]> list = new ArrayList<>();
list.addAll(Arrays.asList(new Object[][] {
{VALID, 0, 100, new Rect(0, 20, 0, 100), new Rect(0, 10, 0, 90)},
{VALID, 0, 100, new Rect(0, 20, 0, 80), new Rect(0, 20, 0, 80)},
{VALID, 0, 100, new Rect(0, 0, 0, 40), new Rect(0, 30, 0, 70)},
{VALID, 0, 100, new Rect(0, 10, 0, 20), new Rect(0, 45, 0, 55)},
{VALID, 0, 100, new Rect(0, 0, 0, 100), new Rect(0, 0, 0, 100)}
}));
list.addAll(GravityDataProvider.getInvalidGravityModifierParams());
return list;
}
public CenterInRowGravityModifierTest(ParamsType paramsType, int minTop, int maxBottom, Rect testRect, Rect expectedResultRect) {
super(paramsType, minTop, maxBottom, testRect, expectedResultRect);
}
@Override
protected IGravityModifier getGravityModifier() {
return new CenterInRowGravityModifier();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/CenterInRowGravityModifierTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 408 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.ParamsType;
import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import static com.beloo.widget.chipslayoutmanager.ParamsType.INVALID;
import static com.beloo.widget.chipslayoutmanager.ParamsType.VALID;
import static org.junit.Assert.assertEquals;
@RunWith(Parameterized.class)
abstract class GravityModifierTest {
private IGravityModifier gravityModifier;
@Before
public void setUp() {
gravityModifier = getGravityModifier();
}
protected abstract IGravityModifier getGravityModifier();
private ParamsType paramsType;
private int minTop;
private int maxBottom;
private Rect testRect;
private Rect expectedResultRect;
GravityModifierTest(ParamsType paramsType, int minTop, int maxBottom, Rect testRect, Rect expectedResultRect) {
this.paramsType = paramsType;
this.minTop = minTop;
this.maxBottom = maxBottom;
this.testRect = testRect;
this.expectedResultRect = expectedResultRect;
}
@Test(expected = IllegalArgumentException.class)
public void invalidDataForModifierShouldThrowIllegalArgumentException() {
Assume.assumeTrue(paramsType.equals(INVALID));
gravityModifier.modifyChildRect(minTop, maxBottom, testRect);
}
@Test
public void modifierShouldAlignInputRect() {
Assume.assumeTrue(paramsType.equals(VALID));
Rect resultRect = gravityModifier.modifyChildRect(minTop, maxBottom, testRect);
assertEquals(expectedResultRect, resultRect);
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/GravityModifierTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 348 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.ParamsType;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static com.beloo.widget.chipslayoutmanager.ParamsType.VALID;
import static org.junit.Assert.assertEquals;
/** test for {@link BottomGravityModifier}*/
@RunWith(Parameterized.class)
public class BottomGravityModifierTest extends GravityModifierTest {
public BottomGravityModifierTest(ParamsType paramsType, int minTop, int maxBottom, Rect testRect, Rect expectedResultRect) {
super(paramsType, minTop, maxBottom, testRect, expectedResultRect);
}
@Parameterized.Parameters
public static Iterable<Object[]> data() {
List<Object[]> list = new ArrayList<>();
list.addAll(Arrays.asList(new Object[][]{
{VALID, 0, 100, new Rect(0, 20, 0, 100), new Rect(0, 20, 0, 100)},
{VALID, 0, 100, new Rect(0, 20, 0, 80), new Rect(0, 40, 0, 100)},
{VALID, 0, 100, new Rect(0, 0, 0, 40), new Rect(0, 60, 0, 100)},
{VALID, 0, 100, new Rect(0, 10, 0, 20), new Rect(0, 90, 0, 100)},
{VALID, 0, 100, new Rect(0, 0, 0, 100), new Rect(0, 0, 0, 100)},
}));
list.addAll(GravityDataProvider.getInvalidGravityModifierParams());
return list;
}
@Override
protected IGravityModifier getGravityModifier() {
return new BottomGravityModifier();
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/BottomGravityModifierTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 418 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.view.Gravity;
import org.junit.Test;
import static org.junit.Assert.assertTrue;
public class RowGravityModifiersFactoryTest {
private RowGravityModifiersFactory factory = new RowGravityModifiersFactory();
@Test
public void factoryShouldReturnCenterModifierForCenterGravity() {
IGravityModifier gravityModifier = factory.getGravityModifier(Gravity.CENTER);
assertTrue(gravityModifier instanceof CenterInRowGravityModifier);
}
@Test
public void factoryShouldReturnCenterModifierForCenterVerticalGravity() {
IGravityModifier gravityModifier = factory.getGravityModifier(Gravity.CENTER_VERTICAL);
assertTrue(gravityModifier instanceof CenterInRowGravityModifier);
}
@Test
public void factoryShouldReturnTopModifierForTopGravity() {
IGravityModifier gravityModifier = factory.getGravityModifier(Gravity.TOP);
assertTrue(gravityModifier instanceof TopGravityModifier);
}
@Test
public void factoryShouldReturnBottomModifierForBottomGravity() {
IGravityModifier gravityModifier = factory.getGravityModifier(Gravity.BOTTOM);
assertTrue(gravityModifier instanceof BottomGravityModifier);
}
@Test
public void factoryShouldReturnCenterModifierForUnknownGravity() {
IGravityModifier gravityModifier = factory.getGravityModifier(Gravity.CENTER_HORIZONTAL);
assertTrue(gravityModifier instanceof CenterInRowGravityModifier);
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/RowGravityModifiersFactoryTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 276 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import com.beloo.widget.chipslayoutmanager.ParamsType;
import org.junit.runners.Parameterized;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import static com.beloo.widget.chipslayoutmanager.ParamsType.INVALID;
import static com.beloo.widget.chipslayoutmanager.ParamsType.VALID;
/** test for {@link TopGravityModifier}*/
public class TopGravityModifierTest extends GravityModifierTest {
@Parameterized.Parameters
public static Iterable<Object[]> data() {
List<Object[]> data = new ArrayList<>();
data.addAll(Arrays.asList(new Object[][] {
{VALID, 0, 100, new Rect(0, 20, 0, 100), new Rect(0, 0, 0, 80)},
{VALID, 0, 100, new Rect(0, 20, 0, 80), new Rect(0, 0, 0, 60)},
{VALID, 0, 100, new Rect(0, 0, 0, 40), new Rect(0, 0, 0, 40)},
{VALID, 0, 100, new Rect(0, 10, 0, 20), new Rect(0, 0, 0, 10)},
{VALID, 0, 100, new Rect(0, 0, 0, 100), new Rect(0, 0, 0, 100)}
}));
data.addAll(getInvalidGravityModifierParams());
return data;
}
public TopGravityModifierTest(ParamsType paramsType, int minTop, int maxBottom, Rect testRect, Rect expectedResultRect) {
super(paramsType, minTop, maxBottom, testRect, expectedResultRect);
}
@Override
protected IGravityModifier getGravityModifier() {
return new TopGravityModifier();
}
private static Collection<Object[]> getInvalidGravityModifierParams() {
return Arrays.asList(new Object[][]{
{INVALID, 0, 100, new Rect(-50, 0, 0, 0), new Rect(0, 0, 0, 0)},
{INVALID, 20, 100, new Rect(10, 0, 0, 0), new Rect(0, 0, 0, 0)},
{INVALID, 20, 100, new Rect(20, 0, 120, 0), new Rect(0, 0, 0, 0)}
});
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/TopGravityModifierTest.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 556 |
```java
package com.beloo.widget.chipslayoutmanager.gravity;
import android.graphics.Rect;
import java.util.Arrays;
import java.util.Collection;
import static com.beloo.widget.chipslayoutmanager.ParamsType.INVALID;
class GravityDataProvider {
static Collection<Object[]> getInvalidGravityModifierParams() {
return Arrays.asList(new Object[][]{
//start lower than minStart
{INVALID, 0, 100, new Rect(0, -50, 0, 0), new Rect(0, 0, 0, 0)},
//start lower than minStart
{INVALID, 20, 100, new Rect(0, 10, 0, 0), new Rect(0, 0, 0, 0)},
//end bigger than maxEnd
{INVALID, 20, 100, new Rect(0, 20, 0, 120), new Rect(0, 0, 0, 0)}
});
}
}
``` | /content/code_sandbox/ChipsLayoutManager/src/androidTest/java/com/beloo/widget/chipslayoutmanager/gravity/GravityDataProvider.java | java | 2016-08-03T19:23:43 | 2024-08-12T07:26:54 | ChipsLayoutManager | BelooS/ChipsLayoutManager | 3,247 | 208 |
```swift
//
// Project.swift
// Katana
//
// See the LICENSE file for more information.
import ProjectDescription
let iOSTargetVersion = "11.0"
// MARK: - Actions
let actions: [TargetAction] = [
.pre(
tool: "swiftlint",
arguments: ["--lenient"],
name: "SwiftLint"
),
.pre(
tool: "swiftformat",
arguments: ["."],
name: "SwiftFormat"
),
]
// MARK: - Main Target
let mainTarget = Target(
name: "Katana",
platform: .iOS,
product: .framework,
bundleId: "com.bendingspoonsapps.Katana",
deploymentTarget: .iOS(targetVersion: iOSTargetVersion, devices: [.iphone, .ipad, .mac]),
infoPlist: .default,
sources: ["Sources/**"],
actions: actions,
dependencies: [
.cocoapods(path: "."),
]
)
// MARK: - Tests Target
let testsTarget = Target(
name: "KatanaTests",
platform: .iOS,
product: .unitTests,
bundleId: "com.bendingspoonsapps.KatanaTests",
deploymentTarget: .iOS(targetVersion: iOSTargetVersion, devices: [.iphone, .ipad, .mac]),
infoPlist: .default,
sources: ["Tests/**"],
actions: actions,
dependencies: [
.target(name: mainTarget.name),
]
)
// MARK: - Project Definition
let project = Project(
name: "Katana",
organizationName: "BendingSpoons",
targets: [
mainTarget,
testsTarget,
],
schemes: [
.init(
name: "Katana",
buildAction: .init(targets: [.init(stringLiteral: mainTarget.name)]),
testAction: .init(targets: [.init(stringLiteral: testsTarget.name)])
),
]
)
``` | /content/code_sandbox/Project.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 428 |
```swift
// swift-tools-version:5.1
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "Katana",
platforms: [
.iOS(.v11),
.macOS(.v10_10),
],
products: [
.library(name: "Katana", targets: ["Katana"]),
],
dependencies: [
.package(url: "path_to_url", .upToNextMinor(from: "2.0.6")),
],
targets: [
.target(name: "Katana", dependencies: ["Hydra"], path: "Sources"),
.testTarget(name: "KatanaTests", dependencies: ["Katana"], path: "Tests"),
]
)
``` | /content/code_sandbox/Package.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 166 |
```shell
jazzy \
--author "Bending Spoons Team" \
--author_url path_to_url \
--github_url path_to_url \
--github-file-prefix path_to_url \
--module Katana \
--swift-build-tool spm \
--theme fullwidth \
--output docs/latest
``` | /content/code_sandbox/documentation.sh | shell | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 67 |
```json
PODS:
- HydraAsync (2.0.6)
DEPENDENCIES:
- HydraAsync (< 3, >= 2.0.6)
SPEC REPOS:
trunk:
- HydraAsync
SPEC CHECKSUMS:
HydraAsync: 8d589bd725b0224f899afafc9a396327405f8063
PODFILE CHECKSUM: 981516b2619126a434757841b709bef893cbec41
COCOAPODS: 1.10.1
``` | /content/code_sandbox/Podfile.lock | json | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 115 |
```ruby
Pod::Spec.new do |s|
s.name = 'Katana'
s.version = File.read(".version")
s.summary = 'Swift Apps in a swoosh'
s.description = <<-DESC
Katana is a modern Swift framework for writing iOS applications business logic that are testable and easy to reason about. Katana is strongly inspired by [Redux](path_to_url
In few words, the app state is entirely described by a single serializable data structure, and the only way to change the state is to dispatch an action. An action is an intent to transform the state, and contains all the information to do so. Because all the changes are centralized and are happening in a strict order, there are no subtle race conditions to watch out for.
We feel that Katana helped us a lot since we started using it in production. Our applications have been downloaded several milions of times and Katana really helped us scaling them quickly and efficiently. [Bending Spoons](path_to_url engineers leverage Katana capabilities to design, implement and test complex applications very quickly without any compromise to the final result.
We use a lot of open source projects ourselves and we wanted to give something back to the community, hoping you will find this useful and possibly contribute.
DESC
s.homepage = 'path_to_url
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.author = { 'Bending Spoons' => 'team@bendingspoons.com' }
s.source = { :git => 'path_to_url :tag => s.version.to_s }
s.social_media_url = 'path_to_url
s.ios.deployment_target = '11.0'
s.osx.deployment_target = '10.10'
s.swift_version = '5.0'
s.source_files = ['Sources/**/*.{swift,h}']
s.dependency 'HydraAsync', '>= 2.0.6', '< 3'
end
``` | /content/code_sandbox/Katana.podspec | ruby | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 433 |
```html
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0; url=latest/index.html" />
<title>Documentation</title>
</head>
<body>
If you are not redirected automatically, follow the <a href='latest/index.html'>link to the latest available version</a>
</body>
</html>
``` | /content/code_sandbox/docs/index.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 93 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Enumerations Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
<a title="Enumerations Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Enumerations Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Enumerations</h1>
<p>The following enumerations are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana18DispatchableLoggerO"></a>
<a name="//apple_ref/swift/Enum/DispatchableLogger" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana18DispatchableLoggerO">DispatchableLogger</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Interceptor that logs all the dispatched items in the XCode console.</p>
<a href="Enums/DispatchableLogger.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DispatchableLogger</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L12-L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Enums.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,573 |
```yaml
included:
- Sources
- Tests
- Package.swift
- Project.swift
only_rules:
# Prefer using AnyObject over class for class-only protocols
# - anyobject_protocol // Already enforced by swiftformat
# Prefer using Array(seq) over seq.map { $0 } to convert a sequence into an Array
# - array_init
# Attributes should be on their own lines in functions and types, but on the same line as variables and imports
# - attributes
# Test classes must implement balanced setUp and tearDown methods.
# - balanced_xctest_lifecycle
# Prefer the new block based KVO API with keypaths when using Swift 3.2 or later
# - block_based_kvo
# Warn about listing a non-constant (var) variable in a closure's capture list. This captures the variable's value at closure creation time instead of closure call time, which may be unexpected.
- capture_variable
# Delegate protocols should be class-only so they can be weakly referenced
- class_delegate_protocol
# Closing brace with closing parenthesis should not have any whitespaces in the middle
- closing_brace
# Closure bodies should not span too many lines
# - closure_body_length
# Closure end should have the same indentation as the line that started it
# - closure_end_indentation
# Closure parameters should be on the same line as opening brace
- closure_parameter_position
# Closure expressions should have a single space inside each brace
- closure_spacing
# All elements in a collection literal should be vertically aligned
- collection_alignment
# Colons should be next to the identifier when specifying a type and next to the key in dictionary literals
- colon
# There should be no space before and one after any comma
- comma
# Prefer at least one space after slashes for comments
- comment_spacing
# The initializers declared in compiler protocols such as ExpressibleByArrayLiteral shouldnt be called directly
- compiler_protocol_init
# Getter and setters in computed properties and subscripts should be in a consistent order
- computed_accessors_order
# Conditional statements should always return on the next line
# - conditional_returns_on_newline
# Prefer contains over comparing filter(where:).count to 0
- contains_over_filter_count
# Prefer contains over using filter(where:).isEmpty
- contains_over_filter_is_empty
# Prefer contains over first(where:) != nil and firstIndex(where:) != nil
- contains_over_first_not_nil
# Prefer contains over range(of:) != nil and range(of:) == nil
- contains_over_range_nil_comparison
# if, for, guard, switch, while, and catch statements shouldnt unnecessarily wrap their conditionals or arguments in parentheses
- control_statement
# Types used for hosting only static members should be implemented as a caseless enum to avoid instantiation
- convenience_type
# Create custom rules by providing a regex string. Optionally specify what syntax kinds to match against, the severity level, and what message to display
# - custom_rules
# Complexity of function bodies should be limited
# - cyclomatic_complexity
# Availability checks or attributes shouldnt be using older versions that are satisfied by the deployment target
- deployment_target
# When registering for a notification using a block, the opaque observer that is returned should be stored so it can be removed later
- discarded_notification_center_observer
# Prefer assertionFailure() and/or preconditionFailure() over assert(false)
- discouraged_assert
# Discouraged direct initialization of types that can be harmful
- discouraged_direct_init
# Prefer initializers over object literals.
- discouraged_object_literal
# Prefer non-optional booleans over optional booleans.
- discouraged_optional_boolean
# Prefer empty collection over optional collection.
- discouraged_optional_collection
# Enum cant contain multiple cases with the same name
- duplicate_enum_cases
# Imports should be unique
- duplicate_imports
# Avoid using dynamic and @inline(__always) together
# - dynamic_inline
# Prefer checking isEmpty over comparing collection to an empty array or dictionary literal
- empty_collection_literal
# Prefer checking isEmpty over comparing count to zero
- empty_count
# Arguments can be omitted when matching enums with associated values if they are not used
# - empty_enum_arguments
# Prefer () -> over Void ->.
- empty_parameters
# When using trailing closures, empty parentheses should be avoided after the method call
- empty_parentheses_with_trailing_closure
# Prefer checking isEmpty over comparing string to an empty string literal
- empty_string
# Empty XCTest method should be avoided
- empty_xctest_method
# Number of associated values in an enum case should be low
# - enum_case_associated_values_count
# TODOs and FIXMEs should be resolved prior to their expiry date
# - expiring_todo
# All declarations should specify Access Control Level keywords explicitly
# - explicit_acl
# Enums should be explicitly assigned their raw values
# - explicit_enum_raw_value
# Explicitly calling .init() should be avoided
- explicit_init
# Instance variables and functions should be explicitly accessed with self.
- explicit_self
# Top-level declarations should specify Access Control Level keywords explicitly
# - explicit_top_level_acl
# Properties should have a type interface
# - explicit_type_interface
# Prefer to use extension access modifiers
# - extension_access_modifier
# Fallthrough should be avoided
- fallthrough
# A fatalError call should have a message
# - fatal_error_message
# Header comments should be consistent with project patterns.
# The SWIFTLINT_CURRENT_FILENAME placeholder can optionally be used in the required and forbidden patterns.
# It will be replaced by the real file name.
# - file_header
# Files should not span too many lines
# - file_length
# File name should match a type or extension declared in the file (if any)
# - file_name
# File name should not contain any whitespace
- file_name_no_space
# Specifies how the types within a file should be ordered
# - file_types_order
# Prefer using .first(where:) over .filter { }.first in collections
- first_where
# Prefer flatMap over map followed by reduce([], +)
- flatmap_over_map_reduce
# where clauses are preferred over a single if inside a for
- for_where
# Force casts should be avoided
- force_cast
# Force tries should be avoided
- force_try
# Force unwrapping should be avoided
- force_unwrapping
# Functions bodies should not span too many lines
- function_body_length
# Prefer to locate parameters with defaults toward the end of the parameter list
# - function_default_parameter_at_end
# Number of function parameters should be low
# - function_parameter_count
# Generic type name should only contain alphanumeric characters, start with an uppercase character and span between 1 and 20 characters in length
- generic_type_name
# Extensions shouldnt add @IBInspectable properties
# - ibinspectable_in_extension
# Comparing two identical operands is likely a mistake
- identical_operands
# Identifier names should only contain alphanumeric characters and start with a lowercase character or should only contain capital letters.
# In an exception to the above, variable names may start with a capital letter when they are declared static and immutable.
# Variable names should not be too long or too short
- identifier_name
# Computed read-only properties and subscripts should avoid using the get keyword
- implicit_getter
# Prefer implicit returns in closures, functions and getters
# - implicit_return
# Implicitly unwrapped optionals should be avoided when possible
- implicitly_unwrapped_optional
# Identifiers should use inclusive language that avoids discrimination against groups of people based on race, gender, or socioeconomic status
# - inclusive_language
# Indent code using either one tab or the configured amount of spaces, unindent to match previous indentations. Dont indent the first line
# - indentation_width
# If defer is at the end of its parent scope, it will be executed right where it is anyway
# - inert_defer
# Prefer using Set.isDisjoint(with:) over Set.intersection(_:).isEmpty
- is_disjoint
# Discouraged explicit usage of the default separator
# - joined_default_parameter
# Tuples shouldnt have too many members. Create a custom type instead
- large_tuple
# Prefer using .last(where:) over .filter { }.last in collections
- last_where
# Files should not contain leading whitespace
- leading_whitespace
# Struct extension properties and methods are preferred over legacy functions
- legacy_cggeometry_functions
# Struct-scoped constants are preferred over legacy global constants
- legacy_constant
# Swift constructors are preferred over legacy convenience functions
- legacy_constructor
# Prefer using the hash(into:) function instead of overriding hashValue
- legacy_hashing
# Prefer using the isMultiple(of:) function instead of using the remainder operator (%)
- legacy_multiple
# Struct extension properties and methods are preferred over legacy functions
- legacy_nsgeometry_functions
# Prefer using type.random(in:) over legacy functions
- legacy_random
# Let and var should be separated from other statements by a blank line
# - let_var_whitespace
# Lines should not span too many characters
- line_length
# Array and dictionary literal end should have the same indentation as the line that started it
- literal_expression_end_indentation
# Ensure definitions have a lower access control level than their enclosing parent
- lower_acl_than_parent
# MARK comment should be in valid format. e.g. // MARK: or // MARK: -
- mark
# Public declarations should be documented
- missing_docs
# Modifier order should be consistent
# - modifier_order // Already enforced by swiftformat
# Arguments should be either on the same line, or one per line
- multiline_arguments
# Multiline arguments should have their surrounding brackets in a new line
# - multiline_arguments_brackets
# Chained function calls should be either on the same line, or one per line
- multiline_function_chains
# Multiline literals should have their surrounding brackets in a new line
- multiline_literal_brackets
# Functions and methods parameters should be either on the same line, or one per line
- multiline_parameters
# Multiline parameters should have their surrounding brackets in a new line
- multiline_parameters_brackets
# Trailing closure syntax should not be used when passing more than one closure argument
- multiple_closures_with_trailing_closure
# Types should be nested at most 1 level deep, and functions should be nested at most 2 levels deep
# - nesting
# Prefer Nimble operator overloads over free matcher functions
# - nimble_operator
# Prefer not to use extension access modifiers
# - no_extension_access_modifier
# Fallthroughs can only be used if the case contains at least one other statement
# - no_fallthrough_only
# Extensions shouldnt be used to group code within the same source file
# - no_grouping_extension
# Dont add a space between the method name and the parentheses
- no_space_in_method_call
# An object should only remove itself as an observer in deinit
# - notification_center_detachment
# Static strings should be used as key/comment in NSLocalizedString in order for genstrings to work
# - nslocalizedstring_key
# Calls to NSLocalizedString should specify the bundle which contains the strings file
# - nslocalizedstring_require_bundle
# NSObject subclasses should implement isEqual instead of ==
# - nsobject_prefer_isequal
# Underscores should be used as thousand separator in large decimal numbers
# - number_separator
# Prefer object literals over image and color inits
- object_literal
# Opening braces should be preceded by a single space and on the same line as the declaration
# - opening_brace
# Operators should be surrounded by a single whitespace when they are being used
- operator_usage_whitespace
# Operators should be surrounded by a single whitespace when defining them
- operator_whitespace
# Matching an enum case against an optional enum without ? is supported on Swift 5.1 and above
- optional_enum_case_matching
# A doc comment should be attached to a declaration
- orphaned_doc_comment
# Some overridden methods should always call super
- overridden_super_call
# Extensions shouldnt override declarations
# - override_in_extension
# Combine multiple pattern matching bindings by moving keywords out of tuples
# - pattern_matching_keywords
# Prefer Nimble matchers over XCTAssert functions
# - prefer_nimble
# Prefer Self over type(of: self) when accessing properties or calling methods
- prefer_self_type_over_type_of_self
# Prefer .zero over explicit init with zero parameters (e.g. CGPoint(x: 0, y: 0))
- prefer_zero_over_explicit_init
# Top-level constants should be prefixed by k
# - prefixed_toplevel_constant
# IBActions should be private
# - private_action
# IBOutlets should be private to avoid leaking UIKit to higher layers
# - private_outlet
# Prefer private over fileprivate declarations
# - private_over_fileprivate
# Combine Subject should be private
# - private_subject
# Unit tests marked private are silently skipped
# - private_unit_test
# Creating views using Interface Builder should be avoided
# - prohibited_interface_builder
# Some methods should not call super
- prohibited_super_call
# When declaring properties in protocols, the order of accessors should be get set
- protocol_property_accessors_order
# Discouraged call inside describe and/or context block
# - quick_discouraged_call
# Discouraged focused test. Other tests wont run while this one is focused
# - quick_discouraged_focused_test
# Discouraged pending test. This test wont run while its marked as pending
# - quick_discouraged_pending_test
# Camel cased cases of Codable String enums should have raw value
# - raw_value_for_camel_cased_codable_enum
# Prefer using .allSatisfy() or .contains() over reduce(true) or reduce(false)
- reduce_boolean
# Prefer reduce(into:_:) over reduce(_:_:) for copy-on-write types
- reduce_into
# Prefer _ = foo() over let _ = foo() when discarding a result from a function
- redundant_discardable_let
# nil coalescing operator is only evaluated if the lhs is nil, coalescing operator with nil as rhs is redundant
- redundant_nil_coalescing
# Objective-C attribute (@objc) is redundant in declaration
- redundant_objc_attribute
# Initializing an optional variable with nil is redundant
- redundant_optional_initialization
# Property setter access level shouldnt be explicit if its the same as the variable access level
# - redundant_set_access_control
# String enum values can be omitted when they are equal to the enumcase name
- redundant_string_enum_value
# Variables should not have redundant type annotation
- redundant_type_annotation
# Returning Void in a function declaration is redundant
- redundant_void_return
# Classes should have an explicit deinit method
# - required_deinit
# Enums conforming to a specified protocol must implement a specific case(s)
# - required_enum_case
# Return arrow and return type should be separated by a single space or on a separate line
- return_arrow_whitespace
# Prefer shorthand operators (+=, -=, *=, /=) over doing the operation and assigning
- shorthand_operator
# Test files should contain a single QuickSpec or XCTestCase class
- single_test_class
# Prefer using min() or max() over sorted().first or sorted().last
- sorted_first_last
# Imports should be sorted.
# - sorted_imports // Already enforced by swiftformat
# Else and catch should be on the same line, one space after the previous declaration
- statement_position
# Operators should be declared as static functions, not free functions
- static_operator
# fileprivate should be avoided
# - strict_fileprivate
# @IBOutlets shouldnt be declared as weak
# - strong_iboutlet
# SwiftLint disable commands are superfluous when the disabled rule would not have triggered a violation
# in the disabled region. Use - if you wish to document a command
- superfluous_disable_command
# Case statements should vertically align with their enclosing switch statement, or indented if configured otherwise
- switch_case_alignment
# Cases inside a switch should always be on a newline
# - switch_case_on_newline
# Shorthand syntactic sugar should be used, i.e. [Int] instead of Array
- syntactic_sugar
# Test cases should only contain private non-test members
# - test_case_accessibility
# TODOs and FIXMEs should be resolved
- todo
# Prefer someBool.toggle() over someBool = !someBool
- toggle_bool
# Trailing closure syntax should be used whenever possible
# - trailing_closure
# Trailing commas in arrays and dictionaries should be avoided/enforced
# - trailing_comma
# Files should have a single trailing newline
- trailing_newline
# Lines should not have trailing semicolons
- trailing_semicolon
# Lines should not have trailing whitespace
- trailing_whitespace
# Type bodies should not span too many lines
# - type_body_length
# Specifies the order of subtypes, properties, methods & more within a type
# - type_contents_order
# Type name should only contain alphanumeric characters, start with an uppercase character and span between 3 and 40 characters in length
- type_name
# Unimplemented functions should be marked as unavailable
# - unavailable_function
# Avoid using unneeded break statements
- unneeded_break_in_switch
# Parentheses are not needed when declaring closure arguments
- unneeded_parentheses_in_closure_argument
# Prefer capturing references as weak to avoid potential crashes
# - unowned_variable_capture
# Catch statements should not declare error variables without type casting
# - untyped_error_in_catch
# Unused reference in a capture list should be removed
- unused_capture_list
# Unused parameter in a closure should be replaced with _
- unused_closure_parameter
# Unused control flow label should be removed
- unused_control_flow_label
# Declarations should be referenced at least once within all files linted
- unused_declaration
# When the index or the item is not used, .enumerated() can be removed
- unused_enumerated
# All imported modules should be required to make the file compile
- unused_import
# Prefer != nil over let _ =
- unused_optional_binding
# Setter value is not used
- unused_setter_value
# @IBInspectable should be applied to variables only, have its type explicit and be of a supported type
# - valid_ibinspectable
# Function parameters should be aligned vertically if theyre in multiple lines in a declaration.
# - vertical_parameter_alignment
# Function parameters should be aligned vertically if theyre in multiple lines in a method call
# - vertical_parameter_alignment_on_call
# Limit vertical whitespace to a single empty line
- vertical_whitespace
# Include a single empty line between switch cases
# - vertical_whitespace_between_cases
# Dont include vertical whitespace (empty line) before closing braces
- vertical_whitespace_closing_braces
# Dont include vertical whitespace (empty line) after opening braces
- vertical_whitespace_opening_braces
# Prefer -> Void over -> ()
- void_return
# Delegates should be weak to avoid reference cycles
- weak_delegate
# Prefer specific XCTest matchers over XCTAssertEqual and XCTAssertNotEqual
- xct_specific_matcher
# An XCTFail call should include a description of the assertion
- xctfail_message
# The variable should be placed on the left, the constant on the right of a comparison operator.
- yoda_condition
line_length: 130
identifier_name:
min_length: 1
max_length: 60
type_name:
min_length: 1
max_length: 60
generic_type_name:
max_length: 35
function_body_length:
warning: 100
``` | /content/code_sandbox/.swiftlint.yml | yaml | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,553 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
<a title="Extensions Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Extensions Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Extensions</h1>
<p>The following extensions are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/c:objc(cs)OS_dispatch_queue"></a>
<a name="//apple_ref/swift/Extension/DispatchQueue" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)OS_dispatch_queue">DispatchQueue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>DispatchQueue conformance to <code><a href="Protocols/AsyncProvider.html">AsyncProvider</a></code> so that <code>DispatchQueue.main</code> can be used</p>
<a href="Extensions/DispatchQueue.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DispatchQueue</span><span class="p">:</span> <span class="kt"><a href="Protocols/AsyncProvider.html">AsyncProvider</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Extensions.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,572 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Classes Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Classes</h1>
<p>The following classes are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana34EmptySideEffectDependencyContainerC"></a>
<a name="//apple_ref/swift/Class/EmptySideEffectDependencyContainer" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana34EmptySideEffectDependencyContainerC">EmptySideEffectDependencyContainer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An empty dependencies container. It can be used for testing purposes or you don’t need dependencies</p>
<a href="Classes/EmptySideEffectDependencyContainer.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">EmptySideEffectDependencyContainer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L26-L34">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC"></a>
<a name="//apple_ref/swift/Class/PartialStore" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC">PartialStore</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Helper Store type that is used as a partial type.</p>
<p>This type is very helpful when you want to pass the store to pieces of your application
that must be aware of the type of state that the app manages but they should not care about
the logic part (that is, the dependency container). A very common case is when you want to
pass the store to the UI of your application. The UI shouldn’t access to the dependency container
directly (it should dispatch a <code><a href="Protocols/SideEffect.html">SideEffect</a></code> instead) but you can still have type-safety over the
state type that is managed.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
you should not create this class directly. The class is meant to be used as a partial type
erasure system over <code><a href="Classes/Store.html">Store</a></code>
</div>
<a href="Classes/PartialStore.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">PartialStore</span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="Protocols/AnyStore.html">AnyStore</a></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L78-L162">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC"></a>
<a name="//apple_ref/swift/Class/Store" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC">Store</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The <code>Store</code> is a sort of single entry point that handles the logic of your application.
In Katana, all the various pieces of information that your application manages should be stored
in a single atom, called state (see also <code><a href="Protocols/State.html">State</a></code> protocol).</p>
<p>The <code>Store</code>, however, doesn’t really implements any application specific logic: this class
only manages operations that are requested by the application-specific logic. In particular,
you can require the <code>Store</code> to execute something by <code>dispatching a dispatchable item</code>.</p>
<p>Currently the store handles 2 types of dispatchable: <code>State Updater</code>, <code>Side Effect</code></p>
<h4 id='update-the-state' class='heading'>Update the state</h4>
<p>As written before, in Katana every relevant information in the application should be stored in the
Store’s state. The only way to update the state is to dispatch a <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>.
At this point the <code>Store</code> will execute the following operations:</p>
<ul>
<li>it executes the interceptors</li>
<li>it creates the new state, by invoking the <code>updateState</code> function of the <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code></li>
<li>it updates the state</li>
<li>it resolves the promise</li>
</ul>
<h4 id='handle-to-business-logic' class='heading'>Handle to Business Logic</h4>
<p>Non trivial applications require to interact with external services and/or implement complex logics.
The proper way to handle these is by dispatching a <code><a href="Protocols/SideEffect.html">SideEffect</a></code>.
The <code>Store</code> will execute the following operations:</p>
<ul>
<li>it executes the interceptors</li>
<li>it executes the <code><a href="Protocols/SideEffect.html">SideEffect</a></code> body</li>
<li>it resolves the promise</li>
</ul>
<h4 id='listen-for-updates' class='heading'>Listen for updates</h4>
<p>You can attach a listener that is invoked every time the state changes by using <code>addListener</code>.</p>
<h4 id='intercept-dispatchable' class='heading'>Intercept Dispatchable</h4>
<p>It is possible to intercept and reshape the behaviour of the <code>Store</code> by using a <code><a href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code>.
A <code><a href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code> is executed every time something has dispatched, and before it is actually
managed by the <code>Store</code>. Here you implement behaviours like logging, blocking items before they’re executed
and even change dynamically which dispatchable items arrive to the <code>Store</code> itself.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Protocols/StateUpdater.html">StateUpdater</a></code> for more information about how to implement an update of the state
</div><div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Protocols/SideEffect.html">SideEffect</a></code> for more information about how to implement a complex/asynchronous logic
</div>
<a href="Classes/Store.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Store</span><span class="o"><</span><span class="kt">S</span><span class="p">,</span> <span class="kt">D</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="Classes/PartialStore.html">PartialStore</a></span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span><span class="p">,</span> <span class="kt">D</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L211-L559">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Classes.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,545 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Katana Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a title="Katana Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Katana Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<p><img src="path_to_url" alt="Katana"></p>
<p><a href="path_to_url"><img src="path_to_url" alt="Twitter URL"></a>
<a href="path_to_url"><img src="path_to_url" alt="Build Status"></a>
<a href=""><img src="path_to_url" alt="Docs"></a>
<a href=""><img src="path_to_url" alt="CocoaPods"></a>
<a href="path_to_url"><img src="path_to_url" alt="Licence"></a></p>
<p>Katana is a modern Swift framework for writing iOS applications’ business logic that are testable and easy to reason about. Katana is strongly inspired by <a href="path_to_url">Redux</a>.</p>
<p>In few words, the app state is entirely described by a single serializable data structure, and the only way to change the state is to dispatch a <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>. A <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code> is an intent to transform the state, and contains all the information to do so. Because all the changes are centralized and are happening in a strict order, there are no subtle race conditions to watch out for.</p>
<p>We feel that Katana helped us a lot since we started using it in production. Our applications have been downloaded several millions of times and Katana really helped us scaling them quickly and efficiently. <a href="path_to_url">Bending Spoons</a>’s engineers leverage Katana capabilities to design, implement and test complex applications very quickly without any compromise to the final result. </p>
<p>We use a lot of open source projects ourselves and we wanted to give something back to the community, hoping you will find this useful and possibly contribute. </p>
<h2 id='overview' class='heading'>Overview</h2>
<p>Your entire app <code><a href="Protocols/State.html">State</a></code> is defined in a single struct, all the relevant application information should be placed here.</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">CounterState</span><span class="p">:</span> <span class="kt">State</span> <span class="p">{</span>
<span class="k">var</span> <span class="nv">counter</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span>
<span class="p">}</span>
</code></pre>
<p>The app <code><a href="Protocols/State.html">State</a></code> can only be modified by a <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>. A <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code> represents an event that leads to a change in the <code><a href="Protocols/State.html">State</a></code> of the app. You define the behaviour of the <code>State Updater</code> by implementing the <code>updateState(:)</code> method that changes the <code><a href="Protocols/State.html">State</a></code> based on the current app <code><a href="Protocols/State.html">State</a></code> and the <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code> itself. The <code>updateState</code> should be a pure function, which means that it only depends on the inputs (that is, the state and the state updater itself) and it doesn’t have side effects, such as network interactions.</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">IncrementCounter</span><span class="p">:</span> <span class="kt">StateUpdater</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">updateState</span><span class="p">(</span><span class="n">_</span> <span class="nv">state</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">CounterState</span><span class="p">)</span> <span class="p">{</span>
<span class="n">state</span><span class="o">.</span><span class="n">counter</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<p>The <code><a href="Classes/Store.html">Store</a></code> contains and manages your entire app <code><a href="Protocols/State.html">State</a></code>. It is responsible of managing the dispatched items (e.g., the just mentioned <code>State Updater</code>).</p>
<pre class="highlight swift"><code><span class="c1">// ignore AppDependencies for the time being, it will be explained later on</span>
<span class="k">let</span> <span class="nv">store</span> <span class="o">=</span> <span class="kt">Store</span><span class="o"><</span><span class="kt">CounterState</span><span class="p">,</span> <span class="kt">AppDependencies</span><span class="o">></span><span class="p">()</span>
<span class="n">store</span><span class="o">.</span><span class="nf">dispatch</span><span class="p">(</span><span class="kt">IncrementCounter</span><span class="p">())</span>
</code></pre>
<p>You can ask the <code><a href="Classes/Store.html">Store</a></code> to be notified about every change in the app <code><a href="Protocols/State.html">State</a></code>.</p>
<pre class="highlight swift"><code><span class="n">store</span><span class="o">.</span><span class="nf">addListener</span><span class="p">()</span> <span class="p">{</span> <span class="n">oldState</span><span class="p">,</span> <span class="n">newState</span> <span class="k">in</span>
<span class="c1">// the app state has changed</span>
<span class="p">}</span>
</code></pre>
<h2 id='side-effects' class='heading'>Side Effects</h2>
<p>Updating the application’s state using pure functions is nice and it has a lot of benefits. Applications have to deal with the external world though (e.g., API call, disk files management, ). For all this kind of operations, Katana provides the concept of <code>side effects</code>. Side effects can be used to interact with other parts of your applications and then dispatch new <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>s to update your state. For more complex situations, you can also dispatch other <code>side effects</code>.</p>
<p><code>Side Effect</code>s are implemented on top of <a href="path_to_url">Hydra</a>, and allow you to write your logic using <a href="path_to_url">promises</a>. In order to leverage this functionality you have to adopt the <code><a href="Protocols/SideEffect.html">SideEffect</a></code> protocol</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">GenerateRandomNumberFromBackend</span><span class="p">:</span> <span class="kt">SideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">CounterState</span><span class="p">,</span> <span class="kt">AppDependencies</span><span class="o">></span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
<span class="c1">// invokes the `getRandomNumber` method that returns a promise that is fullfilled</span>
<span class="c1">// when the number is received. At that point we dispatch a State Updater</span>
<span class="c1">// that updates the state</span>
<span class="n">context</span><span class="o">.</span><span class="n">dependencies</span><span class="o">.</span><span class="kt">APIManager</span>
<span class="o">.</span><span class="nf">getRandomNumber</span><span class="p">()</span>
<span class="o">.</span><span class="n">then</span> <span class="p">{</span> <span class="n">randomNumber</span> <span class="k">in</span> <span class="n">context</span><span class="o">.</span><span class="nf">dispatch</span><span class="p">(</span><span class="kt">SetCounter</span><span class="p">(</span><span class="nv">newValue</span><span class="p">:</span> <span class="n">randomNumber</span><span class="p">))</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">struct</span> <span class="kt">SetCounter</span><span class="p">:</span> <span class="kt">StateUpdater</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">newValue</span><span class="p">:</span> <span class="kt">Int</span>
<span class="kd">func</span> <span class="nf">updateState</span><span class="p">(</span><span class="n">_</span> <span class="nv">state</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">CounterState</span><span class="p">)</span> <span class="p">{</span>
<span class="n">state</span><span class="o">.</span><span class="n">counter</span> <span class="o">=</span> <span class="k">self</span><span class="o">.</span><span class="n">newValue</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<p>Moreover, you can leverage the <code>Hydra.await</code> operator to write logic that mimics the <a href="path_to_url">async/await</a> pattern, which allows you to write async code in a sync manner.</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">GenerateRandomNumberFromBackend</span><span class="p">:</span> <span class="kt">SideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">CounterState</span><span class="p">,</span> <span class="kt">AppDependencies</span><span class="o">></span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
<span class="c1">// invokes the `getRandomNumber` method that returns a promise that is fulfilled</span>
<span class="c1">// when the number is received.</span>
<span class="k">let</span> <span class="nv">promise</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="n">dependencies</span><span class="o">.</span><span class="kt">APIManager</span><span class="o">.</span><span class="nf">getRandomNumber</span><span class="p">()</span>
<span class="c1">// we use Hydra.await to wait for the promise to be fulfilled</span>
<span class="k">let</span> <span class="nv">randomNumber</span> <span class="o">=</span> <span class="k">try</span> <span class="kt">Hydra</span><span class="o">.</span><span class="nf">await</span><span class="p">(</span><span class="n">promise</span><span class="p">)</span>
<span class="c1">// then the state is updated using the proper state updater</span>
<span class="k">try</span> <span class="kt">Hydra</span><span class="o">.</span><span class="nf">await</span><span class="p">(</span><span class="n">context</span><span class="o">.</span><span class="nf">dispatch</span><span class="p">(</span><span class="kt">SetCounter</span><span class="p">(</span><span class="nv">newValue</span><span class="p">:</span> <span class="n">randomNumber</span><span class="p">)))</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<p>In order to further improve the usability of side effects, there is also a version which can return a value. Note that both the state and dependencies types are erased, to allow for more freedom when using it in libraries, for example.</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">PurchaseProduct</span><span class="p">:</span> <span class="kt">ReturningSideEffect</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">productID</span><span class="p">:</span> <span class="kt">ProductID</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">AnySideEffectContext</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Result</span><span class="o"><</span><span class="kt">PurchaseResult</span><span class="p">,</span> <span class="kt">PurchaseError</span><span class="o">></span> <span class="p">{</span>
<span class="c1">// 0. Get the typed version of the context</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">context</span> <span class="o">=</span> <span class="n">context</span> <span class="k">as?</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">CounterState</span><span class="p">,</span> <span class="kt">AppDependencies</span><span class="o">></span> <span class="k">else</span> <span class="p">{</span>
<span class="nf">fatalError</span><span class="p">(</span><span class="s">"Invalid context type"</span><span class="p">)</span>
<span class="p">}</span>
<span class="c1">// 1. purchase the product via storekit</span>
<span class="k">let</span> <span class="nv">storekitResult</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="n">dependencies</span><span class="o">.</span><span class="n">monetization</span><span class="o">.</span><span class="nf">purchase</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">productID</span><span class="p">)</span>
<span class="k">if</span> <span class="k">case</span> <span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="k">let</span> <span class="nv">error</span><span class="p">)</span> <span class="o">=</span> <span class="n">storekitResult</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">storekitRejected</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
<span class="p">}</span>
<span class="c1">// 2. get the receipt</span>
<span class="k">let</span> <span class="nv">receipt</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="n">dependencies</span><span class="o">.</span><span class="n">monetization</span><span class="o">.</span><span class="nf">getReceipt</span><span class="p">()</span>
<span class="c1">// 3. validate the receipt</span>
<span class="k">let</span> <span class="nv">validationResult</span> <span class="o">=</span> <span class="k">try</span> <span class="kt">Hydra</span><span class="o">.</span><span class="nf">await</span><span class="p">(</span><span class="n">context</span><span class="o">.</span><span class="nf">dispatch</span><span class="p">(</span><span class="kt">Monetization</span><span class="o">.</span><span class="kt">Validate</span><span class="p">(</span><span class="n">receipt</span><span class="p">)))</span>
<span class="c1">// 4. map error</span>
<span class="k">return</span> <span class="n">validationResult</span>
<span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="o">.</span><span class="nf">init</span><span class="p">(</span><span class="nv">validation</span><span class="p">:</span> <span class="nv">$0</span><span class="p">)</span> <span class="p">}</span>
<span class="o">.</span><span class="n">mapError</span> <span class="p">{</span> <span class="o">.</span><span class="nf">validationRejected</span><span class="p">(</span><span class="nv">$0</span><span class="p">)</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<p>Note that, if this is a prominent use case for the library/app, the step <code>0</code> can be encapsulated in a protocol like this:</p>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">AppReturningSideEffect</span><span class="p">:</span> <span class="kt">ReturningSideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">AppState</span><span class="p">,</span> <span class="kt">DependenciesContainer</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span>
<span class="p">}</span>
<span class="kd">extension</span> <span class="kt">AppReturningSideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">AnySideEffectContext</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Void</span> <span class="p">{</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">context</span> <span class="o">=</span> <span class="n">context</span> <span class="k">as?</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">AppState</span><span class="p">,</span> <span class="kt">DependenciesContainer</span><span class="o">></span> <span class="k">else</span> <span class="p">{</span>
<span class="nf">fatalError</span><span class="p">(</span><span class="s">"Invalid context type"</span><span class="p">)</span>
<span class="p">}</span>
<span class="k">self</span><span class="o">.</span><span class="nf">sideEffect</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<h4 id='dependencies' class='heading'>Dependencies</h4>
<p>The side effect example leverages an <code>APIManager</code> method. The <code>Side Effect</code> can get the <code>APIManager</code> by using the <code>dependencies</code> parameter of the context. The <code>dependencies container</code> is the Katana way of doing dependency injection. We test our side effects, and because of this we need to get rid of singletons or other bad pratices that prevent us from writing tests. Creating a dependency container is very easy: just create a class that conforms to the <code><a href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></code> protocol, make the store generic to it, and use it in the side effect.</p>
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">class</span> <span class="kt">AppDependencies</span><span class="p">:</span> <span class="kt">SideEffectDependencyContainer</span> <span class="p">{</span>
<span class="kd">required</span> <span class="nf">init</span><span class="p">(</span><span class="nv">dispatch</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">PromisableStoreDispatch</span><span class="p">,</span> <span class="nv">getState</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">GetState</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// initialize your dependencies here</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<h2 id='interceptors' class='heading'>Interceptors</h2>
<p>When defining a <code><a href="Classes/Store.html">Store</a></code> you can provide a list of interceptors that are triggered in the given order whenever an item is dispatched. An interceptor is like a catch-all system that can be used to implement functionalities such as logging or to dynamically change the behaviour of the store. An interceptor is invoked every time a dispatchable item is about to be handled.</p>
<h4 id='dispatchablelogger' class='heading'>DispatchableLogger</h4>
<p>Katana comes with a built-in <code><a href="Enums/DispatchableLogger.html">DispatchableLogger</a></code> interceptor that logs all the dispatchables, except the ones listed in the blacklist parameter.</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">dispatchableLogger</span> <span class="o">=</span> <span class="kt">DispatchableLogger</span><span class="o">.</span><span class="nf">interceptor</span><span class="p">(</span><span class="nv">blackList</span><span class="p">:</span> <span class="p">[</span><span class="kt">NotToLog</span><span class="o">.</span><span class="k">self</span><span class="p">])</span>
<span class="k">let</span> <span class="nv">store</span> <span class="o">=</span> <span class="kt">Store</span><span class="o"><</span><span class="kt">CounterState</span><span class="o">></span><span class="p">(</span><span class="nv">interceptor</span><span class="p">:</span> <span class="p">[</span><span class="n">dispatchableLogger</span><span class="p">])</span>
</code></pre>
<h4 id='observerinterceptor' class='heading'>ObserverInterceptor</h4>
<p>Sometimes it is useful to listen for events that occur in the system and react to them. Katana provides the <code><a href="Structs/ObserverInterceptor.html">ObserverInterceptor</a></code> that can be used to achieve this result.</p>
<p>In particular you instruct the interceptor to dispatch items when:</p>
<ul>
<li>the store is initialized</li>
<li>the state changes in a particular way</li>
<li>a particular dispatchable item is managed by the store</li>
<li>a particular notification is sent to the default <a href="path_to_url">NotificationCenter</a></li>
</ul>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">observerInterceptor</span> <span class="o">=</span> <span class="kt">ObserverInterceptor</span><span class="o">.</span><span class="nf">observe</span><span class="p">([</span>
<span class="o">.</span><span class="nf">onStart</span><span class="p">([</span>
<span class="c1">// list of dispatchable items dispatched when the store is initialized</span>
<span class="p">])</span>
<span class="p">])</span>
<span class="k">let</span> <span class="nv">store</span> <span class="o">=</span> <span class="kt">Store</span><span class="o"><</span><span class="kt">CounterState</span><span class="o">></span><span class="p">(</span><span class="nv">interceptor</span><span class="p">:</span> <span class="p">[</span><span class="n">observerInterceptor</span><span class="p">])</span>
</code></pre>
<p>Note that when intercepting a side effect using an <code><a href="Structs/ObserverInterceptor.html">ObserverInterceptor</a></code>, the return value of the dispatchable is not available to the interceptor itself.</p>
<h2 id='what-about-the-ui' class='heading'>What about the UI?</h2>
<p>Katana is meant to give structure to the logic part of your app. When it comes to UI we propose two alternatives:</p>
<ul>
<li><p><a href="path_to_url">Tempura</a>: an MVVC framework we built on top of Katana and that we happily use to develop the UI of all our apps at Bending Spoons. Tempura is a lightweight, UIKit-friendly library that allows you to keep the UI automatically in sync with the state of your app. This is our suggested choice.</p></li>
<li><p><a href="path_to_url">Katana-UI</a>: With this library, we aimed to port React to UIKit, it allows you to create your app using a declarative approach. The library was initially bundled together with Katana, we decided to split it as internally we don’t use it anymore. In retrospect, we found that the impedance mismatch between the React-like approach and the imperative reality of UIKit was a no go for us.</p></li>
</ul>
<p align="center">
<a href="path_to_url"><img src="path_to_url" alt="Tempura" width="240" /></a>
<a href="path_to_url"><img src="path_to_url" alt="Katana UI" width="240" /></a>
</p>
<h2 id='signpost-logger' class='heading'>Signpost Logger</h2>
<p>Katana is automatically integrated with the <a href="path_to_url">Signpost API</a>. This integration layer allows you to see in Instruments all the items that have been dispatched, how long they last, and useful pieces of information such as the parallelism degree. Moreover, you can analyse the cpu impact of the items you dispatch to furtherly optimise your application performances.</p>
<p><img src="path_to_url" alt=""></p>
<h2 id='bending-spoons-guidelines' class='heading'>Bending Spoons Guidelines</h2>
<p>In Bending Spoons, we are extensively using Katana. In these years, we’ve defined some best pratices that have helped us write more readable and easier to debug code. We’ve decided to open source them so that everyone can have a starting point when using Katana. You can find them <a href="path_to_url">here</a>.</p>
<h2 id='migration-from-2-x' class='heading'>Migration from 2.x</h2>
<p>We strongly suggest to upgrade to the new Katana. The new Katana, in fact, not only adds new very powerful capabilities to the library, but it has also been designed to be extremely compatible with the old logic. All the actions and middleware you wrote for Katana 2.x, will continue to work in the new Katana as well. The breaking changes are most of the time related to simple typing changes that are easily addressable.</p>
<p>If you prefer to continue with Katana 2.x, however, you can still access Katana 2.x in the <a href="path_to_url">dedicated branch</a>.</p>
<h3 id='middleware' class='heading'>Middleware</h3>
<p>In Katana, the concept of <code>middleware</code> has been replaced with the new concept of <code>interceptor</code>. You can still use your middleware by leveraging the <code>middlewareToInterceptor</code> method.</p>
<h2 id='swift-version' class='heading'>Swift Version</h2>
<p>Certain versions of Katana only support certain versions of Swift. Depending on which version of Swift your project is using, you should use specific versions of Katana.
Use this table in order to check which version of Katana you need.</p>
<table><thead>
<tr>
<th>Swift Version</th>
<th>Katana Version</th>
</tr>
</thead><tbody>
<tr>
<td>Swift 5.0</td>
<td>Katana >= 6.0</td>
</tr>
<tr>
<td>Swift 4.2</td>
<td>Katana >= 2.0</td>
</tr>
<tr>
<td>Swift 4.1</td>
<td>Katana < 2.0</td>
</tr>
</tbody></table>
<h2 id='where-to-go-from-here' class='heading'>Where to go from here</h2>
<h3 id='give-it-a-shot' class='heading'>Give it a shot</h3>
<pre class="highlight plaintext"><code>pod try Katana
</code></pre>
<h3 id='tempura' class='heading'>Tempura</h3>
<p>Make awesome applications using Katana together with <a href="path_to_url">Tempura</a></p>
<h3 id='check-out-the-documentation' class='heading'>Check out the documentation</h3>
<p><a href="path_to_url">Documentation</a></p>
<p>You can also add Katana to <a href="path_to_url">Dash</a> using the proper <a href="path_to_url">docset</a>.</p>
<h2 id='installation' class='heading'>Installation</h2>
<p>Katana is available through <a href="path_to_url">CocoaPods</a> and <a href="path_to_url">Swift Package Manager</a>, you can also drop <code>Katana.project</code> into your Xcode project.</p>
<h3 id='requirements' class='heading'>Requirements</h3>
<ul>
<li><p>iOS 11.0+ / macOS 10.10+</p></li>
<li><p>Xcode 9.0+</p></li>
<li><p>Swift 5.0+</p></li>
</ul>
<h3 id='swift-package-manager' class='heading'>Swift Package Manager</h3>
<p><a href="path_to_url">Swift Package Manager</a> is a tool for managing the distribution of Swift code. Its integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.</p>
<p>There are two ways to integrate Katana in your project using Swift Package Manager:</p>
<ul>
<li>Adding it to your <code>Package.swift</code></li>
<li>Adding it directly from Xcode under <code>File</code> -> <code>Swift Packages</code> -> <code>Add Package dependency..</code></li>
</ul>
<p>In both cases you only need to provide this URL: <code>git@github.com:BendingSpoons/katana-swift.git</code></p>
<h3 id='cocoapods' class='heading'>CocoaPods</h3>
<p><a href="path_to_url">CocoaPods</a> is a dependency manager for Cocoa projects. You can install it with the following command:</p>
<pre class="highlight shell"><code><span class="nv">$ </span><span class="nb">sudo </span>gem <span class="nb">install </span>cocoapods
</code></pre>
<p>To integrate Katana into your Xcode project using CocoaPods you need to create a <code>Podfile</code>.</p>
<p>For iOS platforms, this is the content</p>
<pre class="highlight ruby"><code><span class="n">use_frameworks!</span>
<span class="n">source</span> <span class="s1">'path_to_url
<span class="n">platform</span> <span class="ss">:ios</span><span class="p">,</span> <span class="s1">'9.0'</span>
<span class="n">target</span> <span class="s1">'MyApp'</span> <span class="k">do</span>
<span class="n">pod</span> <span class="s1">'Katana'</span>
<span class="k">end</span>
</code></pre>
<p>Now, you just need to run:</p>
<pre class="highlight shell"><code><span class="nv">$ </span>pod <span class="nb">install</span>
</code></pre>
<h2 id='get-in-touch' class='heading'>Get in touch</h2>
<ul>
<li>if you have <strong>any questions</strong> you can find us on twitter: <a href="path_to_url">@maurobolis</a>, <a href="path_to_url">@luca_1987</a>, <a href="path_to_url">@smaramba</a></li>
</ul>
<h2 id='special-thanks' class='heading'>Special thanks</h2>
<ul>
<li><a href="path_to_url">Everyone at Bending Spoons</a> for providing their priceless input;</li>
<li><a href="path_to_url">@orta</a> for providing input on how to opensource the project;</li>
<li><a href="path_to_url">@danielemargutti</a> for developing and maintaining <a href="path_to_url">Hydra</a>;</li>
</ul>
<h2 id='contribute' class='heading'>Contribute</h2>
<ul>
<li>If you’ve <strong>found a bug</strong>, open an issue;</li>
<li>If you have a <strong>feature request</strong>, open an issue;</li>
<li>If you <strong>want to contribute</strong>, submit a pull request;</li>
<li>If you <strong>have an idea</strong> on how to improve the framework or how to spread the word, please <a href="#get-in-touch">get in touch</a>;</li>
<li>If you want to <strong>try the framework</strong> for your project or to write a demo, please send us the link of the repo.</li>
</ul>
<p>Katana is available under the <a href="path_to_url">MIT license</a>.</p>
<h2 id='about' class='heading'>About</h2>
<p>Katana is maintained by Bending Spoons.
We create our own tech products, used and loved by millions all around the world.
Interested? <a href="path_to_url">Check us out</a>!</p>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/index.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 10,982 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
<a title="Protocols Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Protocols Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Protocols</h1>
<p>The following protocols are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana12DispatchableP"></a>
<a name="//apple_ref/swift/Protocol/Dispatchable" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12DispatchableP">Dispatchable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol that marks something that can be actually dispatched into the <code><a href="Classes/Store.html">Store</a></code>.
It doesn’t have any particular requirement, and the protocol is actually used to
simply mark a category of items. Currently the <code><a href="Classes/Store.html">Store</a></code> is able to manage 2 types
of <code>Dispatchable</code>: <code><a href="Protocols/SideEffect.html">SideEffect</a></code>, <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>.</p>
<a href="Protocols/Dispatchable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Dispatchable</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L17">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana32NotificationObserverDispatchableP"></a>
<a name="//apple_ref/swift/Protocol/NotificationObserverDispatchable" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana32NotificationObserverDispatchableP">NotificationObserverDispatchable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to a notification</p>
<a href="Protocols/NotificationObserverDispatchable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">NotificationObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L15-L25">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana25StateObserverDispatchableP"></a>
<a name="//apple_ref/swift/Protocol/StateObserverDispatchable" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana25StateObserverDispatchableP">StateObserverDispatchable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to a change of the state</p>
<a href="Protocols/StateObserverDispatchable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">StateObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L30-L41">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana28DispatchObserverDispatchableP"></a>
<a name="//apple_ref/swift/Protocol/DispatchObserverDispatchable" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana28DispatchObserverDispatchableP">DispatchObserverDispatchable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to the dispatch of another dispatchable</p>
<a href="Protocols/DispatchObserverDispatchable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DispatchObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L46-L58">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana27OnStartObserverDispatchableP"></a>
<a name="//apple_ref/swift/Protocol/OnStartObserverDispatchable" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana27OnStartObserverDispatchableP">OnStartObserverDispatchable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol implemented by a dispatchable that wants to be dispatched when the store starts</p>
<a href="Protocols/OnStartObserverDispatchable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">OnStartObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L63-L72">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana20AnySideEffectContextP"></a>
<a name="//apple_ref/swift/Protocol/AnySideEffectContext" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana20AnySideEffectContextP">AnySideEffectContext</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type erasure for <code><a href="Structs/SideEffectContext.html">SideEffectContext</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Structs/SideEffectContext.html">SideEffectContext</a></code>
</div>
<a href="Protocols/AnySideEffectContext.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnySideEffectContext</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L17-L65">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana13AnySideEffectP"></a>
<a name="//apple_ref/swift/Protocol/AnySideEffect" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13AnySideEffectP">AnySideEffect</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type erasure for <code><a href="Protocols/SideEffect.html">SideEffect</a></code> and <code><a href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Protocols/SideEffect.html">SideEffect</a></code>, <code><a href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code>
</div>
<a href="Protocols/AnySideEffect.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnySideEffect</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L157-L166">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana19ReturningSideEffectP"></a>
<a name="//apple_ref/swift/Protocol/ReturningSideEffect" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ReturningSideEffectP">ReturningSideEffect</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A <code><a href="Protocols/AnySideEffect.html">AnySideEffect</a></code> that is capable of returning a typed value.</p>
<p>In order to promote reusability of the logic written using this type, both the state and
the dependencies are erased. This helps tremendously when writing libraries and generic
logic, and it can also be extended to be used in the apps.</p>
<p>For example, if the app needs to use a typed returning side effect it can define something like:</p>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">AppReturningSideEffect</span><span class="p">:</span> <span class="kt">ReturningSideEffect</span> <span class="p">{</span>
<span class="kd">typealias</span> <span class="kt">StateType</span> <span class="o">=</span> <span class="kt">AppState</span>
<span class="kd">typealias</span> <span class="kt">Dependencies</span> <span class="o">=</span> <span class="kt">AppDependencies</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">StateType</span><span class="p">,</span> <span class="kt">Dependencies</span><span class="o">></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">ReturnType</span>
<span class="p">}</span>
<span class="kd">extension</span> <span class="kt">AppReturningSideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">AnySideEffectContext</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">ReturnValue</span> <span class="p">{</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">typedContext</span> <span class="o">=</span> <span class="n">context</span> <span class="k">as?</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">StateType</span><span class="p">,</span> <span class="kt">Dependencies</span><span class="o">></span> <span class="k">else</span> <span class="p">{</span>
<span class="nf">fatalError</span><span class="p">(</span><span class="s">"Invalid context passed to side effect"</span><span class="p">)</span>
<span class="p">}</span>
<span class="k">return</span> <span class="k">try</span> <span class="k">self</span><span class="o">.</span><span class="nf">sideEffect</span><span class="p">(</span><span class="n">typedContext</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Protocols/AnySideEffect.html">AnySideEffect</a></code>, <code><a href="Protocols/SideEffect.html">SideEffect</a></code>
</div>
<a href="Protocols/ReturningSideEffect.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ReturningSideEffect</span> <span class="p">:</span> <span class="kt"><a href="Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L198-L210">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana10SideEffectP"></a>
<a name="//apple_ref/swift/Protocol/SideEffect" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana10SideEffectP">SideEffect</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A side effect is a single atom of the logic of your application.
While you can actually use them as you desire, the idea is to implement in each side effect
a meaningful, self contained, piece of logic that can be used from other pieces of you application
(e.g., dispatched by a View Controller or by another side effect).</p>
<p>The <code>SideEffect</code> is strongly tied to the state that it handles and the dependencies it has.
This greatly simplifies the code written in normal situations.
However, if you need to create updaters that are not strictly tied to a concrete types (e.g., in a library)
you can use <code><a href="Protocols/AnySideEffect.html">AnySideEffect</a></code>.</p>
<h3 id='app-tips-amp-tricks' class='heading'>App Tips & Tricks</h3>
<p>To further simplify the usage of a <code>SideEffect</code> you can add to your application a helper protocol</p>
<pre class="highlight swift"><code><span class="c1">/// assuming `AppState` is the type of your application's state and `DependenciesContainer` is the</span>
<span class="c1">/// container of your dependencies</span>
<span class="kd">protocol</span> <span class="kt">AppSideEffect</span><span class="p">:</span> <span class="kt">SideEffect</span> <span class="k">where</span> <span class="kt">StateType</span> <span class="o">==</span> <span class="kt">AppState</span><span class="p">,</span> <span class="kt">Dependencies</span> <span class="o">==</span> <span class="kt">DependenciesContainer</span> <span class="p">{}</span>
</code></pre>
<p>By conforming to <code>AppSideEffect</code>, you will get better autocompletion</p>
<a href="Protocols/SideEffect.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SideEffect</span> <span class="p">:</span> <span class="kt"><a href="Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L241-L281">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana29SideEffectDependencyContainerP"></a>
<a name="//apple_ref/swift/Protocol/SideEffectDependencyContainer" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana29SideEffectDependencyContainerP">SideEffectDependencyContainer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol that the side effect dependencies container should implement</p>
<a href="Protocols/SideEffectDependencyContainer.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SideEffectDependencyContainer</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L13-L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StateP"></a>
<a name="//apple_ref/swift/Protocol/State" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StateP">State</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Protocol for the state of the applications.
In Katana, all the relevant application information should be placed in a single
struct that has to implement the <code>State</code> protocol.</p>
<a href="Protocols/State.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">State</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L16-L22">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana15AnyStateUpdaterP"></a>
<a name="//apple_ref/swift/Protocol/AnyStateUpdater" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana15AnyStateUpdaterP">AnyStateUpdater</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type erasure for <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>
</div>
<a href="Protocols/AnyStateUpdater.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnyStateUpdater</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L16-L24">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12StateUpdaterP"></a>
<a name="//apple_ref/swift/Protocol/StateUpdater" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12StateUpdaterP">StateUpdater</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A <code>StateUpdater</code> is a <code><a href="Protocols/Dispatchable.html">Dispatchable</a></code> that can be used to update the <code><a href="Classes/Store.html">Store</a></code>
state configuration.</p>
<p>The <code>StateUpdater</code> is strongly tied to the state that it handles. This greatly simplifies
the code written in normal situations. However, if you need to create updaters that are not strictly
tied to a concrete state type (e.g., in a library) you can use <code><a href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code>.</p>
<h3 id='app-tips-amp-tricks' class='heading'>App Tips & Tricks</h3>
<p>To additionally simplify the usage of a <code>StateUpdater</code> you can add to your application an helper protocol</p>
<pre class="highlight swift"><code><span class="c1">/// assuming `AppState` is the type of your application's state</span>
<span class="kd">protocol</span> <span class="kt">AppStateUpdater</span><span class="p">:</span> <span class="kt">StateUpdater</span> <span class="k">where</span> <span class="kt">StateType</span> <span class="o">==</span> <span class="kt">AppState</span> <span class="p">{}</span>
</code></pre>
<p>By conforming to <code>AppStateUpdater</code>, you will get better autocompletion</p>
<a href="Protocols/StateUpdater.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">StateUpdater</span> <span class="p">:</span> <span class="kt"><a href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L43-L58">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana8AnyStoreP"></a>
<a name="//apple_ref/swift/Protocol/AnyStore" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana8AnyStoreP">AnyStore</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type Erasure for <code><a href="Classes/Store.html">Store</a></code></p>
<a href="Protocols/AnyStore.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnyStore</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L13-L63">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana13AsyncProviderP"></a>
<a name="//apple_ref/swift/Protocol/AsyncProvider" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13AsyncProviderP">AsyncProvider</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Entity capable of executing task asynchronously. This can be useful in tests to control asynchronous tasks</p>
<a href="Protocols/AsyncProvider.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AsyncProvider</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L38-L41">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Protocols.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 9,361 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Type Aliases Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Type Aliases" class="dashAnchor"></a>
<a title="Type Aliases Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Type Aliases Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Type Aliases</h1>
<p>The following type aliases are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana20StoreInterceptorNexta"></a>
<a name="//apple_ref/swift/Alias/StoreInterceptorNext" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for the function that is invoked to continue with the interceptors
chains.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StoreInterceptorNext</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L15">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana16StoreInterceptora"></a>
<a name="//apple_ref/swift/Alias/StoreInterceptor" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An interceptor is like a catch-all system that can be used to implement
functionalities such as logging, or to dynamically change the behaviour of
the store. An interceptor is invoked every time something has been dispatched and it is about to
be handled.</p>
<h4 id='initialization' class='heading'>Initialization</h4>
<p>When the store is initialised, the first closure is invoked and the interceptor receives the
context passed to the side effects. The interceptor can later use this context to retrieve the
state or to dispatch new items.</p>
<p>This step is performed once in the store lifetime.</p>
<h4 id='receiving-next' class='heading'>Receiving Next</h4>
<p>When the dispatchable is about to be handled, the store invokes the second function and passes <code>next</code>
to the interceptor. <code>Next</code> is a generic way to pass the next step of the interceptors chaining.</p>
<p>The interceptor should save this value and use it in the next step.</p>
<p>This step is performed multiple times in the store lifetime, once for each dispatchable item handled
by the store.</p>
<h4 id='receiving-the-dispatchable' class='heading'>Receiving the dispatchable</h4>
<p>Before handling the dispatchable (e.g., update the state in case of a <code><a href="Protocols/StateUpdater.html">StateUpdater</a></code>). The last closure
is invoked.</p>
<p>Here the interceptor can do anything it needs to in order to implement the desired behaviour. Eventually, though, it
should either invoke <code>next</code> passing the dispatchable (that is, the chain continues) or throw an error, which
will reject the related promise and will make so that the operation related to the dispatchable is not performed.</p>
<p>The <code>next</code> method can be also invoked with a different dispatchable with respect to the received one.</p>
<p>This step is performed multiple times in the store lifetime, once for each dispatchable item handled
by the store.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StoreInterceptor</span> <span class="o">=</span>
<span class="p">(</span><span class="n">_</span> <span class="nv">sideEffectContext</span><span class="p">:</span> <span class="kt"><a href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span><span class="p">)</span> <span class="o">-></span>
<span class="p">(</span><span class="n">_</span> <span class="nv">next</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a></span><span class="p">)</span> <span class="o">-></span>
<span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L52">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana16AnyStoreListenera"></a>
<a name="//apple_ref/swift/Alias/AnyStoreListener" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for the function that is invoked when the state changes.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">AnyStoreListener</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">oldState</span><span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span><span class="p">,</span> <span class="n">_</span> <span class="nv">newState</span><span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>oldState</em>
</code>
</td>
<td>
<div>
<p>the state before the update</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>newState</em>
</code>
</td>
<td>
<div>
<p>the state after the update</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L18">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana13StoreListenera"></a>
<a name="//apple_ref/swift/Alias/StoreListener" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13StoreListenera">StoreListener</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for the function that is invoked when the state changes.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StoreListener</span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">oldState</span><span class="p">:</span> <span class="kt">S</span><span class="p">,</span> <span class="n">_</span> <span class="nv">newState</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>oldState</em>
</code>
</td>
<td>
<div>
<p>the state before the update</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>newState</em>
</code>
</td>
<td>
<div>
<p>the state after the update</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L26">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana16StoreUnsubscribea"></a>
<a name="//apple_ref/swift/Alias/StoreUnsubscribe" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for the <code><a href="Classes/Store.html">Store</a></code> listener unsubscribe closure</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StoreUnsubscribe</span> <span class="o">=</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L29">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana8GetStatea"></a>
<a name="//apple_ref/swift/Alias/GetState" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana8GetStatea">GetState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for a type that returns the <code><a href="Classes/Store.html">Store</a></code>‘s state</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">GetState</span> <span class="o">=</span> <span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L32">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana11AnyDispatcha"></a>
<a name="//apple_ref/swift/Alias/AnyDispatch" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typealias for the <code>Store.anyDispatch</code> function with the ability of managing the output with a promise</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">AnyDispatch</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Typealiases.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 5,982 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structures Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Structures" class="dashAnchor"></a>
<a title="Structures Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">Katana Reference</a>
<img class="carat" src="img/carat.png" />
Structures Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Structures</h1>
<p>The following structures are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana19ObserverInterceptorV"></a>
<a name="//apple_ref/swift/Struct/ObserverInterceptor" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ObserverInterceptorV">ObserverInterceptor</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Interceptor that can be use to observe behaviours and dispatch items as a response.</p>
<p>You can add as many <code>ObserverInterceptor</code> as you want to your application.</p>
<a href="Structs/ObserverInterceptor.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ObserverInterceptor</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L79-L112">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana17SideEffectContextV"></a>
<a name="//apple_ref/swift/Struct/SideEffectContext" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana17SideEffectContextV">SideEffectContext</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Context passed to each side effect.</p>
<p>The context is basically a wrapper of methods and utilities that the side effect
can leverage to implement its functionalities</p>
<a href="Structs/SideEffectContext.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">S</span><span class="p">,</span> <span class="kt">D</span><span class="o">></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="Protocols/State.html">State</a></span><span class="p">,</span> <span class="kt">D</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">SideEffectContext</span><span class="p">:</span> <span class="kt"><a href="Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L93-L137">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana14SignpostLoggerV"></a>
<a name="//apple_ref/swift/Struct/SignpostLogger" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana14SignpostLoggerV">SignpostLogger</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Wrapper around the signpost API offered starting from iOS12.
The logger will automatically track side effects, state updaters and side effects
in Instruments. You will get a nice visualization of the operations that are ongoing,
the parallelism level and the time that each operation requires.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<a href="path_to_url">path_to_url
</div>
<a href="Structs/SignpostLogger.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SignpostLogger</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L20-L106">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Structs.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,538 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>ObserverInterceptor Structure Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Struct/ObserverInterceptor" class="dashAnchor"></a>
<a title="ObserverInterceptor Structure Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
ObserverInterceptor Structure Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>ObserverInterceptor</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ObserverInterceptor</span></code></pre>
</div>
</div>
<p>Interceptor that can be use to observe behaviours and dispatch items as a response.</p>
<p>You can add as many <code>ObserverInterceptor</code> as you want to your application.</p>
<div class="slightly-smaller">
<a href="path_to_url#L79-L112">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashyour_sha256_hashG_So014NSNotificationF0CtFZ"></a>
<a name="//apple_ref/swift/Method/observe(_:notificationCenter:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashyour_sha256_hashG_So014NSNotificationF0CtFZ">observe(_:<wbr>notificationCenter:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a new <code>ObserverInterceptor</code> that observes the passed events</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">observe</span><span class="p">(</span>
<span class="n">_</span> <span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Structs/ObserverInterceptor/ObserverType.html">ObserverType</a></span><span class="p">],</span>
<span class="nv">notificationCenter</span><span class="p">:</span> <span class="kt">NotificationCenter</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span>
<span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>items</em>
</code>
</td>
<td>
<div>
<p>the list of events to observe</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>notificationCenter</em>
</code>
</td>
<td>
<div>
<p>the notificationCenter used to listen to notifications</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the interceptor that observes the given items</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L90-L111">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana19ObserverInterceptorV0B4TypeO"></a>
<a name="//apple_ref/swift/Enum/ObserverType" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ObserverInterceptorV0B4TypeO">ObserverType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Enum that contains the various events that can be observed</p>
<a href="../Structs/ObserverInterceptor/ObserverType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ObserverType</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L311-L360">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Structs/ObserverInterceptor.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,430 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>SideEffectContext Structure Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Struct/SideEffectContext" class="dashAnchor"></a>
<a title="SideEffectContext Structure Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
SideEffectContext Structure Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>SideEffectContext</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">S</span><span class="p">,</span> <span class="kt">D</span><span class="o">></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">,</span> <span class="kt">D</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">SideEffectContext</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span></code></pre>
</div>
</div>
<p>Context passed to each side effect.</p>
<p>The context is basically a wrapper of methods and utilities that the side effect
can leverage to implement its functionalities</p>
<div class="slightly-smaller">
<a href="path_to_url#L93-L137">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana17SideEffectContextV12dependenciesq_vp"></a>
<a name="//apple_ref/swift/Property/dependencies" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana17SideEffectContextV12dependenciesq_vp">dependencies</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The dependencies passed to the <code><a href="../Classes/Store.html">Store</a></code>. You can use this as a mechanism for
dependencies injection.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">dependencies</span><span class="p">:</span> <span class="kt">D</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L98">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana17SideEffectContextV8getStatexyF"></a>
<a name="//apple_ref/swift/Method/getState()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana17SideEffectContextV8getStatexyF">getState()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Function that returns the current configuration of the state</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getState</span><span class="p">()</span> <span class="o">-></span> <span class="kt">S</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>the current configuration of the state</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L124-L126">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashDispatchable_pF"></a>
<a name="//apple_ref/swift/Method/anyDispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashDispatchable_pF">anyDispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code> item. This is the equivalent of the <code><a href="../Classes/Store.html">Store</a></code> <code>anyDispatch</code>.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Classes/Store.html">Store</a></code> implementation of <code>anyDispatch</code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">anyDispatch</span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L134-L136">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashtainer_pvp"></a>
<a name="//apple_ref/swift/Property/anyDependencies" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashtainer_pvp">anyDependencies</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implementation of the <code>anyDependencies</code> requirement for <code><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">anyDependencies</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L142-L144">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana17SideEffectContextV11getAnyStateAA0G0_pyF"></a>
<a name="//apple_ref/swift/Method/getAnyState()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana17SideEffectContextV11getAnyStateAA0G0_pyF">getAnyState()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implementation of the <code>getAnyState</code> requirement for <code><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getAnyState</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L147-L149">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Structs/SideEffectContext.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,553 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>SignpostLogger Structure Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Struct/SignpostLogger" class="dashAnchor"></a>
<a title="SignpostLogger Structure Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
SignpostLogger Structure Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>SignpostLogger</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SignpostLogger</span></code></pre>
</div>
</div>
<p>Wrapper around the signpost API offered starting from iOS12.
The logger will automatically track side effects, state updaters and side effects
in Instruments. You will get a nice visualization of the operations that are ongoing,
the parallelism level and the time that each operation requires.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<a href="path_to_url">path_to_url
</div>
<div class="slightly-smaller">
<a href="path_to_url#L20-L106">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana14SignpostLoggerV9isEnabledSbvpZ"></a>
<a name="//apple_ref/swift/Variable/isEnabled" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana14SignpostLoggerV9isEnabledSbvpZ">isEnabled</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether the logging is enabled. You should invoke this before instantiating
the store in your application</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">isEnabled</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L26">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Structs/SignpostLogger.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,782 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>DispatchableLogger Enumeration Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/DispatchableLogger" class="dashAnchor"></a>
<a title="DispatchableLogger Enumeration Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
DispatchableLogger Enumeration Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>DispatchableLogger</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DispatchableLogger</span></code></pre>
</div>
</div>
<p>Interceptor that logs all the dispatched items in the XCode console.</p>
<div class="slightly-smaller">
<a href="path_to_url#L12-L35">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashF_pKccAA20AnySideEffectContext_pcSayAaF_pXpG_tFZ"></a>
<a name="//apple_ref/swift/Method/interceptor(blackList:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashF_pKccAA20AnySideEffectContext_pcSayAaF_pXpG_tFZ">interceptor(blackList:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This function returns a <code><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code> that intercepts and logs not black-listed dispatchable</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code> for details
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">interceptor</span><span class="p">(</span><span class="nv">blackList</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>blackList</em>
</code>
</td>
<td>
<div>
<p>list of dispatchable types that must not be logged</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>store interceptor that logs not black-listed dispatchable</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L20-L34">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Enums/DispatchableLogger.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,086 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>ObserverType Enumeration Reference</title>
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
<meta charset="utf-8">
<script src="../../js/jquery.min.js" defer></script>
<script src="../../js/jazzy.js" defer></script>
<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/ObserverType" class="dashAnchor"></a>
<a title="ObserverType Enumeration Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../../index.html">Katana Reference</a>
<img class="carat" src="../../img/carat.png" />
ObserverType Enumeration Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>ObserverType</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ObserverType</span></code></pre>
</div>
</div>
<p>Enum that contains the various events that can be observed</p>
<div class="slightly-smaller">
<a href="path_to_url#L311-L360">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a"></a>
<a name="//apple_ref/swift/Alias/StateChangeObserver" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type of closure that is used to check whether a state change should trigger the event</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StateChangeObserver</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">prev</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/State.html">State</a></span><span class="p">,</span> <span class="n">_</span> <span class="nv">current</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/State.html">State</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L313">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana19ObserverInterceptorV0B4TypeO016TypedStateChangeB0a"></a>
<a name="//apple_ref/swift/Alias/TypedStateChangeObserver" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ObserverInterceptorV0B4TypeO016TypedStateChangeB0a">TypedStateChangeObserver</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Typed version of <code><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">TypedStateChangeObserver</span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">prev</span><span class="p">:</span> <span class="kt">S</span><span class="p">,</span> <span class="n">_</span> <span class="nv">current</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="../../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L316">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash_AaG_ptc_SayAA0fB12Dispatchable_pXpGtcAEmF"></a>
<a name="//apple_ref/swift/Element/onStateChange(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash_AaG_ptc_SayAA0fB12Dispatchable_pXpGtcAEmF">onStateChange(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Observes a change in the state.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">onStateChange</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt"><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a></span><span class="p">,</span> <span class="nv">_</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>observer</em>
</code>
</td>
<td>
<div>
<p>a function that should return true when the changes to the state should dispatch items</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>a list of items to dispatch if the <code>observer</code> returns true</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L323">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashtificationNamea_SayAA0fB12Dispatchable_pXpGtcAEmF"></a>
<a name="//apple_ref/swift/Element/onNotification(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashtificationNamea_SayAA0fB12Dispatchable_pXpGtcAEmF">onNotification(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Observes a notification.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">onNotification</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span><span class="p">,</span> <span class="nv">_</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>notification</em>
</code>
</td>
<td>
<div>
<p>the name of the notification to observe</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>a list of items to dispatch when the notification is sent</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L330">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashble_pXp_SayAA0fbG0_pXpGtcAEmF"></a>
<a name="//apple_ref/swift/Element/onDispatch(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashble_pXp_SayAA0fbG0_pXpGtcAEmF">onDispatch(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Observes a dispatch</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">onDispatch</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/Dispatchable.html">Dispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">,</span> <span class="nv">_</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the type of the dispatchable to observe</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>dispatchables</em>
</code>
</td>
<td>
<div>
<p>a list of items to dispatch when <code>dispatchable</code> is dispatched</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L337">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashpatchable_pXpGcAEmF"></a>
<a name="//apple_ref/swift/Element/onStart(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashpatchable_pXpGcAEmF">onStart(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Observes when the store starts</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">onStart</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a></span><span class="o">.</span><span class="k">Type</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>a list of items to dispatch when the store starts</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L343">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashp_AaG_ptcSbx_xtcAaGRzlFZ"></a>
<a name="//apple_ref/swift/Method/typedStateChange(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashp_AaG_ptcSbx_xtcAaGRzlFZ">typedStateChange(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Helper method that transforms a <code><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO016TypedStateChangeB0a">TypedStateChangeObserver</a></code> into a <code><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">typedStateChange</span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO016TypedStateChangeB0a">TypedStateChangeObserver</a></span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="../../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>closure</em>
</code>
</td>
<td>
<div>
<p>the closure with type <code><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO016TypedStateChangeB0a">TypedStateChangeObserver</a></code> to transform</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the closure with type <code><a href="../../Structs/ObserverInterceptor/ObserverType.html#/s:6Katana19ObserverInterceptorV0B4TypeO011StateChangeB0a">StateChangeObserver</a></code> that is logically equivalent to the given closure</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L351-L359">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/Structs/ObserverInterceptor/ObserverType.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 6,690 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>EmptySideEffectDependencyContainer Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/EmptySideEffectDependencyContainer" class="dashAnchor"></a>
<a title="EmptySideEffectDependencyContainer Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
EmptySideEffectDependencyContainer Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>EmptySideEffectDependencyContainer</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">EmptySideEffectDependencyContainer</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
</div>
</div>
<p>An empty dependencies container. It can be used for testing purposes or you don’t need dependencies</p>
<div class="slightly-smaller">
<a href="path_to_url#L26-L34">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash5Hydra7PromiseCyypGAA12Dispatchable_pc_AA0I0_pyctcfc"></a>
<a name="//apple_ref/swift/Method/init(dispatch:getState:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash5Hydra7PromiseCyypGAA12Dispatchable_pc_AA0I0_pyctcfc">init(dispatch:<wbr>getState:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates an empty dependency container</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="nf">init</span><span class="p">(</span><span class="n">dispatch</span> <span class="nv">_</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a></span><span class="p">,</span> <span class="n">getState</span> <span class="nv">_</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatch</em>
</code>
</td>
<td>
<div>
<p>a closure that can be used to dispatch dispatchables</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>an instance of the container</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L33">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Classes/EmptySideEffectDependencyContainer.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,041 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>PartialStore Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/PartialStore" class="dashAnchor"></a>
<a title="PartialStore Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
PartialStore Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>PartialStore</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">PartialStore</span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStore.html">AnyStore</a></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<p>Helper Store type that is used as a partial type.</p>
<p>This type is very helpful when you want to pass the store to pieces of your application
that must be aware of the type of state that the app manages but they should not care about
the logic part (that is, the dependency container). A very common case is when you want to
pass the store to the UI of your application. The UI shouldn’t access to the dependency container
directly (it should dispatch a <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> instead) but you can still have type-safety over the
state type that is managed.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
you should not create this class directly. The class is meant to be used as a partial type
erasure system over <code><a href="../Classes/Store.html">Store</a></code>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L78-L162">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC16StateInitializera"></a>
<a name="//apple_ref/swift/Alias/StateInitializer" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC16StateInitializera">StateInitializer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Closure that is used to initialize the state</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">StateInitializer</span><span class="o"><</span><span class="kt">T</span><span class="o">></span> <span class="o">=</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">T</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L80">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC5statexvp"></a>
<a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC5statexvp">state</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The current state of the application</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">S</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L83">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC8anyStateAA0E0_pvp"></a>
<a name="//apple_ref/swift/Property/anyState" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC8anyStateAA0E0_pvp">anyState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implementation of the AnyStore protocol.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/AnyStore.html">AnyStore</a></code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">anyState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L90-L92">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashtchable_pF"></a>
<a name="//apple_ref/swift/Method/anyDispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashtchable_pF">anyDispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Not implemented</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">anyDispatch</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L108-L110">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashateUpdaterRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashateUpdaterRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Not implemented</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L118-L120">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashdeEffectRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashdeEffectRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Not implemented</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L128-L130">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash__Gqd__AA19ReturningSideEffectRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash__Gqd__AA19ReturningSideEffectRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Not implemented</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">ReturnValue</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L138-L140">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC14addAnyListeneryyycyAA5State_p_AaE_ptcF"></a>
<a name="//apple_ref/swift/Method/addAnyListener(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC14addAnyListeneryyycyAA5State_p_AaE_ptcF">addAnyListener(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Not implemented</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">addAnyListener</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L147-L149">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12PartialStoreC11addListeneryyycyx_xtcF"></a>
<a name="//apple_ref/swift/Method/addListener(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12PartialStoreC11addListeneryyycyx_xtcF">addListener(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a listener to the store. A listener is basically a closure that is invoked
every time the Store’s state changes</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Not implemented. Instantiate a <code><a href="../Classes/Store.html">Store</a></code> instead
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">addListener</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a></span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>listener</em>
</code>
</td>
<td>
<div>
<p>the listener closure</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a closure that can be used to remove the listener</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L159-L161">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Classes/PartialStore.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 6,991 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Configuration Structure Reference</title>
<link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
<meta charset="utf-8">
<script src="../../js/jquery.min.js" defer></script>
<script src="../../js/jazzy.js" defer></script>
<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Struct/Configuration" class="dashAnchor"></a>
<a title="Configuration Structure Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../../index.html">Katana Reference</a>
<img class="carat" src="../../img/carat.png" />
Configuration Structure Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Configuration</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Configuration</span></code></pre>
</div>
</div>
<p>The dependencies used to initialize katana</p>
<div class="slightly-smaller">
<a href="path_to_url#L544-L558">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashistenersfG0AEyxq__GAA0fG0_p_AaI_ptcfc"></a>
<a name="//apple_ref/swift/Method/init(stateInitializerAsyncProvider:listenersAsyncProvider:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashistenersfG0AEyxq__GAA0fG0_p_AaI_ptcfc">init(stateInitializerAsyncProvider:<wbr>listenersAsyncProvider:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span>
<span class="nv">stateInitializerAsyncProvider</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/AsyncProvider.html">AsyncProvider</a></span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span><span class="p">,</span>
<span class="nv">listenersAsyncProvider</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/AsyncProvider.html">AsyncProvider</a></span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span>
<span class="p">)</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L551-L557">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Classes/Store/Configuration.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,865 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>AsyncProvider Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/AsyncProvider" class="dashAnchor"></a>
<a title="AsyncProvider Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
AsyncProvider Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>AsyncProvider</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AsyncProvider</span></code></pre>
</div>
</div>
<p>Entity capable of executing task asynchronously. This can be useful in tests to control asynchronous tasks</p>
<div class="slightly-smaller">
<a href="path_to_url#L38-L41">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana13AsyncProviderP7executeyyyycF"></a>
<a name="//apple_ref/swift/Method/execute(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13AsyncProviderP7executeyyyycF">execute(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Calling this method will enqueue a closure to be executed asynchronously</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">execute</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L40">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/AsyncProvider.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,738 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>StateObserverDispatchable Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/StateObserverDispatchable" class="dashAnchor"></a>
<a title="StateObserverDispatchable Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
StateObserverDispatchable Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>StateObserverDispatchable</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">StateObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to a change of the state</p>
<div class="slightly-smaller">
<a href="path_to_url#L30-L41">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash_AaG_ptcfc"></a>
<a name="//apple_ref/swift/Method/init(prevState:currentState:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash_AaG_ptcfc">init(prevState:<wbr>currentState:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the dispatchable item. If for any reason, the init decides
that the dispatchable should not be sent to the Store, the init can fail
(that is, returns nil)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">?(</span><span class="nv">prevState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">,</span> <span class="nv">currentState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>prevState</em>
</code>
</td>
<td>
<div>
<p>the last state before current changes</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>currentState</em>
</code>
</td>
<td>
<div>
<p>the current state</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>either the dispatchable item or nil</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L40">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/StateObserverDispatchable.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,014 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Store Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/Store" class="dashAnchor"></a>
<a title="Store Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
Store Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Store</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Store</span><span class="o"><</span><span class="kt">S</span><span class="p">,</span> <span class="kt">D</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="../Classes/PartialStore.html">PartialStore</a></span><span class="o"><</span><span class="kt">S</span><span class="o">></span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">,</span> <span class="kt">D</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
</div>
</div>
<p>The <code>Store</code> is a sort of single entry point that handles the logic of your application.
In Katana, all the various pieces of information that your application manages should be stored
in a single atom, called state (see also <code><a href="../Protocols/State.html">State</a></code> protocol).</p>
<p>The <code>Store</code>, however, doesn’t really implements any application specific logic: this class
only manages operations that are requested by the application-specific logic. In particular,
you can require the <code>Store</code> to execute something by <code>dispatching a dispatchable item</code>.</p>
<p>Currently the store handles 2 types of dispatchable: <code>State Updater</code>, <code>Side Effect</code></p>
<h4 id='update-the-state' class='heading'>Update the state</h4>
<p>As written before, in Katana every relevant information in the application should be stored in the
Store’s state. The only way to update the state is to dispatch a <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>.
At this point the <code>Store</code> will execute the following operations:</p>
<ul>
<li>it executes the interceptors</li>
<li>it creates the new state, by invoking the <code>updateState</code> function of the <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code></li>
<li>it updates the state</li>
<li>it resolves the promise</li>
</ul>
<h4 id='handle-to-business-logic' class='heading'>Handle to Business Logic</h4>
<p>Non trivial applications require to interact with external services and/or implement complex logics.
The proper way to handle these is by dispatching a <code><a href="../Protocols/SideEffect.html">SideEffect</a></code>.
The <code>Store</code> will execute the following operations:</p>
<ul>
<li>it executes the interceptors</li>
<li>it executes the <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> body</li>
<li>it resolves the promise</li>
</ul>
<h4 id='listen-for-updates' class='heading'>Listen for updates</h4>
<p>You can attach a listener that is invoked every time the state changes by using <code>addListener</code>.</p>
<h4 id='intercept-dispatchable' class='heading'>Intercept Dispatchable</h4>
<p>It is possible to intercept and reshape the behaviour of the <code>Store</code> by using a <code><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code>.
A <code><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></code> is executed every time something has dispatched, and before it is actually
managed by the <code>Store</code>. Here you implement behaviours like logging, blocking items before they’re executed
and even change dynamically which dispatchable items arrive to the <code>Store</code> itself.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code> for more information about how to implement an update of the state
</div><div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/SideEffect.html">SideEffect</a></code> for more information about how to implement a complex/asynchronous logic
</div>
<div class="slightly-smaller">
<a href="path_to_url#L211-L559">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC23DependenciesInitializera"></a>
<a name="//apple_ref/swift/Alias/DependenciesInitializer" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC23DependenciesInitializera">DependenciesInitializer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Closure that is used to initialize the dependencies</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">DependenciesInitializer</span> <span class="o">=</span> <span class="p">(</span><span class="n">_</span> <span class="nv">dispatch</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a></span><span class="p">,</span> <span class="n">_</span> <span class="nv">getState</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">StateInitializer</span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">D</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L213">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC7isReadySbvp"></a>
<a name="//apple_ref/swift/Property/isReady" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC7isReadySbvp">isReady</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether the store is ready to execute operations</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">isReady</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L227">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC12dependenciesq_Sgvp"></a>
<a name="//apple_ref/swift/Property/dependencies" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC12dependenciesq_Sgvp">dependencies</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The dependencies used in the side effects</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/SideEffect.html">SideEffect</a></code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">dependencies</span><span class="p">:</span> <span class="kt">D</span><span class="o">!</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L232">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreCACyxq_Gycfc"></a>
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreCACyxq_Gycfc">init()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A convenience init method. The store won’t have middleware nor dependencies for the side effects.
The state will be created using the default init of the state</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">()</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>An instance of store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L271-L273">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashpKccAA20AnySideEffectContext_pcG_tcfc"></a>
<a name="//apple_ref/swift/Method/init(interceptors:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashpKccAA20AnySideEffectContext_pcG_tcfc">init(interceptors:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A convenience init method for the Store. The initial state will be created using the default
init of the state type.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">interceptors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>interceptors</em>
</code>
</td>
<td>
<div>
<p>a list of interceptors that are executed every time something is dispatched</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An instance of the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L282-L287">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashyour_sha256_hashG_xycAC13ConfigurationVyxq__Gtcfc"></a>
<a name="//apple_ref/swift/Method/init(interceptors:stateInitializer:configuration:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashyour_sha256_hashG_xycAC13ConfigurationVyxq__Gtcfc">init(interceptors:<wbr>stateInitializer:<wbr>configuration:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A convenience init method for the Store. The dependencies will be created using the default init of the dependency type.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span>
<span class="nv">interceptors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></span><span class="p">],</span>
<span class="nv">stateInitializer</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">StateInitializer</span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">,</span>
<span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/Store/Configuration.html">Configuration</a></span> <span class="o">=</span> <span class="o">.</span><span class="nf">init</span><span class="p">()</span>
<span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>interceptors</em>
</code>
</td>
<td>
<div>
<p>a list of interceptors that are executed every time something is dispatched</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>stateInitializer</em>
</code>
</td>
<td>
<div>
<p>a closure invoked to define the first state’s value</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>configuration</em>
</code>
</td>
<td>
<div>
<p>the configuration needed by the store to start properly</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An instance of the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L297-L308">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashyour_sha256_hashyour_sha256_hashgurationVyxq__Gtcfc"></a>
<a name="//apple_ref/swift/Method/init(interceptors:stateInitializer:dependenciesInitializer:configuration:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashyour_sha256_hashyour_sha256_hashgurationVyxq__Gtcfc">init(interceptors:<wbr>stateInitializer:<wbr>dependenciesInitializer:<wbr>configuration:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default init method for the Store.</p>
<h4 id='initial-phases' class='heading'>Initial phases</h4>
<p>When the store is created, it doesn’t immediately start to handle dispatched items.
Before that, in fact, the <code>Store</code> will (in order)</p>
<ul>
<li>create the dependencies</li>
<li>create the first state version by using the given <code>stateInitializer</code></li>
<li>initialise the interceptors</li>
</ul>
<p>Accessing the state before the <code>Store</code> is ready will lead to a crash of the application, as the
state of the system is not well defined. You can check whether the <code>Store</code> is ready by leveraging the <code><a href="../Classes/Store.html#/s:6Katana5StoreC7isReadySbvp">isReady</a></code> property.</p>
<p>A good practice in case you have to interact with the <code>Store</code> (e.g., get the state) in the initial phases of your
application is to dispatch a <code><a href="../Protocols/SideEffect.html">SideEffect</a></code>. When dispatching something, in fact, the <code>Store</code> guarantees that
items are managed only after that the <code>Store</code> is ready. Items dispatched during the initialization are suspended
and resumed as soon as the <code>Store</code> is ready.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span>
<span class="nv">interceptors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a></span><span class="p">],</span>
<span class="nv">stateInitializer</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">StateInitializer</span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">,</span>
<span class="nv">dependenciesInitializer</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/Store.html#/s:6Katana5StoreC23DependenciesInitializera">DependenciesInitializer</a></span><span class="p">,</span>
<span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/Store/Configuration.html">Configuration</a></span> <span class="o">=</span> <span class="o">.</span><span class="nf">init</span><span class="p">()</span>
<span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>interceptors</em>
</code>
</td>
<td>
<div>
<p>a list of interceptors that are executed every time something is dispatched</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>stateInitializer</em>
</code>
</td>
<td>
<div>
<p>a closure invoked to define the first state’s value</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>dependenciesInitializer</em>
</code>
</td>
<td>
<div>
<p>a closure invoked to instantiate the dependencies</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>configuration</em>
</code>
</td>
<td>
<div>
<p>the configuration needed by the store to start properly</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An instance of store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L334-L363">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC14addAnyListeneryyycyAA5State_p_AaE_ptcF"></a>
<a name="//apple_ref/swift/Method/addAnyListener(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC14addAnyListeneryyycyAA5State_p_AaE_ptcF">addAnyListener(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a listener to the store. A listener is basically a closure that is invoked
every time the Store’s state changes. The listener is always invoked in the main queue</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">addAnyListener</span><span class="p">(</span><span class="n">_</span> <span class="nv">listener</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>listener</em>
</code>
</td>
<td>
<div>
<p>the listener closure</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a closure that can be used to remove the listener</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L386-L390">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC11addListeneryyycyx_xtcF"></a>
<a name="//apple_ref/swift/Method/addListener(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC11addListeneryyycyx_xtcF">addListener(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a typed listener to the store. A listener is basically a closure that is invoked
every time the Store’s state changes</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">addListener</span><span class="p">(</span><span class="n">_</span> <span class="nv">listener</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a></span><span class="o"><</span><span class="kt">S</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>listener</em>
</code>
</td>
<td>
<div>
<p>the listener closure</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a closure that can be used to remove the listener</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L399-L406">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashA19ReturningSideEffectRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashA19ReturningSideEffectRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> item</p>
<h4 id='threading' class='heading'>Threading</h4>
<p>The <code>Store</code> follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.</p>
<p>When a <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> is dispatched, Katana will handle them in a parallel queue. A <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> is executed
and considered done when its body finishes to be executed. This means that side effects are not guaranteed to be run in
isolation, and you should take into account the fact that multiple side effects can run at the same time. This decision has
been taken to greatly improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store’s state) without dispatching a <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code>.</p>
<h4 id='promise-resolution' class='heading'>Promise Resolution</h4>
<p>When it comes to <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code>s, the promise is resolved when the body of the <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> is executed
entirely (see <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> documentation for more information).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">ReturnValue</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the side effect to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise parameterized to SideEffect’s return value, that is resolved when the SideEffect is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L432-L434">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> item</p>
<h4 id='threading' class='heading'>Threading</h4>
<p>The <code>Store</code> follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.</p>
<p>When a <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> is dispatched, Katana will handle them in a parallel queue. A <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> is executed and considered
done when its body finishes to be executed. This means that side effects are not guaranteed to be run in isolation, and you
should take into account the fact that multiple side effects can run at the same time. This decision has been taken to greatly
improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store’s state) without dispatching a <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>.</p>
<h4 id='promise-resolution' class='heading'>Promise Resolution</h4>
<p>When it comes to <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>s, the promise is resolved when the body of the <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> is executed entirely (see
<code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> documentation for more information).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the side effect to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise parameterized to SideEffect’s return value, that is resolved when the SideEffect is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L460-L462">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hasherRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hasherRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code> item</p>
<h4 id='threading' class='heading'>Threading</h4>
<p>The <code>Store</code> follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.</p>
<p>When an <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code> is dispatched, the Store enqueues it in a serial and synchronous queue. This means that the Store
executes one update of the state at the time, following the order in which it has received them. This is done
to guarantee the predictability of the changes to the state and avoid any race condition. In general, using a synchronous
queue is never a big problem as any operation that goes in an <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code> is very lightweight.</p>
<h4 id='promise-resolution' class='heading'>Promise Resolution</h4>
<p>When it comes to <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code>, the promise is resolved when the state is updated.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the state updater to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise parameterized to void that is resolved when the state updater is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L486-L488">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashpF"></a>
<a name="//apple_ref/swift/Method/anyDispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashpF">anyDispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code> item</p>
<h4 id='threading' class='heading'>Threading</h4>
<p>The <code>Store</code> follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.</p>
<p>When a <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code> is dispatched, the Store enqueues it in a serial and synchronous queue. This means that the Store
executes one update of the state at the time, following the order in which it has received them. This is done
to guarantee the predictability of the changes to the state and avoid any race condition. In general, using a synchronous
queue is never a big problem as any operation that goes in a <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code> is very lightweight.</p>
<p>When it comes to <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> items, Katana will handle them in a parallel queue. A <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> is executed and considered
done when its body finishes to be executed. This means that side effects are not guaranteed to be run in isolation, and you
should take into account the fact that multiple side effects can run at the same time. This decision has been taken to greatly
improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store’s state) without dispatching a <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>.</p>
<h4 id='promise-resolution' class='heading'>Promise Resolution</h4>
<p>When it comes to <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>, the promise is resolved when the state is updated. For <code><a href="../Protocols/SideEffect.html">SideEffect</a></code>,
the promise is resolved when the body of the <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> is executed entirely (see <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> documentation for
more information).</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">anyDispatch</span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the dispatchable to dispatch, it can be either a StateUpdater or a SideEffect</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the dispatchable is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L520-L532">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana5StoreC13ConfigurationV"></a>
<a name="//apple_ref/swift/Struct/Configuration" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StoreC13ConfigurationV">Configuration</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The dependencies used to initialize katana</p>
<a href="../Classes/Store/Configuration.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Configuration</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L544-L558">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Classes/Store.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 13,205 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>ReturningSideEffect Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/ReturningSideEffect" class="dashAnchor"></a>
<a title="ReturningSideEffect Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
ReturningSideEffect Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>ReturningSideEffect</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ReturningSideEffect</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<p>A <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> that is capable of returning a typed value.</p>
<p>In order to promote reusability of the logic written using this type, both the state and
the dependencies are erased. This helps tremendously when writing libraries and generic
logic, and it can also be extended to be used in the apps.</p>
<p>For example, if the app needs to use a typed returning side effect it can define something like:</p>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">AppReturningSideEffect</span><span class="p">:</span> <span class="kt">ReturningSideEffect</span> <span class="p">{</span>
<span class="kd">typealias</span> <span class="kt">StateType</span> <span class="o">=</span> <span class="kt">AppState</span>
<span class="kd">typealias</span> <span class="kt">Dependencies</span> <span class="o">=</span> <span class="kt">AppDependencies</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">StateType</span><span class="p">,</span> <span class="kt">Dependencies</span><span class="o">></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">ReturnType</span>
<span class="p">}</span>
<span class="kd">extension</span> <span class="kt">AppReturningSideEffect</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">AnySideEffectContext</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">ReturnValue</span> <span class="p">{</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">typedContext</span> <span class="o">=</span> <span class="n">context</span> <span class="k">as?</span> <span class="kt">SideEffectContext</span><span class="o"><</span><span class="kt">StateType</span><span class="p">,</span> <span class="kt">Dependencies</span><span class="o">></span> <span class="k">else</span> <span class="p">{</span>
<span class="nf">fatalError</span><span class="p">(</span><span class="s">"Invalid context passed to side effect"</span><span class="p">)</span>
<span class="p">}</span>
<span class="k">return</span> <span class="k">try</span> <span class="k">self</span><span class="o">.</span><span class="nf">sideEffect</span><span class="p">(</span><span class="n">typedContext</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>, <code><a href="../Protocols/SideEffect.html">SideEffect</a></code>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L198-L210">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana19ReturningSideEffectP11ReturnValueQa"></a>
<a name="//apple_ref/swift/Alias/ReturnValue" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana19ReturningSideEffectP11ReturnValueQa">ReturnValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The type of the return value</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">ReturnValue</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L200">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashontext_pKF"></a>
<a name="//apple_ref/swift/Method/sideEffect(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashontext_pKF">sideEffect(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implements the logic of the side effect.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
if the logic has an error. The related promise will be rejected
</div><div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt"><a href="../Protocols/ReturningSideEffect.html#/s:6Katana19ReturningSideEffectP11ReturnValueQa">ReturnValue</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>context</em>
</code>
</td>
<td>
<div>
<p>the context of the side effect</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the side effect return value, if applicable</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L209">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash></a>
<a name="//apple_ref/swift/Method/anySideEffect(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash>anySideEffect(_:<wbr>)</a>
</code>
<span class="declaration-note">
Extension method
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implementation of the <code>anySideEffect</code> requirement for <code>ReturningSideEffectContext</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">anySideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L215-L217">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/ReturningSideEffect.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,630 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>Dispatchable Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/Dispatchable" class="dashAnchor"></a>
<a title="Dispatchable Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
Dispatchable Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Dispatchable</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">Dispatchable</span></code></pre>
</div>
</div>
<p>Protocol that marks something that can be actually dispatched into the <code><a href="../Classes/Store.html">Store</a></code>.
It doesn’t have any particular requirement, and the protocol is actually used to
simply mark a category of items. Currently the <code><a href="../Classes/Store.html">Store</a></code> is able to manage 2 types
of <code>Dispatchable</code>: <code><a href="../Protocols/SideEffect.html">SideEffect</a></code>, <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>.</p>
<div class="slightly-smaller">
<a href="path_to_url#L17">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana12DispatchablePAAE16debugDescriptionSSvp"></a>
<a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12DispatchablePAAE16debugDescriptionSSvp">debugDescription</a>
</code>
<span class="declaration-note">
Extension method
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Implementation of the <code>CustomDebugStringConvertible</code> protocol</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L21-L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/Dispatchable.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,843 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>SideEffect Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/SideEffect" class="dashAnchor"></a>
<a title="SideEffect Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
SideEffect Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>SideEffect</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SideEffect</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<p>A side effect is a single atom of the logic of your application.
While you can actually use them as you desire, the idea is to implement in each side effect
a meaningful, self contained, piece of logic that can be used from other pieces of you application
(e.g., dispatched by a View Controller or by another side effect).</p>
<p>The <code>SideEffect</code> is strongly tied to the state that it handles and the dependencies it has.
This greatly simplifies the code written in normal situations.
However, if you need to create updaters that are not strictly tied to a concrete types (e.g., in a library)
you can use <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>.</p>
<h3 id='app-tips-amp-tricks' class='heading'>App Tips & Tricks</h3>
<p>To further simplify the usage of a <code>SideEffect</code> you can add to your application a helper protocol</p>
<pre class="highlight swift"><code><span class="c1">/// assuming `AppState` is the type of your application's state and `DependenciesContainer` is the</span>
<span class="c1">/// container of your dependencies</span>
<span class="kd">protocol</span> <span class="kt">AppSideEffect</span><span class="p">:</span> <span class="kt">SideEffect</span> <span class="k">where</span> <span class="kt">StateType</span> <span class="o">==</span> <span class="kt">AppState</span><span class="p">,</span> <span class="kt">Dependencies</span> <span class="o">==</span> <span class="kt">DependenciesContainer</span> <span class="p">{}</span>
</code></pre>
<p>By conforming to <code>AppSideEffect</code>, you will get better autocompletion</p>
<div class="slightly-smaller">
<a href="path_to_url#L241-L281">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana10SideEffectP9StateTypeQa"></a>
<a name="//apple_ref/swift/Alias/StateType" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana10SideEffectP9StateTypeQa">StateType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The type of the state of the store</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">StateType</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L243">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana10SideEffectP12DependenciesQa"></a>
<a name="//apple_ref/swift/Alias/Dependencies" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana10SideEffectP12DependenciesQa">Dependencies</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The type of the dependencies container that is used to pass dependencies to the side effect</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">Dependencies</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L246">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashdenciesQzGKF"></a>
<a name="//apple_ref/swift/Method/sideEffect(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashdenciesQzGKF">sideEffect(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Block that implements the logic of the side effect.
You can implement the logic, leveraging the technology you desire for threading and flow management.</p>
<p>However, there are two patterns that Katana suggests to use: synchronous side effects and asynchronous side effects</p>
<h4 id='synchronous' class='heading'>Synchronous</h4>
<p>A synchronous side effect is a side effect that finishes its execution when the <code>sideEffect(:)</code> method
is completed. Since the related promise (that is, the promise that is returned when the side effect is dispatched)
is resolved when this method ends, it means that the caller can safely assume that the operations are completed.</p>
<p>The easier way to achieve this behaviour is by using <code>Hydra.await</code> offered by the <code>Hydra</code> library. You can use <code>Hydra.await</code>
with any API that returns a promise (e.g., the dispatch) and it blocks the execution of the method until the
promise is resolved (you can find more documentation here <a href="path_to_url#awaitasync">path_to_url#awaitasync</a>).</p>
<p>This should be the default approach you take for your side effects</p>
<h4 id='asynchronous' class='heading'>Asynchronous</h4>
<p>An asynchronous side effect is a side effect that continues to propagate its effect even after the <code>sideEffect(:)</code> method
has been completed. This can be very helpful for very long running operations where you don’t want to block
other side effects in the queue.</p>
<p>In order to do use this approach, you can simply apply any asynchronous technique you know that does not block the method
(e.g.: promise, callback).</p>
<p>This approach is not suggested and should be used only in rare cases</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
if the logic has an error. The related promise will be rejected
</div><div class="aside aside-see-also">
<p class="aside-title">See also</p>
<a href="path_to_url#awaitasync">path_to_url#awaitasync</a>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Structs/SideEffectContext.html">SideEffectContext</a></span><span class="o"><</span><span class="kt"><a href="../Protocols/SideEffect.html#/s:6Katana10SideEffectP9StateTypeQa">StateType</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SideEffect.html#/s:6Katana10SideEffectP12DependenciesQa">Dependencies</a></span><span class="o">></span><span class="p">)</span> <span class="k">throws</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>context</em>
</code>
</td>
<td>
<div>
<p>the context of the side effect</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the side effect return value that will be used to parameterize the related promise</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L280">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana10SideEffectPAAE03anybC0yypAA03AnybC7Context_pKF"></a>
<a name="//apple_ref/swift/Method/anySideEffect(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana10SideEffectPAAE03anybC0yypAA03AnybC7Context_pKF">anySideEffect(_:<wbr>)</a>
</code>
<span class="declaration-note">
Extension method
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Conformance of <code>SideEffect</code> to <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">anySideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L285-L292">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/SideEffect.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,967 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>NotificationObserverDispatchable Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/NotificationObserverDispatchable" class="dashAnchor"></a>
<a title="NotificationObserverDispatchable Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
NotificationObserverDispatchable Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>NotificationObserverDispatchable</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">NotificationObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to a notification</p>
<div class="slightly-smaller">
<a href="path_to_url#L15-L25">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashndation0B0V_tcfc"></a>
<a name="//apple_ref/swift/Method/init(notification:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashndation0B0V_tcfc">init(notification:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the dispatchable item. If for any reason, the init decides
that the dispatchable should not be sent to the Store, the init can fail
(that is, returns nil)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">?(</span><span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>notification</em>
</code>
</td>
<td>
<div>
<p>the notification that triggered the init</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>either the dispatchable item or nil</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L24">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/NotificationObserverDispatchable.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,890 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>AnySideEffectContext Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/AnySideEffectContext" class="dashAnchor"></a>
<a title="AnySideEffectContext Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
AnySideEffectContext Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>AnySideEffectContext</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnySideEffectContext</span></code></pre>
</div>
</div>
<p>Type erasure for <code><a href="../Structs/SideEffectContext.html">SideEffectContext</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Structs/SideEffectContext.html">SideEffectContext</a></code>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L17-L65">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashContainer_pvp"></a>
<a name="//apple_ref/swift/Property/anyDependencies" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashContainer_pvp">anyDependencies</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type erased dependencies of the side effect</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">anyDependencies</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L19">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana20AnySideEffectContextP03getB5StateAA0G0_pyF"></a>
<a name="//apple_ref/swift/Method/getAnyState()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana20AnySideEffectContextP03getB5StateAA0G0_pyF">getAnyState()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type erased function that returns the current configuration of the state</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getAnyState</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>the type erased current configuration of the state</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L26">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashA12Dispatchable_pF"></a>
<a name="//apple_ref/swift/Method/anyDispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashA12Dispatchable_pF">anyDispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code>. It will essentially call the <code>anyDispatch</code> method of the backing store.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="nf">anyDispatch</span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the item to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the store finishes handling the dispatched item</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L35">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashA0bcD0Rd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashA0bcD0Rd__lF">dispatch(_:<wbr>)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code>.</p>
</div>
<h4>DefaultImplementation</h4>
<div class="default_impl abstract">
<p>Default implementation of the <code>dispatch<T: ReturningSideEffect></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved with the value returned by the side effect
when the store finishes handling the dispatched item</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L45">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashA0B12StateUpdaterRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashA0B12StateUpdaterRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the side effect to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the store finishes updating the state</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L54">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashValueQyd__Gqd__AA09ReturningcD0Rd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashValueQyd__Gqd__AA09ReturningcD0Rd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">ReturnValue</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved with the value returned by the side effect
when the store finishes handling the dispatched item</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L64">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/AnySideEffectContext.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 5,775 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>State Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/State" class="dashAnchor"></a>
<a title="State Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
State Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>State</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">State</span></code></pre>
</div>
</div>
<p>Protocol for the state of the applications.
In Katana, all the relevant application information should be placed in a single
struct that has to implement the <code>State</code> protocol.</p>
<div class="slightly-smaller">
<a href="path_to_url#L16-L22">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana5StatePxycfc"></a>
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana5StatePxycfc">init()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns the initial configuration of the <code>State</code> implementation.
It is used by Katana to create the very initial configuration of the application.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L21">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/State.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,671 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>AnyStore Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/AnyStore" class="dashAnchor"></a>
<a title="AnyStore Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
AnyStore Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>AnyStore</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnyStore</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<p>Type Erasure for <code><a href="../Classes/Store.html">Store</a></code></p>
<div class="slightly-smaller">
<a href="path_to_url#L13-L63">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana8AnyStoreP8anyStateAA0E0_pvp"></a>
<a name="//apple_ref/swift/Property/anyState" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana8AnyStoreP8anyStateAA0E0_pvp">anyState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type Erasure for the <code><a href="../Classes/Store.html">Store</a></code> <code>state</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">anyState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L15">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashle_pF"></a>
<a name="//apple_ref/swift/Method/anyDispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashle_pF">anyDispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a generic <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code> item. This is useful for customizing Katana’s dispatchable, for example in other libraries.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="nf">anyDispatch</span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the item to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the dispatchable is handled by the store, resolving to a value associated with the
dispatchable</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L25">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashaterRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashaterRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches an <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code> item</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the State Updater to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the dispatchable is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L34">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hashctRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hashctRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches an <code><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></code> item</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">Void</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffect.html">AnySideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the State Updater to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise that is resolved when the dispatchable is handled by the store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L43">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash__AA19ReturningSideEffectRd__lF"></a>
<a name="//apple_ref/swift/Method/dispatch(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash__AA19ReturningSideEffectRd__lF">dispatch(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Dispatches a <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code> item</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">func</span> <span class="n">dispatch</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">dispatchable</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Promise</span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">ReturnValue</span><span class="o">></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchable</em>
</code>
</td>
<td>
<div>
<p>the Returning Side Effect to dispatch</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a promise parameterized to the side effect’s return value, that is resolved when the dispatchable is handled by the
store</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L53">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana8AnyStoreP03addB8ListeneryyycyAA5State_p_AaE_ptcF"></a>
<a name="//apple_ref/swift/Method/addAnyListener(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana8AnyStoreP03addB8ListeneryyycyAA5State_p_AaE_ptcF">addAnyListener(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a listener to the store. A listener is basically a closure that is invoked
every time the Store’s state changes</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addAnyListener</span><span class="p">(</span><span class="n">_</span> <span class="nv">listener</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>listener</em>
</code>
</td>
<td>
<div>
<p>the listener closure</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>a closure that can be used to remove the listener</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L62">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/AnyStore.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 5,863 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>AnySideEffect Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/AnySideEffect" class="dashAnchor"></a>
<a title="AnySideEffect Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
AnySideEffect Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>AnySideEffect</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnySideEffect</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Type erasure for <code><a href="../Protocols/SideEffect.html">SideEffect</a></code> and <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/SideEffect.html">SideEffect</a></code>, <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L157-L166">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana13AnySideEffectP03anycD0yypAA0bcD7Context_pKF"></a>
<a name="//apple_ref/swift/Method/anySideEffect(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13AnySideEffectP03anycD0yypAA0bcD7Context_pKF">anySideEffect(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Block that implements the logic of the side effect.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
if the logic has an error. The related promise will be rejected
</div><div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/SideEffect.html">SideEffect</a></code>, <code><a href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a></code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">anySideEffect</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Any</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>context</em>
</code>
</td>
<td>
<div>
<p>the context of the side effect</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the side effect return value, if applicable</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L165">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/AnySideEffect.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,157 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>DispatchObserverDispatchable Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/DispatchObserverDispatchable" class="dashAnchor"></a>
<a title="DispatchObserverDispatchable Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
DispatchObserverDispatchable Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>DispatchObserverDispatchable</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">DispatchObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Protocol implemented by a dispatchable that wants to be dispatched in response to the dispatch of another dispatchable</p>
<div class="slightly-smaller">
<a href="path_to_url#L46-L58">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash07currentH0xSgAA0D0_p_AA0H0_pAaI_ptcfc"></a>
<a name="//apple_ref/swift/Method/init(dispatchedItem:prevState:currentState:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash07currentH0xSgAA0D0_p_AA0H0_pAaI_ptcfc">init(dispatchedItem:<wbr>prevState:<wbr>currentState:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the dispatchable item. If for any reason, the init decides
that the dispatchable should not be sent to the Store, the init can fail
(that is, returns nil)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">?(</span><span class="nv">dispatchedItem</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span><span class="p">,</span> <span class="nv">prevState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">,</span> <span class="nv">currentState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatchedItem</em>
</code>
</td>
<td>
<div>
<p>the item that triggered the init</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>prevState</em>
</code>
</td>
<td>
<div>
<p>the last state before current changes</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>currentState</em>
</code>
</td>
<td>
<div>
<p>the current state</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>either the dispatchable item or nil</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L57">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/DispatchObserverDispatchable.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,172 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>AnyStateUpdater Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/AnyStateUpdater" class="dashAnchor"></a>
<a title="AnyStateUpdater Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
AnyStateUpdater Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>AnyStateUpdater</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">AnyStateUpdater</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Type erasure for <code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L16-L24">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana15AnyStateUpdaterP07updatedC007currentC0AA0C0_pAaF_p_tF"></a>
<a name="//apple_ref/swift/Method/updatedState(currentState:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana15AnyStateUpdaterP07updatedC007currentC0AA0C0_pAaF_p_tF">updatedState(currentState:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the new state starting from the current state.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
<code><a href="../Protocols/StateUpdater.html">StateUpdater</a></code>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">updatedState</span><span class="p">(</span><span class="nv">currentState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>currentState</em>
</code>
</td>
<td>
<div>
<p>the current configuration of the state</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>the new version of the state</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/AnyStateUpdater.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,039 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>OnStartObserverDispatchable Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/OnStartObserverDispatchable" class="dashAnchor"></a>
<a title="OnStartObserverDispatchable Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
OnStartObserverDispatchable Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>OnStartObserverDispatchable</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">OnStartObserverDispatchable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Dispatchable.html">Dispatchable</a></span></code></pre>
</div>
</div>
<p>Protocol implemented by a dispatchable that wants to be dispatched when the store starts</p>
<div class="slightly-smaller">
<a href="path_to_url#L63-L72">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana27OnStartObserverDispatchablePxSgycfc"></a>
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana27OnStartObserverDispatchablePxSgycfc">init()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the dispatchable item. If for any reason, the init decides
that the dispatchable should not be sent to the Store, the init can fail
(that is, returns nil)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">?()</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>either the dispatchable item or nil</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L71">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/OnStartObserverDispatchable.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,758 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>StateUpdater Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/StateUpdater" class="dashAnchor"></a>
<a title="StateUpdater Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
StateUpdater Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>StateUpdater</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">StateUpdater</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></span></code></pre>
</div>
</div>
<p>A <code>StateUpdater</code> is a <code><a href="../Protocols/Dispatchable.html">Dispatchable</a></code> that can be used to update the <code><a href="../Classes/Store.html">Store</a></code>
state configuration.</p>
<p>The <code>StateUpdater</code> is strongly tied to the state that it handles. This greatly simplifies
the code written in normal situations. However, if you need to create updaters that are not strictly
tied to a concrete state type (e.g., in a library) you can use <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code>.</p>
<h3 id='app-tips-amp-tricks' class='heading'>App Tips & Tricks</h3>
<p>To additionally simplify the usage of a <code>StateUpdater</code> you can add to your application an helper protocol</p>
<pre class="highlight swift"><code><span class="c1">/// assuming `AppState` is the type of your application's state</span>
<span class="kd">protocol</span> <span class="kt">AppStateUpdater</span><span class="p">:</span> <span class="kt">StateUpdater</span> <span class="k">where</span> <span class="kt">StateType</span> <span class="o">==</span> <span class="kt">AppState</span> <span class="p">{}</span>
</code></pre>
<p>By conforming to <code>AppStateUpdater</code>, you will get better autocompletion</p>
<div class="slightly-smaller">
<a href="path_to_url#L43-L58">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana12StateUpdaterP0B4TypeQa"></a>
<a name="//apple_ref/swift/Alias/StateType" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12StateUpdaterP0B4TypeQa">StateType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The concrete state type that the updater manages</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">StateType</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L45">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12StateUpdaterP06updateB0yy0B4TypeQzzF"></a>
<a name="//apple_ref/swift/Method/updateState(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12StateUpdaterP06updateB0yy0B4TypeQzzF">updateState(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Updates the current state. It is important to note that <code>updateState(currentState:)</code>
should be a <a href="path_to_url">pure function</a>, that is
a function that given the same input always returns the same output and it also
doesn’t have any side effect. This is really important because it is an assumption
that Katana (and related tools) makes in order to implement some functionalities.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">updateState</span><span class="p">(</span><span class="n">_</span> <span class="nv">state</span><span class="p">:</span> <span class="k">inout</span> <span class="kt"><a href="../Protocols/StateUpdater.html#/s:6Katana12StateUpdaterP0B4TypeQa">StateType</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>state</em>
</code>
</td>
<td>
<div>
<p>the current configuration of the state. The method is meant to update
the value of the state in place</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L57">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:6Katana12StateUpdaterPAAE07updatedB007currentB0AA0B0_pAaF_p_tF"></a>
<a name="//apple_ref/swift/Method/updatedState(currentState:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana12StateUpdaterPAAE07updatedB007currentB0AA0B0_pAaF_p_tF">updatedState(currentState:<wbr>)</a>
</code>
<span class="declaration-note">
Extension method
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Conformance of <code>StateUpdater</code> to <code><a href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a></code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">updatedState</span><span class="p">(</span><span class="nv">currentState</span><span class="p">:</span> <span class="kt"><a href="../Protocols/State.html">State</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Protocols/State.html">State</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L62-L69">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/StateUpdater.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 4,089 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>SideEffectDependencyContainer Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/SideEffectDependencyContainer" class="dashAnchor"></a>
<a title="SideEffectDependencyContainer Protocol Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
SideEffectDependencyContainer Protocol Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>SideEffectDependencyContainer</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SideEffectDependencyContainer</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<p>Protocol that the side effect dependencies container should implement</p>
<div class="slightly-smaller">
<a href="path_to_url#L13-L23">Show on GitHub</a>
</div>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:your_sha256_hash7PromiseCyypGAA12Dispatchable_pc_AA0H0_pyctcfc"></a>
<a name="//apple_ref/swift/Method/init(dispatch:getState:)" class="dashAnchor"></a>
<a class="token" href="#/s:your_sha256_hash7PromiseCyypGAA12Dispatchable_pc_AA0H0_pyctcfc">init(dispatch:<wbr>getState:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a new instance of the container.
The container is instantiated when the store is instantiated</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">dispatch</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a></span><span class="p">,</span> <span class="nv">getState</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dispatch</em>
</code>
</td>
<td>
<div>
<p>a closure that can be used to dispatch dispatchables</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>getState</em>
</code>
</td>
<td>
<div>
<p>a closure that returns the current state</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>an instance of the container</p>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L22">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Protocols/SideEffectDependencyContainer.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 3,035 |
```css
*, *:before, *:after {
box-sizing: inherit; }
body {
margin: 0;
background: #fff;
color: #333;
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
letter-spacing: .2px;
-webkit-font-smoothing: antialiased;
box-sizing: border-box; }
h1 {
font-size: 2rem;
font-weight: 700;
margin: 1.275em 0 0.6em; }
h2 {
font-size: 1.75rem;
font-weight: 700;
margin: 1.275em 0 0.3em; }
h3 {
font-size: 1.5rem;
font-weight: 700;
margin: 1em 0 0.3em; }
h4 {
font-size: 1.25rem;
font-weight: 700;
margin: 1.275em 0 0.85em; }
h5 {
font-size: 1rem;
font-weight: 700;
margin: 1.275em 0 0.85em; }
h6 {
font-size: 1rem;
font-weight: 700;
margin: 1.275em 0 0.85em;
color: #777; }
p {
margin: 0 0 1em; }
ul, ol {
padding: 0 0 0 2em;
margin: 0 0 0.85em; }
blockquote {
margin: 0 0 0.85em;
padding: 0 15px;
color: #858585;
border-left: 4px solid #e5e5e5; }
img {
max-width: 100%; }
a {
color: #4183c4;
text-decoration: none; }
a:hover, a:focus {
outline: 0;
text-decoration: underline; }
a.discouraged {
text-decoration: line-through; }
a.discouraged:hover, a.discouraged:focus {
text-decoration: underline line-through; }
table {
background: #fff;
width: 100%;
border-collapse: collapse;
border-spacing: 0;
overflow: auto;
margin: 0 0 0.85em; }
tr:nth-child(2n) {
background-color: #fbfbfb; }
th, td {
padding: 6px 13px;
border: 1px solid #ddd; }
pre {
margin: 0 0 1.275em;
padding: .85em 1em;
overflow: auto;
background: #f7f7f7;
font-size: .85em;
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; }
code {
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; }
.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code {
background: #f7f7f7;
padding: .2em; }
.item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after {
letter-spacing: -.2em;
content: "\00a0"; }
pre code {
padding: 0;
white-space: pre; }
.content-wrapper {
display: flex;
flex-direction: column; }
@media (min-width: 768px) {
.content-wrapper {
flex-direction: row; } }
.header {
display: flex;
padding: 8px;
font-size: 0.875em;
background: #444;
color: #999; }
.header-col {
margin: 0;
padding: 0 8px; }
.header-col--primary {
flex: 1; }
.header-link {
color: #fff; }
.header-icon {
padding-right: 6px;
vertical-align: -4px;
height: 16px; }
.breadcrumbs {
font-size: 0.875em;
padding: 8px 16px;
margin: 0;
background: #fbfbfb;
border-bottom: 1px solid #ddd; }
.carat {
height: 10px;
margin: 0 5px; }
.navigation {
order: 2; }
@media (min-width: 768px) {
.navigation {
order: 1;
width: 25%;
max-width: 300px;
padding-bottom: 64px;
overflow: hidden;
word-wrap: normal;
background: #fbfbfb;
border-right: 1px solid #ddd; } }
.nav-groups {
list-style-type: none;
padding-left: 0; }
.nav-group-name {
border-bottom: 1px solid #ddd;
padding: 8px 0 8px 16px; }
.nav-group-name-link {
color: #333; }
.nav-group-tasks {
margin: 8px 0;
padding: 0 0 0 8px; }
.nav-group-task {
font-size: 1em;
list-style-type: none;
white-space: nowrap; }
.nav-group-task-link {
color: #808080; }
.main-content {
order: 1; }
@media (min-width: 768px) {
.main-content {
order: 2;
flex: 1;
padding-bottom: 60px; } }
.section {
padding: 0 32px;
border-bottom: 1px solid #ddd; }
.section-content {
max-width: 834px;
margin: 0 auto;
padding: 16px 0; }
.section-name {
color: #666;
display: block; }
.section-name p {
margin-bottom: inherit; }
.declaration .highlight {
overflow-x: initial;
padding: 8px 0;
margin: 0;
background-color: transparent;
border: none; }
.task-group-section {
border-top: 1px solid #ddd; }
.task-group {
padding-top: 0px; }
.task-name-container a[name]:before {
content: "";
display: block; }
.section-name-container {
position: relative; }
.section-name-container .section-name-link {
position: absolute;
top: 0;
left: 0;
bottom: 0;
right: 0;
margin-bottom: 0; }
.section-name-container .section-name {
position: relative;
pointer-events: none;
z-index: 1; }
.section-name-container .section-name a {
pointer-events: auto; }
.item-container {
padding: 0; }
.item {
padding-top: 8px;
width: 100%;
list-style-type: none; }
.item a[name]:before {
content: "";
display: block; }
.item .token, .item .direct-link {
display: inline-block;
text-indent: -20px;
padding-left: 3px;
margin-left: 20px;
font-size: 1rem; }
.item .declaration-note {
font-size: .85em;
color: #808080;
font-style: italic; }
.pointer-container {
border-bottom: 1px solid #ddd;
left: -23px;
padding-bottom: 13px;
position: relative;
width: 110%; }
.pointer {
left: 21px;
top: 7px;
display: block;
position: absolute;
width: 12px;
height: 12px;
border-left: 1px solid #ddd;
border-top: 1px solid #ddd;
background: #fff;
transform: rotate(45deg); }
.height-container {
display: none;
position: relative;
width: 100%;
overflow: hidden; }
.height-container .section {
background: #fff;
border: 1px solid #ddd;
border-top-width: 0;
padding-top: 10px;
padding-bottom: 5px;
padding: 8px 16px; }
.aside, .language {
padding: 6px 12px;
margin: 12px 0;
border-left: 5px solid #dddddd;
overflow-y: hidden; }
.aside .aside-title, .language .aside-title {
font-size: 9px;
letter-spacing: 2px;
text-transform: uppercase;
padding-bottom: 0;
margin: 0;
color: #aaa;
-webkit-user-select: none; }
.aside p:last-child, .language p:last-child {
margin-bottom: 0; }
.language {
border-left: 5px solid #cde9f4; }
.language .aside-title {
color: #4183c4; }
.aside-warning, .aside-deprecated, .aside-unavailable {
border-left: 5px solid #ff6666; }
.aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
color: #ff0000; }
.graybox {
border-collapse: collapse;
width: 100%; }
.graybox p {
margin: 0;
word-break: break-word;
min-width: 50px; }
.graybox td {
border: 1px solid #ddd;
padding: 5px 25px 5px 10px;
vertical-align: middle; }
.graybox tr td:first-of-type {
text-align: right;
padding: 7px;
vertical-align: top;
word-break: normal;
width: 40px; }
.slightly-smaller {
font-size: 0.9em; }
.footer {
padding: 8px 16px;
background: #444;
color: #ddd;
font-size: 0.8em; }
.footer p {
margin: 8px 0; }
.footer a {
color: #fff; }
html.dash .header, html.dash .breadcrumbs, html.dash .navigation {
display: none; }
html.dash .height-container {
display: block; }
form[role=search] input {
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
font-size: 14px;
line-height: 24px;
padding: 0 10px;
margin: 0;
border: none;
border-radius: 1em; }
.loading form[role=search] input {
background: white url(../img/spinner.gif) center right 4px no-repeat; }
form[role=search] .tt-menu {
margin: 0;
min-width: 300px;
background: #fbfbfb;
color: #333;
border: 1px solid #ddd; }
form[role=search] .tt-highlight {
font-weight: bold; }
form[role=search] .tt-suggestion {
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0 8px; }
form[role=search] .tt-suggestion span {
display: table-cell;
white-space: nowrap; }
form[role=search] .tt-suggestion .doc-parent-name {
width: 100%;
text-align: right;
font-weight: normal;
font-size: 0.9em;
padding-left: 16px; }
form[role=search] .tt-suggestion:hover,
form[role=search] .tt-suggestion.tt-cursor {
cursor: pointer;
background-color: #4183c4;
color: #fff; }
form[role=search] .tt-suggestion:hover .doc-parent-name,
form[role=search] .tt-suggestion.tt-cursor .doc-parent-name {
color: #fff; }
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/css/jazzy.css | css | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,730 |
```css
/* Credit to path_to_url */
.highlight {
/* Comment */
/* Error */
/* Keyword */
/* Operator */
/* Comment.Multiline */
/* Comment.Preproc */
/* Comment.Single */
/* Comment.Special */
/* Generic.Deleted */
/* Generic.Deleted.Specific */
/* Generic.Emph */
/* Generic.Error */
/* Generic.Heading */
/* Generic.Inserted */
/* Generic.Inserted.Specific */
/* Generic.Output */
/* Generic.Prompt */
/* Generic.Strong */
/* Generic.Subheading */
/* Generic.Traceback */
/* Keyword.Constant */
/* Keyword.Declaration */
/* Keyword.Pseudo */
/* Keyword.Reserved */
/* Keyword.Type */
/* Literal.Number */
/* Literal.String */
/* Name.Attribute */
/* Name.Builtin */
/* Name.Class */
/* Name.Constant */
/* Name.Entity */
/* Name.Exception */
/* Name.Function */
/* Name.Namespace */
/* Name.Tag */
/* Name.Variable */
/* Operator.Word */
/* Text.Whitespace */
/* Literal.Number.Float */
/* Literal.Number.Hex */
/* Literal.Number.Integer */
/* Literal.Number.Oct */
/* Literal.String.Backtick */
/* Literal.String.Char */
/* Literal.String.Doc */
/* Literal.String.Double */
/* Literal.String.Escape */
/* Literal.String.Heredoc */
/* Literal.String.Interpol */
/* Literal.String.Other */
/* Literal.String.Regex */
/* Literal.String.Single */
/* Literal.String.Symbol */
/* Name.Builtin.Pseudo */
/* Name.Variable.Class */
/* Name.Variable.Global */
/* Name.Variable.Instance */
/* Literal.Number.Integer.Long */ }
.highlight .c {
color: #999988;
font-style: italic; }
.highlight .err {
color: #a61717;
background-color: #e3d2d2; }
.highlight .k {
color: #000000;
font-weight: bold; }
.highlight .o {
color: #000000;
font-weight: bold; }
.highlight .cm {
color: #999988;
font-style: italic; }
.highlight .cp {
color: #999999;
font-weight: bold; }
.highlight .c1 {
color: #999988;
font-style: italic; }
.highlight .cs {
color: #999999;
font-weight: bold;
font-style: italic; }
.highlight .gd {
color: #000000;
background-color: #ffdddd; }
.highlight .gd .x {
color: #000000;
background-color: #ffaaaa; }
.highlight .ge {
color: #000000;
font-style: italic; }
.highlight .gr {
color: #aa0000; }
.highlight .gh {
color: #999999; }
.highlight .gi {
color: #000000;
background-color: #ddffdd; }
.highlight .gi .x {
color: #000000;
background-color: #aaffaa; }
.highlight .go {
color: #888888; }
.highlight .gp {
color: #555555; }
.highlight .gs {
font-weight: bold; }
.highlight .gu {
color: #aaaaaa; }
.highlight .gt {
color: #aa0000; }
.highlight .kc {
color: #000000;
font-weight: bold; }
.highlight .kd {
color: #000000;
font-weight: bold; }
.highlight .kp {
color: #000000;
font-weight: bold; }
.highlight .kr {
color: #000000;
font-weight: bold; }
.highlight .kt {
color: #445588; }
.highlight .m {
color: #009999; }
.highlight .s {
color: #d14; }
.highlight .na {
color: #008080; }
.highlight .nb {
color: #0086B3; }
.highlight .nc {
color: #445588;
font-weight: bold; }
.highlight .no {
color: #008080; }
.highlight .ni {
color: #800080; }
.highlight .ne {
color: #990000;
font-weight: bold; }
.highlight .nf {
color: #990000; }
.highlight .nn {
color: #555555; }
.highlight .nt {
color: #000080; }
.highlight .nv {
color: #008080; }
.highlight .ow {
color: #000000;
font-weight: bold; }
.highlight .w {
color: #bbbbbb; }
.highlight .mf {
color: #009999; }
.highlight .mh {
color: #009999; }
.highlight .mi {
color: #009999; }
.highlight .mo {
color: #009999; }
.highlight .sb {
color: #d14; }
.highlight .sc {
color: #d14; }
.highlight .sd {
color: #d14; }
.highlight .s2 {
color: #d14; }
.highlight .se {
color: #d14; }
.highlight .sh {
color: #d14; }
.highlight .si {
color: #d14; }
.highlight .sx {
color: #d14; }
.highlight .sr {
color: #009926; }
.highlight .s1 {
color: #d14; }
.highlight .ss {
color: #990073; }
.highlight .bp {
color: #999999; }
.highlight .vc {
color: #008080; }
.highlight .vg {
color: #008080; }
.highlight .vi {
color: #008080; }
.highlight .il {
color: #009999; }
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/css/highlight.css | css | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 1,331 |
```javascript
window.jazzy = {'docset': false}
if (typeof window.dash != 'undefined') {
document.documentElement.className += ' dash'
window.jazzy.docset = true
}
if (navigator.userAgent.match(/xcode/i)) {
document.documentElement.className += ' xcode'
window.jazzy.docset = true
}
function toggleItem($link, $content) {
var animationDuration = 300;
$link.toggleClass('token-open');
$content.slideToggle(animationDuration);
}
function itemLinkToContent($link) {
return $link.parent().parent().next();
}
// On doc load + hash-change, open any targetted item
function openCurrentItemIfClosed() {
if (window.jazzy.docset) {
return;
}
var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token');
$content = itemLinkToContent($link);
if ($content.is(':hidden')) {
toggleItem($link, $content);
}
}
$(openCurrentItemIfClosed);
$(window).on('hashchange', openCurrentItemIfClosed);
// On item link ('token') click, toggle its discussion
$('.token').on('click', function(event) {
if (window.jazzy.docset) {
return;
}
var $link = $(this);
toggleItem($link, itemLinkToContent($link));
// Keeps the document from jumping to the hash.
var href = $link.attr('href');
if (history.pushState) {
history.pushState({}, '', href);
} else {
location.hash = href;
}
event.preventDefault();
});
// Clicks on links to the current, closed, item need to open the item
$("a:not('.token')").on('click', function() {
if (location == this.href) {
openCurrentItemIfClosed();
}
});
// KaTeX rendering
if ("katex" in window) {
$($('.math').each( (_, element) => {
katex.render(element.textContent, element, {
displayMode: $(element).hasClass('m-block'),
throwOnError: false,
trust: true
});
}))
}
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/js/jazzy.js | javascript | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 473 |
```javascript
$(function(){
var $typeahead = $('[data-typeahead]');
var $form = $typeahead.parents('form');
var searchURL = $form.attr('action');
function displayTemplate(result) {
return result.name;
}
function suggestionTemplate(result) {
var t = '<div class="list-group-item clearfix">';
t += '<span class="doc-name">' + result.name + '</span>';
if (result.parent_name) {
t += '<span class="doc-parent-name label">' + result.parent_name + '</span>';
}
t += '</div>';
return t;
}
$typeahead.one('focus', function() {
$form.addClass('loading');
$.getJSON(searchURL).then(function(searchData) {
const searchIndex = lunr(function() {
this.ref('url');
this.field('name');
this.field('abstract');
for (const [url, doc] of Object.entries(searchData)) {
this.add({url: url, name: doc.name, abstract: doc.abstract});
}
});
$typeahead.typeahead(
{
highlight: true,
minLength: 3,
autoselect: true
},
{
limit: 10,
display: displayTemplate,
templates: { suggestion: suggestionTemplate },
source: function(query, sync) {
const lcSearch = query.toLowerCase();
const results = searchIndex.query(function(q) {
q.term(lcSearch, { boost: 100 });
q.term(lcSearch, {
boost: 10,
wildcard: lunr.Query.wildcard.TRAILING
});
}).map(function(result) {
var doc = searchData[result.ref];
doc.url = result.ref;
return doc;
});
sync(results);
}
}
);
$form.removeClass('loading');
$typeahead.trigger('focus');
});
});
var baseURL = searchURL.slice(0, -"search.json".length);
$typeahead.on('typeahead:select', function(e, result) {
window.location = baseURL + result.url;
});
});
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/js/jazzy.search.js | javascript | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 450 |
```javascript
/*!
* typeahead.js 1.3.1
* path_to_url
*/
(function(root, factory) {
if (typeof define === "function" && define.amd) {
define([ "jquery" ], function(a0) {
return factory(a0);
});
} else if (typeof module === "object" && module.exports) {
module.exports = factory(require("jquery"));
} else {
factory(root["jQuery"]);
}
})(this, function($) {
var _ = function() {
"use strict";
return {
isMsie: function() {
return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false;
},
isBlankString: function(str) {
return !str || /^\s*$/.test(str);
},
escapeRegExChars: function(str) {
return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
},
isString: function(obj) {
return typeof obj === "string";
},
isNumber: function(obj) {
return typeof obj === "number";
},
isArray: $.isArray,
isFunction: $.isFunction,
isObject: $.isPlainObject,
isUndefined: function(obj) {
return typeof obj === "undefined";
},
isElement: function(obj) {
return !!(obj && obj.nodeType === 1);
},
isJQuery: function(obj) {
return obj instanceof $;
},
toStr: function toStr(s) {
return _.isUndefined(s) || s === null ? "" : s + "";
},
bind: $.proxy,
each: function(collection, cb) {
$.each(collection, reverseArgs);
function reverseArgs(index, value) {
return cb(value, index);
}
},
map: $.map,
filter: $.grep,
every: function(obj, test) {
var result = true;
if (!obj) {
return result;
}
$.each(obj, function(key, val) {
if (!(result = test.call(null, val, key, obj))) {
return false;
}
});
return !!result;
},
some: function(obj, test) {
var result = false;
if (!obj) {
return result;
}
$.each(obj, function(key, val) {
if (result = test.call(null, val, key, obj)) {
return false;
}
});
return !!result;
},
mixin: $.extend,
identity: function(x) {
return x;
},
clone: function(obj) {
return $.extend(true, {}, obj);
},
getIdGenerator: function() {
var counter = 0;
return function() {
return counter++;
};
},
templatify: function templatify(obj) {
return $.isFunction(obj) ? obj : template;
function template() {
return String(obj);
}
},
defer: function(fn) {
setTimeout(fn, 0);
},
debounce: function(func, wait, immediate) {
var timeout, result;
return function() {
var context = this, args = arguments, later, callNow;
later = function() {
timeout = null;
if (!immediate) {
result = func.apply(context, args);
}
};
callNow = immediate && !timeout;
clearTimeout(timeout);
timeout = setTimeout(later, wait);
if (callNow) {
result = func.apply(context, args);
}
return result;
};
},
throttle: function(func, wait) {
var context, args, timeout, result, previous, later;
previous = 0;
later = function() {
previous = new Date();
timeout = null;
result = func.apply(context, args);
};
return function() {
var now = new Date(), remaining = wait - (now - previous);
context = this;
args = arguments;
if (remaining <= 0) {
clearTimeout(timeout);
timeout = null;
previous = now;
result = func.apply(context, args);
} else if (!timeout) {
timeout = setTimeout(later, remaining);
}
return result;
};
},
stringify: function(val) {
return _.isString(val) ? val : JSON.stringify(val);
},
guid: function() {
function _p8(s) {
var p = (Math.random().toString(16) + "000000000").substr(2, 8);
return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p;
}
return "tt-" + _p8() + _p8(true) + _p8(true) + _p8();
},
noop: function() {}
};
}();
var WWW = function() {
"use strict";
var defaultClassNames = {
wrapper: "twitter-typeahead",
input: "tt-input",
hint: "tt-hint",
menu: "tt-menu",
dataset: "tt-dataset",
suggestion: "tt-suggestion",
selectable: "tt-selectable",
empty: "tt-empty",
open: "tt-open",
cursor: "tt-cursor",
highlight: "tt-highlight"
};
return build;
function build(o) {
var www, classes;
classes = _.mixin({}, defaultClassNames, o);
www = {
css: buildCss(),
classes: classes,
html: buildHtml(classes),
selectors: buildSelectors(classes)
};
return {
css: www.css,
html: www.html,
classes: www.classes,
selectors: www.selectors,
mixin: function(o) {
_.mixin(o, www);
}
};
}
function buildHtml(c) {
return {
wrapper: '<span class="' + c.wrapper + '"></span>',
menu: '<div role="listbox" class="' + c.menu + '"></div>'
};
}
function buildSelectors(classes) {
var selectors = {};
_.each(classes, function(v, k) {
selectors[k] = "." + v;
});
return selectors;
}
function buildCss() {
var css = {
wrapper: {
position: "relative",
display: "inline-block"
},
hint: {
position: "absolute",
top: "0",
left: "0",
borderColor: "transparent",
boxShadow: "none",
opacity: "1"
},
input: {
position: "relative",
verticalAlign: "top",
backgroundColor: "transparent"
},
inputWithNoHint: {
position: "relative",
verticalAlign: "top"
},
menu: {
position: "absolute",
top: "100%",
left: "0",
zIndex: "100",
display: "none"
},
ltr: {
left: "0",
right: "auto"
},
rtl: {
left: "auto",
right: " 0"
}
};
if (_.isMsie()) {
_.mixin(css.input, {
backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)"
});
}
return css;
}
}();
var EventBus = function() {
"use strict";
var namespace, deprecationMap;
namespace = "typeahead:";
deprecationMap = {
render: "rendered",
cursorchange: "cursorchanged",
select: "selected",
autocomplete: "autocompleted"
};
function EventBus(o) {
if (!o || !o.el) {
$.error("EventBus initialized without el");
}
this.$el = $(o.el);
}
_.mixin(EventBus.prototype, {
_trigger: function(type, args) {
var $e = $.Event(namespace + type);
this.$el.trigger.call(this.$el, $e, args || []);
return $e;
},
before: function(type) {
var args, $e;
args = [].slice.call(arguments, 1);
$e = this._trigger("before" + type, args);
return $e.isDefaultPrevented();
},
trigger: function(type) {
var deprecatedType;
this._trigger(type, [].slice.call(arguments, 1));
if (deprecatedType = deprecationMap[type]) {
this._trigger(deprecatedType, [].slice.call(arguments, 1));
}
}
});
return EventBus;
}();
var EventEmitter = function() {
"use strict";
var splitter = /\s+/, nextTick = getNextTick();
return {
onSync: onSync,
onAsync: onAsync,
off: off,
trigger: trigger
};
function on(method, types, cb, context) {
var type;
if (!cb) {
return this;
}
types = types.split(splitter);
cb = context ? bindContext(cb, context) : cb;
this._callbacks = this._callbacks || {};
while (type = types.shift()) {
this._callbacks[type] = this._callbacks[type] || {
sync: [],
async: []
};
this._callbacks[type][method].push(cb);
}
return this;
}
function onAsync(types, cb, context) {
return on.call(this, "async", types, cb, context);
}
function onSync(types, cb, context) {
return on.call(this, "sync", types, cb, context);
}
function off(types) {
var type;
if (!this._callbacks) {
return this;
}
types = types.split(splitter);
while (type = types.shift()) {
delete this._callbacks[type];
}
return this;
}
function trigger(types) {
var type, callbacks, args, syncFlush, asyncFlush;
if (!this._callbacks) {
return this;
}
types = types.split(splitter);
args = [].slice.call(arguments, 1);
while ((type = types.shift()) && (callbacks = this._callbacks[type])) {
syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args));
asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args));
syncFlush() && nextTick(asyncFlush);
}
return this;
}
function getFlush(callbacks, context, args) {
return flush;
function flush() {
var cancelled;
for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) {
cancelled = callbacks[i].apply(context, args) === false;
}
return !cancelled;
}
}
function getNextTick() {
var nextTickFn;
if (window.setImmediate) {
nextTickFn = function nextTickSetImmediate(fn) {
setImmediate(function() {
fn();
});
};
} else {
nextTickFn = function nextTickSetTimeout(fn) {
setTimeout(function() {
fn();
}, 0);
};
}
return nextTickFn;
}
function bindContext(fn, context) {
return fn.bind ? fn.bind(context) : function() {
fn.apply(context, [].slice.call(arguments, 0));
};
}
}();
var highlight = function(doc) {
"use strict";
var defaults = {
node: null,
pattern: null,
tagName: "strong",
className: null,
wordsOnly: false,
caseSensitive: false,
diacriticInsensitive: false
};
var accented = {
A: "[Aa--------]",
B: "[Bb--]",
C: "[Cc--]",
D: "[Dd-----]",
E: "[Ee------]",
F: "[Ff--]",
G: "[Gg--]",
H: "[Hh---]",
I: "[Ii---------]",
J: "[Jj--]",
K: "[Kk--]",
L: "[Ll----]",
M: "[Mm----]",
N: "[Nn---]",
O: "[Oo-----]",
P: "[Pp---]",
Q: "[Qq]",
R: "[Rr-----]",
S: "[Ss---]",
T: "[Tt--]",
U: "[Uu------]",
V: "[Vv----]",
W: "[Ww--]",
X: "[Xx---]",
Y: "[Yy--]",
Z: "[Zz----]"
};
return function hightlight(o) {
var regex;
o = _.mixin({}, defaults, o);
if (!o.node || !o.pattern) {
return;
}
o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ];
regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive);
traverse(o.node, hightlightTextNode);
function hightlightTextNode(textNode) {
var match, patternNode, wrapperNode;
if (match = regex.exec(textNode.data)) {
wrapperNode = doc.createElement(o.tagName);
o.className && (wrapperNode.className = o.className);
patternNode = textNode.splitText(match.index);
patternNode.splitText(match[0].length);
wrapperNode.appendChild(patternNode.cloneNode(true));
textNode.parentNode.replaceChild(wrapperNode, patternNode);
}
return !!match;
}
function traverse(el, hightlightTextNode) {
var childNode, TEXT_NODE_TYPE = 3;
for (var i = 0; i < el.childNodes.length; i++) {
childNode = el.childNodes[i];
if (childNode.nodeType === TEXT_NODE_TYPE) {
i += hightlightTextNode(childNode) ? 1 : 0;
} else {
traverse(childNode, hightlightTextNode);
}
}
}
};
function accent_replacer(chr) {
return accented[chr.toUpperCase()] || chr;
}
function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) {
var escapedPatterns = [], regexStr;
for (var i = 0, len = patterns.length; i < len; i++) {
var escapedWord = _.escapeRegExChars(patterns[i]);
if (diacriticInsensitive) {
escapedWord = escapedWord.replace(/\S/g, accent_replacer);
}
escapedPatterns.push(escapedWord);
}
regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")";
return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i");
}
}(window.document);
var Input = function() {
"use strict";
var specialKeyCodeMap;
specialKeyCodeMap = {
9: "tab",
27: "esc",
37: "left",
39: "right",
13: "enter",
38: "up",
40: "down"
};
function Input(o, www) {
var id;
o = o || {};
if (!o.input) {
$.error("input is missing");
}
www.mixin(this);
this.$hint = $(o.hint);
this.$input = $(o.input);
this.$menu = $(o.menu);
id = this.$input.attr("id") || _.guid();
this.$menu.attr("id", id + "_listbox");
this.$hint.attr({
"aria-hidden": true
});
this.$input.attr({
"aria-owns": id + "_listbox",
role: "combobox",
"aria-autocomplete": "list",
"aria-expanded": false
});
this.query = this.$input.val();
this.queryWhenFocused = this.hasFocus() ? this.query : null;
this.$overflowHelper = buildOverflowHelper(this.$input);
this._checkLanguageDirection();
if (this.$hint.length === 0) {
this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop;
}
this.onSync("cursorchange", this._updateDescendent);
}
Input.normalizeQuery = function(str) {
return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " ");
};
_.mixin(Input.prototype, EventEmitter, {
_onBlur: function onBlur() {
this.resetInputValue();
this.trigger("blurred");
},
_onFocus: function onFocus() {
this.queryWhenFocused = this.query;
this.trigger("focused");
},
_onKeydown: function onKeydown($e) {
var keyName = specialKeyCodeMap[$e.which || $e.keyCode];
this._managePreventDefault(keyName, $e);
if (keyName && this._shouldTrigger(keyName, $e)) {
this.trigger(keyName + "Keyed", $e);
}
},
_onInput: function onInput() {
this._setQuery(this.getInputValue());
this.clearHintIfInvalid();
this._checkLanguageDirection();
},
_managePreventDefault: function managePreventDefault(keyName, $e) {
var preventDefault;
switch (keyName) {
case "up":
case "down":
preventDefault = !withModifier($e);
break;
default:
preventDefault = false;
}
preventDefault && $e.preventDefault();
},
_shouldTrigger: function shouldTrigger(keyName, $e) {
var trigger;
switch (keyName) {
case "tab":
trigger = !withModifier($e);
break;
default:
trigger = true;
}
return trigger;
},
_checkLanguageDirection: function checkLanguageDirection() {
var dir = (this.$input.css("direction") || "ltr").toLowerCase();
if (this.dir !== dir) {
this.dir = dir;
this.$hint.attr("dir", dir);
this.trigger("langDirChanged", dir);
}
},
_setQuery: function setQuery(val, silent) {
var areEquivalent, hasDifferentWhitespace;
areEquivalent = areQueriesEquivalent(val, this.query);
hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false;
this.query = val;
if (!silent && !areEquivalent) {
this.trigger("queryChanged", this.query);
} else if (!silent && hasDifferentWhitespace) {
this.trigger("whitespaceChanged", this.query);
}
},
_updateDescendent: function updateDescendent(event, id) {
this.$input.attr("aria-activedescendant", id);
},
bind: function() {
var that = this, onBlur, onFocus, onKeydown, onInput;
onBlur = _.bind(this._onBlur, this);
onFocus = _.bind(this._onFocus, this);
onKeydown = _.bind(this._onKeydown, this);
onInput = _.bind(this._onInput, this);
this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown);
if (!_.isMsie() || _.isMsie() > 9) {
this.$input.on("input.tt", onInput);
} else {
this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) {
if (specialKeyCodeMap[$e.which || $e.keyCode]) {
return;
}
_.defer(_.bind(that._onInput, that, $e));
});
}
return this;
},
focus: function focus() {
this.$input.focus();
},
blur: function blur() {
this.$input.blur();
},
getLangDir: function getLangDir() {
return this.dir;
},
getQuery: function getQuery() {
return this.query || "";
},
setQuery: function setQuery(val, silent) {
this.setInputValue(val);
this._setQuery(val, silent);
},
hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() {
return this.query !== this.queryWhenFocused;
},
getInputValue: function getInputValue() {
return this.$input.val();
},
setInputValue: function setInputValue(value) {
this.$input.val(value);
this.clearHintIfInvalid();
this._checkLanguageDirection();
},
resetInputValue: function resetInputValue() {
this.setInputValue(this.query);
},
getHint: function getHint() {
return this.$hint.val();
},
setHint: function setHint(value) {
this.$hint.val(value);
},
clearHint: function clearHint() {
this.setHint("");
},
clearHintIfInvalid: function clearHintIfInvalid() {
var val, hint, valIsPrefixOfHint, isValid;
val = this.getInputValue();
hint = this.getHint();
valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0;
isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow();
!isValid && this.clearHint();
},
hasFocus: function hasFocus() {
return this.$input.is(":focus");
},
hasOverflow: function hasOverflow() {
var constraint = this.$input.width() - 2;
this.$overflowHelper.text(this.getInputValue());
return this.$overflowHelper.width() >= constraint;
},
isCursorAtEnd: function() {
var valueLength, selectionStart, range;
valueLength = this.$input.val().length;
selectionStart = this.$input[0].selectionStart;
if (_.isNumber(selectionStart)) {
return selectionStart === valueLength;
} else if (document.selection) {
range = document.selection.createRange();
range.moveStart("character", -valueLength);
return valueLength === range.text.length;
}
return true;
},
destroy: function destroy() {
this.$hint.off(".tt");
this.$input.off(".tt");
this.$overflowHelper.remove();
this.$hint = this.$input = this.$overflowHelper = $("<div>");
},
setAriaExpanded: function setAriaExpanded(value) {
this.$input.attr("aria-expanded", value);
}
});
return Input;
function buildOverflowHelper($input) {
return $('<pre aria-hidden="true"></pre>').css({
position: "absolute",
visibility: "hidden",
whiteSpace: "pre",
fontFamily: $input.css("font-family"),
fontSize: $input.css("font-size"),
fontStyle: $input.css("font-style"),
fontVariant: $input.css("font-variant"),
fontWeight: $input.css("font-weight"),
wordSpacing: $input.css("word-spacing"),
letterSpacing: $input.css("letter-spacing"),
textIndent: $input.css("text-indent"),
textRendering: $input.css("text-rendering"),
textTransform: $input.css("text-transform")
}).insertAfter($input);
}
function areQueriesEquivalent(a, b) {
return Input.normalizeQuery(a) === Input.normalizeQuery(b);
}
function withModifier($e) {
return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey;
}
}();
var Dataset = function() {
"use strict";
var keys, nameGenerator;
keys = {
dataset: "tt-selectable-dataset",
val: "tt-selectable-display",
obj: "tt-selectable-object"
};
nameGenerator = _.getIdGenerator();
function Dataset(o, www) {
o = o || {};
o.templates = o.templates || {};
o.templates.notFound = o.templates.notFound || o.templates.empty;
if (!o.source) {
$.error("missing source");
}
if (!o.node) {
$.error("missing node");
}
if (o.name && !isValidName(o.name)) {
$.error("invalid dataset name: " + o.name);
}
www.mixin(this);
this.highlight = !!o.highlight;
this.name = _.toStr(o.name || nameGenerator());
this.limit = o.limit || 5;
this.displayFn = getDisplayFn(o.display || o.displayKey);
this.templates = getTemplates(o.templates, this.displayFn);
this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source;
this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async;
this._resetLastSuggestion();
this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name);
}
Dataset.extractData = function extractData(el) {
var $el = $(el);
if ($el.data(keys.obj)) {
return {
dataset: $el.data(keys.dataset) || "",
val: $el.data(keys.val) || "",
obj: $el.data(keys.obj) || null
};
}
return null;
};
_.mixin(Dataset.prototype, EventEmitter, {
_overwrite: function overwrite(query, suggestions) {
suggestions = suggestions || [];
if (suggestions.length) {
this._renderSuggestions(query, suggestions);
} else if (this.async && this.templates.pending) {
this._renderPending(query);
} else if (!this.async && this.templates.notFound) {
this._renderNotFound(query);
} else {
this._empty();
}
this.trigger("rendered", suggestions, false, this.name);
},
_append: function append(query, suggestions) {
suggestions = suggestions || [];
if (suggestions.length && this.$lastSuggestion.length) {
this._appendSuggestions(query, suggestions);
} else if (suggestions.length) {
this._renderSuggestions(query, suggestions);
} else if (!this.$lastSuggestion.length && this.templates.notFound) {
this._renderNotFound(query);
}
this.trigger("rendered", suggestions, true, this.name);
},
_renderSuggestions: function renderSuggestions(query, suggestions) {
var $fragment;
$fragment = this._getSuggestionsFragment(query, suggestions);
this.$lastSuggestion = $fragment.children().last();
this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions));
},
_appendSuggestions: function appendSuggestions(query, suggestions) {
var $fragment, $lastSuggestion;
$fragment = this._getSuggestionsFragment(query, suggestions);
$lastSuggestion = $fragment.children().last();
this.$lastSuggestion.after($fragment);
this.$lastSuggestion = $lastSuggestion;
},
_renderPending: function renderPending(query) {
var template = this.templates.pending;
this._resetLastSuggestion();
template && this.$el.html(template({
query: query,
dataset: this.name
}));
},
_renderNotFound: function renderNotFound(query) {
var template = this.templates.notFound;
this._resetLastSuggestion();
template && this.$el.html(template({
query: query,
dataset: this.name
}));
},
_empty: function empty() {
this.$el.empty();
this._resetLastSuggestion();
},
_getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) {
var that = this, fragment;
fragment = document.createDocumentFragment();
_.each(suggestions, function getSuggestionNode(suggestion) {
var $el, context;
context = that._injectQuery(query, suggestion);
$el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable);
fragment.appendChild($el[0]);
});
this.highlight && highlight({
className: this.classes.highlight,
node: fragment,
pattern: query
});
return $(fragment);
},
_getFooter: function getFooter(query, suggestions) {
return this.templates.footer ? this.templates.footer({
query: query,
suggestions: suggestions,
dataset: this.name
}) : null;
},
_getHeader: function getHeader(query, suggestions) {
return this.templates.header ? this.templates.header({
query: query,
suggestions: suggestions,
dataset: this.name
}) : null;
},
_resetLastSuggestion: function resetLastSuggestion() {
this.$lastSuggestion = $();
},
_injectQuery: function injectQuery(query, obj) {
return _.isObject(obj) ? _.mixin({
_query: query
}, obj) : obj;
},
update: function update(query) {
var that = this, canceled = false, syncCalled = false, rendered = 0;
this.cancel();
this.cancel = function cancel() {
canceled = true;
that.cancel = $.noop;
that.async && that.trigger("asyncCanceled", query, that.name);
};
this.source(query, sync, async);
!syncCalled && sync([]);
function sync(suggestions) {
if (syncCalled) {
return;
}
syncCalled = true;
suggestions = (suggestions || []).slice(0, that.limit);
rendered = suggestions.length;
that._overwrite(query, suggestions);
if (rendered < that.limit && that.async) {
that.trigger("asyncRequested", query, that.name);
}
}
function async(suggestions) {
suggestions = suggestions || [];
if (!canceled && rendered < that.limit) {
that.cancel = $.noop;
var idx = Math.abs(rendered - that.limit);
rendered += idx;
that._append(query, suggestions.slice(0, idx));
that.async && that.trigger("asyncReceived", query, that.name);
}
}
},
cancel: $.noop,
clear: function clear() {
this._empty();
this.cancel();
this.trigger("cleared");
},
isEmpty: function isEmpty() {
return this.$el.is(":empty");
},
destroy: function destroy() {
this.$el = $("<div>");
}
});
return Dataset;
function getDisplayFn(display) {
display = display || _.stringify;
return _.isFunction(display) ? display : displayFn;
function displayFn(obj) {
return obj[display];
}
}
function getTemplates(templates, displayFn) {
return {
notFound: templates.notFound && _.templatify(templates.notFound),
pending: templates.pending && _.templatify(templates.pending),
header: templates.header && _.templatify(templates.header),
footer: templates.footer && _.templatify(templates.footer),
suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate
};
function userSuggestionTemplate(context) {
var template = templates.suggestion;
return $(template(context)).attr("id", _.guid());
}
function suggestionTemplate(context) {
return $('<div role="option">').attr("id", _.guid()).text(displayFn(context));
}
}
function isValidName(str) {
return /^[_a-zA-Z0-9-]+$/.test(str);
}
}();
var Menu = function() {
"use strict";
function Menu(o, www) {
var that = this;
o = o || {};
if (!o.node) {
$.error("node is required");
}
www.mixin(this);
this.$node = $(o.node);
this.query = null;
this.datasets = _.map(o.datasets, initializeDataset);
function initializeDataset(oDataset) {
var node = that.$node.find(oDataset.node).first();
oDataset.node = node.length ? node : $("<div>").appendTo(that.$node);
return new Dataset(oDataset, www);
}
}
_.mixin(Menu.prototype, EventEmitter, {
_onSelectableClick: function onSelectableClick($e) {
this.trigger("selectableClicked", $($e.currentTarget));
},
_onRendered: function onRendered(type, dataset, suggestions, async) {
this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
this.trigger("datasetRendered", dataset, suggestions, async);
},
_onCleared: function onCleared() {
this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
this.trigger("datasetCleared");
},
_propagate: function propagate() {
this.trigger.apply(this, arguments);
},
_allDatasetsEmpty: function allDatasetsEmpty() {
return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) {
var isEmpty = dataset.isEmpty();
this.$node.attr("aria-expanded", !isEmpty);
return isEmpty;
}, this));
},
_getSelectables: function getSelectables() {
return this.$node.find(this.selectors.selectable);
},
_removeCursor: function _removeCursor() {
var $selectable = this.getActiveSelectable();
$selectable && $selectable.removeClass(this.classes.cursor);
},
_ensureVisible: function ensureVisible($el) {
var elTop, elBottom, nodeScrollTop, nodeHeight;
elTop = $el.position().top;
elBottom = elTop + $el.outerHeight(true);
nodeScrollTop = this.$node.scrollTop();
nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10);
if (elTop < 0) {
this.$node.scrollTop(nodeScrollTop + elTop);
} else if (nodeHeight < elBottom) {
this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight));
}
},
bind: function() {
var that = this, onSelectableClick;
onSelectableClick = _.bind(this._onSelectableClick, this);
this.$node.on("click.tt", this.selectors.selectable, onSelectableClick);
this.$node.on("mouseover", this.selectors.selectable, function() {
that.setCursor($(this));
});
this.$node.on("mouseleave", function() {
that._removeCursor();
});
_.each(this.datasets, function(dataset) {
dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that);
});
return this;
},
isOpen: function isOpen() {
return this.$node.hasClass(this.classes.open);
},
open: function open() {
this.$node.scrollTop(0);
this.$node.addClass(this.classes.open);
},
close: function close() {
this.$node.attr("aria-expanded", false);
this.$node.removeClass(this.classes.open);
this._removeCursor();
},
setLanguageDirection: function setLanguageDirection(dir) {
this.$node.attr("dir", dir);
},
selectableRelativeToCursor: function selectableRelativeToCursor(delta) {
var $selectables, $oldCursor, oldIndex, newIndex;
$oldCursor = this.getActiveSelectable();
$selectables = this._getSelectables();
oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1;
newIndex = oldIndex + delta;
newIndex = (newIndex + 1) % ($selectables.length + 1) - 1;
newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex;
return newIndex === -1 ? null : $selectables.eq(newIndex);
},
setCursor: function setCursor($selectable) {
this._removeCursor();
if ($selectable = $selectable && $selectable.first()) {
$selectable.addClass(this.classes.cursor);
this._ensureVisible($selectable);
}
},
getSelectableData: function getSelectableData($el) {
return $el && $el.length ? Dataset.extractData($el) : null;
},
getActiveSelectable: function getActiveSelectable() {
var $selectable = this._getSelectables().filter(this.selectors.cursor).first();
return $selectable.length ? $selectable : null;
},
getTopSelectable: function getTopSelectable() {
var $selectable = this._getSelectables().first();
return $selectable.length ? $selectable : null;
},
update: function update(query) {
var isValidUpdate = query !== this.query;
if (isValidUpdate) {
this.query = query;
_.each(this.datasets, updateDataset);
}
return isValidUpdate;
function updateDataset(dataset) {
dataset.update(query);
}
},
empty: function empty() {
_.each(this.datasets, clearDataset);
this.query = null;
this.$node.addClass(this.classes.empty);
function clearDataset(dataset) {
dataset.clear();
}
},
destroy: function destroy() {
this.$node.off(".tt");
this.$node = $("<div>");
_.each(this.datasets, destroyDataset);
function destroyDataset(dataset) {
dataset.destroy();
}
}
});
return Menu;
}();
var Status = function() {
"use strict";
function Status(options) {
this.$el = $("<span></span>", {
role: "status",
"aria-live": "polite"
}).css({
position: "absolute",
padding: "0",
border: "0",
height: "1px",
width: "1px",
"margin-bottom": "-1px",
"margin-right": "-1px",
overflow: "hidden",
clip: "rect(0 0 0 0)",
"white-space": "nowrap"
});
options.$input.after(this.$el);
_.each(options.menu.datasets, _.bind(function(dataset) {
if (dataset.onSync) {
dataset.onSync("rendered", _.bind(this.update, this));
dataset.onSync("cleared", _.bind(this.cleared, this));
}
}, this));
}
_.mixin(Status.prototype, {
update: function update(event, suggestions) {
var length = suggestions.length;
var words;
if (length === 1) {
words = {
result: "result",
is: "is"
};
} else {
words = {
result: "results",
is: "are"
};
}
this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate.");
},
cleared: function() {
this.$el.text("");
}
});
return Status;
}();
var DefaultMenu = function() {
"use strict";
var s = Menu.prototype;
function DefaultMenu() {
Menu.apply(this, [].slice.call(arguments, 0));
}
_.mixin(DefaultMenu.prototype, Menu.prototype, {
open: function open() {
!this._allDatasetsEmpty() && this._show();
return s.open.apply(this, [].slice.call(arguments, 0));
},
close: function close() {
this._hide();
return s.close.apply(this, [].slice.call(arguments, 0));
},
_onRendered: function onRendered() {
if (this._allDatasetsEmpty()) {
this._hide();
} else {
this.isOpen() && this._show();
}
return s._onRendered.apply(this, [].slice.call(arguments, 0));
},
_onCleared: function onCleared() {
if (this._allDatasetsEmpty()) {
this._hide();
} else {
this.isOpen() && this._show();
}
return s._onCleared.apply(this, [].slice.call(arguments, 0));
},
setLanguageDirection: function setLanguageDirection(dir) {
this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl);
return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0));
},
_hide: function hide() {
this.$node.hide();
},
_show: function show() {
this.$node.css("display", "block");
}
});
return DefaultMenu;
}();
var Typeahead = function() {
"use strict";
function Typeahead(o, www) {
var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged;
o = o || {};
if (!o.input) {
$.error("missing input");
}
if (!o.menu) {
$.error("missing menu");
}
if (!o.eventBus) {
$.error("missing event bus");
}
www.mixin(this);
this.eventBus = o.eventBus;
this.minLength = _.isNumber(o.minLength) ? o.minLength : 1;
this.input = o.input;
this.menu = o.menu;
this.enabled = true;
this.autoselect = !!o.autoselect;
this.active = false;
this.input.hasFocus() && this.activate();
this.dir = this.input.getLangDir();
this._hacks();
this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this);
onFocused = c(this, "activate", "open", "_onFocused");
onBlurred = c(this, "deactivate", "_onBlurred");
onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed");
onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed");
onEscKeyed = c(this, "isActive", "_onEscKeyed");
onUpKeyed = c(this, "isActive", "open", "_onUpKeyed");
onDownKeyed = c(this, "isActive", "open", "_onDownKeyed");
onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed");
onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed");
onQueryChanged = c(this, "_openIfActive", "_onQueryChanged");
onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged");
this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this);
}
_.mixin(Typeahead.prototype, {
_hacks: function hacks() {
var $input, $menu;
$input = this.input.$input || $("<div>");
$menu = this.menu.$node || $("<div>");
$input.on("blur.tt", function($e) {
var active, isActive, hasActive;
active = document.activeElement;
isActive = $menu.is(active);
hasActive = $menu.has(active).length > 0;
if (_.isMsie() && (isActive || hasActive)) {
$e.preventDefault();
$e.stopImmediatePropagation();
_.defer(function() {
$input.focus();
});
}
});
$menu.on("mousedown.tt", function($e) {
$e.preventDefault();
});
},
_onSelectableClicked: function onSelectableClicked(type, $el) {
this.select($el);
},
_onDatasetCleared: function onDatasetCleared() {
this._updateHint();
},
_onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) {
this._updateHint();
if (this.autoselect) {
var cursorClass = this.selectors.cursor.substr(1);
this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass);
}
this.eventBus.trigger("render", suggestions, async, dataset);
},
_onAsyncRequested: function onAsyncRequested(type, dataset, query) {
this.eventBus.trigger("asyncrequest", query, dataset);
},
_onAsyncCanceled: function onAsyncCanceled(type, dataset, query) {
this.eventBus.trigger("asynccancel", query, dataset);
},
_onAsyncReceived: function onAsyncReceived(type, dataset, query) {
this.eventBus.trigger("asyncreceive", query, dataset);
},
_onFocused: function onFocused() {
this._minLengthMet() && this.menu.update(this.input.getQuery());
},
_onBlurred: function onBlurred() {
if (this.input.hasQueryChangedSinceLastFocus()) {
this.eventBus.trigger("change", this.input.getQuery());
}
},
_onEnterKeyed: function onEnterKeyed(type, $e) {
var $selectable;
if ($selectable = this.menu.getActiveSelectable()) {
if (this.select($selectable)) {
$e.preventDefault();
$e.stopPropagation();
}
} else if (this.autoselect) {
if (this.select(this.menu.getTopSelectable())) {
$e.preventDefault();
$e.stopPropagation();
}
}
},
_onTabKeyed: function onTabKeyed(type, $e) {
var $selectable;
if ($selectable = this.menu.getActiveSelectable()) {
this.select($selectable) && $e.preventDefault();
} else if (this.autoselect) {
if ($selectable = this.menu.getTopSelectable()) {
this.autocomplete($selectable) && $e.preventDefault();
}
}
},
_onEscKeyed: function onEscKeyed() {
this.close();
},
_onUpKeyed: function onUpKeyed() {
this.moveCursor(-1);
},
_onDownKeyed: function onDownKeyed() {
this.moveCursor(+1);
},
_onLeftKeyed: function onLeftKeyed() {
if (this.dir === "rtl" && this.input.isCursorAtEnd()) {
this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
}
},
_onRightKeyed: function onRightKeyed() {
if (this.dir === "ltr" && this.input.isCursorAtEnd()) {
this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
}
},
_onQueryChanged: function onQueryChanged(e, query) {
this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty();
},
_onWhitespaceChanged: function onWhitespaceChanged() {
this._updateHint();
},
_onLangDirChanged: function onLangDirChanged(e, dir) {
if (this.dir !== dir) {
this.dir = dir;
this.menu.setLanguageDirection(dir);
}
},
_openIfActive: function openIfActive() {
this.isActive() && this.open();
},
_minLengthMet: function minLengthMet(query) {
query = _.isString(query) ? query : this.input.getQuery() || "";
return query.length >= this.minLength;
},
_updateHint: function updateHint() {
var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match;
$selectable = this.menu.getTopSelectable();
data = this.menu.getSelectableData($selectable);
val = this.input.getInputValue();
if (data && !_.isBlankString(val) && !this.input.hasOverflow()) {
query = Input.normalizeQuery(val);
escapedQuery = _.escapeRegExChars(query);
frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i");
match = frontMatchRegEx.exec(data.val);
match && this.input.setHint(val + match[1]);
} else {
this.input.clearHint();
}
},
isEnabled: function isEnabled() {
return this.enabled;
},
enable: function enable() {
this.enabled = true;
},
disable: function disable() {
this.enabled = false;
},
isActive: function isActive() {
return this.active;
},
activate: function activate() {
if (this.isActive()) {
return true;
} else if (!this.isEnabled() || this.eventBus.before("active")) {
return false;
} else {
this.active = true;
this.eventBus.trigger("active");
return true;
}
},
deactivate: function deactivate() {
if (!this.isActive()) {
return true;
} else if (this.eventBus.before("idle")) {
return false;
} else {
this.active = false;
this.close();
this.eventBus.trigger("idle");
return true;
}
},
isOpen: function isOpen() {
return this.menu.isOpen();
},
open: function open() {
if (!this.isOpen() && !this.eventBus.before("open")) {
this.input.setAriaExpanded(true);
this.menu.open();
this._updateHint();
this.eventBus.trigger("open");
}
return this.isOpen();
},
close: function close() {
if (this.isOpen() && !this.eventBus.before("close")) {
this.input.setAriaExpanded(false);
this.menu.close();
this.input.clearHint();
this.input.resetInputValue();
this.eventBus.trigger("close");
}
return !this.isOpen();
},
setVal: function setVal(val) {
this.input.setQuery(_.toStr(val));
},
getVal: function getVal() {
return this.input.getQuery();
},
select: function select($selectable) {
var data = this.menu.getSelectableData($selectable);
if (data && !this.eventBus.before("select", data.obj, data.dataset)) {
this.input.setQuery(data.val, true);
this.eventBus.trigger("select", data.obj, data.dataset);
this.close();
return true;
}
return false;
},
autocomplete: function autocomplete($selectable) {
var query, data, isValid;
query = this.input.getQuery();
data = this.menu.getSelectableData($selectable);
isValid = data && query !== data.val;
if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) {
this.input.setQuery(data.val);
this.eventBus.trigger("autocomplete", data.obj, data.dataset);
return true;
}
return false;
},
moveCursor: function moveCursor(delta) {
var query, $candidate, data, suggestion, datasetName, cancelMove, id;
query = this.input.getQuery();
$candidate = this.menu.selectableRelativeToCursor(delta);
data = this.menu.getSelectableData($candidate);
suggestion = data ? data.obj : null;
datasetName = data ? data.dataset : null;
id = $candidate ? $candidate.attr("id") : null;
this.input.trigger("cursorchange", id);
cancelMove = this._minLengthMet() && this.menu.update(query);
if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) {
this.menu.setCursor($candidate);
if (data) {
if (typeof data.val === "string") {
this.input.setInputValue(data.val);
}
} else {
this.input.resetInputValue();
this._updateHint();
}
this.eventBus.trigger("cursorchange", suggestion, datasetName);
return true;
}
return false;
},
destroy: function destroy() {
this.input.destroy();
this.menu.destroy();
}
});
return Typeahead;
function c(ctx) {
var methods = [].slice.call(arguments, 1);
return function() {
var args = [].slice.call(arguments);
_.each(methods, function(method) {
return ctx[method].apply(ctx, args);
});
};
}
}();
(function() {
"use strict";
var old, keys, methods;
old = $.fn.typeahead;
keys = {
www: "tt-www",
attrs: "tt-attrs",
typeahead: "tt-typeahead"
};
methods = {
initialize: function initialize(o, datasets) {
var www;
datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1);
o = o || {};
www = WWW(o.classNames);
return this.each(attach);
function attach() {
var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor;
_.each(datasets, function(d) {
d.highlight = !!o.highlight;
});
$input = $(this);
$wrapper = $(www.html.wrapper);
$hint = $elOrNull(o.hint);
$menu = $elOrNull(o.menu);
defaultHint = o.hint !== false && !$hint;
defaultMenu = o.menu !== false && !$menu;
defaultHint && ($hint = buildHintFromInput($input, www));
defaultMenu && ($menu = $(www.html.menu).css(www.css.menu));
$hint && $hint.val("");
$input = prepInput($input, www);
if (defaultHint || defaultMenu) {
$wrapper.css(www.css.wrapper);
$input.css(defaultHint ? www.css.input : www.css.inputWithNoHint);
$input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null);
}
MenuConstructor = defaultMenu ? DefaultMenu : Menu;
eventBus = new EventBus({
el: $input
});
input = new Input({
hint: $hint,
input: $input,
menu: $menu
}, www);
menu = new MenuConstructor({
node: $menu,
datasets: datasets
}, www);
status = new Status({
$input: $input,
menu: menu
});
typeahead = new Typeahead({
input: input,
menu: menu,
eventBus: eventBus,
minLength: o.minLength,
autoselect: o.autoselect
}, www);
$input.data(keys.www, www);
$input.data(keys.typeahead, typeahead);
}
},
isEnabled: function isEnabled() {
var enabled;
ttEach(this.first(), function(t) {
enabled = t.isEnabled();
});
return enabled;
},
enable: function enable() {
ttEach(this, function(t) {
t.enable();
});
return this;
},
disable: function disable() {
ttEach(this, function(t) {
t.disable();
});
return this;
},
isActive: function isActive() {
var active;
ttEach(this.first(), function(t) {
active = t.isActive();
});
return active;
},
activate: function activate() {
ttEach(this, function(t) {
t.activate();
});
return this;
},
deactivate: function deactivate() {
ttEach(this, function(t) {
t.deactivate();
});
return this;
},
isOpen: function isOpen() {
var open;
ttEach(this.first(), function(t) {
open = t.isOpen();
});
return open;
},
open: function open() {
ttEach(this, function(t) {
t.open();
});
return this;
},
close: function close() {
ttEach(this, function(t) {
t.close();
});
return this;
},
select: function select(el) {
var success = false, $el = $(el);
ttEach(this.first(), function(t) {
success = t.select($el);
});
return success;
},
autocomplete: function autocomplete(el) {
var success = false, $el = $(el);
ttEach(this.first(), function(t) {
success = t.autocomplete($el);
});
return success;
},
moveCursor: function moveCursoe(delta) {
var success = false;
ttEach(this.first(), function(t) {
success = t.moveCursor(delta);
});
return success;
},
val: function val(newVal) {
var query;
if (!arguments.length) {
ttEach(this.first(), function(t) {
query = t.getVal();
});
return query;
} else {
ttEach(this, function(t) {
t.setVal(_.toStr(newVal));
});
return this;
}
},
destroy: function destroy() {
ttEach(this, function(typeahead, $input) {
revert($input);
typeahead.destroy();
});
return this;
}
};
$.fn.typeahead = function(method) {
if (methods[method]) {
return methods[method].apply(this, [].slice.call(arguments, 1));
} else {
return methods.initialize.apply(this, arguments);
}
};
$.fn.typeahead.noConflict = function noConflict() {
$.fn.typeahead = old;
return this;
};
function ttEach($els, fn) {
$els.each(function() {
var $input = $(this), typeahead;
(typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input);
});
}
function buildHintFromInput($input, www) {
return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({
readonly: true,
required: false
}).removeAttr("id name placeholder").removeClass("required").attr({
spellcheck: "false",
tabindex: -1
});
}
function prepInput($input, www) {
$input.data(keys.attrs, {
dir: $input.attr("dir"),
autocomplete: $input.attr("autocomplete"),
spellcheck: $input.attr("spellcheck"),
style: $input.attr("style")
});
$input.addClass(www.classes.input).attr({
spellcheck: false
});
try {
!$input.attr("dir") && $input.attr("dir", "auto");
} catch (e) {}
return $input;
}
function getBackgroundStyles($el) {
return {
backgroundAttachment: $el.css("background-attachment"),
backgroundClip: $el.css("background-clip"),
backgroundColor: $el.css("background-color"),
backgroundImage: $el.css("background-image"),
backgroundOrigin: $el.css("background-origin"),
backgroundPosition: $el.css("background-position"),
backgroundRepeat: $el.css("background-repeat"),
backgroundSize: $el.css("background-size")
};
}
function revert($input) {
var www, $wrapper;
www = $input.data(keys.www);
$wrapper = $input.parent().filter(www.selectors.wrapper);
_.each($input.data(keys.attrs), function(val, key) {
_.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val);
});
$input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input);
if ($wrapper.length) {
$input.detach().insertAfter($wrapper);
$wrapper.remove();
}
}
function $elOrNull(obj) {
var isValid, $el;
isValid = _.isJQuery(obj) || _.isElement(obj);
$el = isValid ? $(obj).first() : [];
return $el.length ? $el : null;
}
})();
});
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/js/typeahead.jquery.js | javascript | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 13,257 |
```javascript
/**
* lunr - path_to_url - A bit like Solr, but much smaller and not as bright - 2.3.7
* @license MIT
*/
!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i<r.length;i++){var n=r[i],s=e[n];if(Array.isArray(s))t[n]=s.slice();else{if("string"!=typeof s&&"number"!=typeof s&&"boolean"!=typeof s)throw new TypeError("clone is not deep and does not support nested objects");t[n]=s}}return t},e.FieldRef=function(e,t,r){this.docRef=e,this.fieldName=t,this._stringValue=r},e.FieldRef.joiner="/",e.FieldRef.fromString=function(t){var r=t.indexOf(e.FieldRef.joiner);if(r===-1)throw"malformed field ref string";var i=t.slice(0,r),n=t.slice(r+1);return new e.FieldRef(n,i,t)},e.FieldRef.prototype.toString=function(){return void 0==this._stringValue&&(this._stringValue=this.fieldName+e.FieldRef.joiner+this.docRef),this._stringValue},e.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var t=0;t<this.length;t++)this.elements[e[t]]=!0}else this.length=0},e.Set.complete={intersect:function(e){return e},union:function(e){return e},contains:function(){return!0}},e.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},e.Set.prototype.contains=function(e){return!!this.elements[e]},e.Set.prototype.intersect=function(t){var r,i,n,s=[];if(t===e.Set.complete)return this;if(t===e.Set.empty)return t;this.length<t.length?(r=this,i=t):(r=t,i=this),n=Object.keys(r.elements);for(var o=0;o<n.length;o++){var a=n[o];a in i.elements&&s.push(a)}return new e.Set(s)},e.Set.prototype.union=function(t){return t===e.Set.complete?e.Set.complete:t===e.Set.empty?this:new e.Set(Object.keys(this.elements).concat(Object.keys(t.elements)))},e.idf=function(e,t){var r=0;for(var i in e)"_index"!=i&&(r+=Object.keys(e[i]).length);var n=(t-r+.5)/(r+.5);return Math.log(1+Math.abs(n))},e.Token=function(e,t){this.str=e||"",this.metadata=t||{}},e.Token.prototype.toString=function(){return this.str},e.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},e.Token.prototype.clone=function(t){return t=t||function(e){return e},new e.Token(t(this.str,this.metadata),this.metadata)},e.tokenizer=function(t,r){if(null==t||void 0==t)return[];if(Array.isArray(t))return t.map(function(t){return new e.Token(e.utils.asString(t).toLowerCase(),e.utils.clone(r))});for(var i=t.toString().toLowerCase(),n=i.length,s=[],o=0,a=0;o<=n;o++){var u=i.charAt(o),l=o-a;if(u.match(e.tokenizer.separator)||o==n){if(l>0){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r<t;r++){for(var i=this._stack[r],n=[],s=0;s<e.length;s++){var o=i(e[s],s,e);if(null!==o&&void 0!==o&&""!==o)if(Array.isArray(o))for(var a=0;a<o.length;a++)n.push(o[a]);else n.push(o)}e=n}return e},e.Pipeline.prototype.runString=function(t,r){var i=new e.Token(t,r);return this.run([i]).map(function(e){return e.toString()})},e.Pipeline.prototype.reset=function(){this._stack=[]},e.Pipeline.prototype.toJSON=function(){return this._stack.map(function(t){return e.Pipeline.warnIfFunctionNotRegistered(t),t.label})},e.Vector=function(e){this._magnitude=0,this.elements=e||[]},e.Vector.prototype.positionForIndex=function(e){if(0==this.elements.length)return 0;for(var t=0,r=this.elements.length/2,i=r-t,n=Math.floor(i/2),s=this.elements[2*n];i>1&&(s<e&&(t=n),s>e&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:s<e?2*(n+1):void 0},e.Vector.prototype.insert=function(e,t){this.upsert(e,t,function(){throw"duplicate index"})},e.Vector.prototype.upsert=function(e,t,r){this._magnitude=0;var i=this.positionForIndex(e);this.elements[i]==e?this.elements[i+1]=r(this.elements[i+1],t):this.elements.splice(i,0,e,t)},e.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,t=this.elements.length,r=1;r<t;r+=2){var i=this.elements[r];e+=i*i}return this._magnitude=Math.sqrt(e)},e.Vector.prototype.dot=function(e){for(var t=0,r=this.elements,i=e.elements,n=r.length,s=i.length,o=0,a=0,u=0,l=0;u<n&&l<s;)o=r[u],a=i[l],o<a?u+=2:o>a?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t<this.elements.length;t+=2,r++)e[r]=this.elements[t];return e},e.Vector.prototype.toJSON=function(){return this.elements},e.stemmer=function(){var e={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},t={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},r="[^aeiou]",i="[aeiouy]",n=r+"[^aeiouy]*",s=i+"[aeiou]*",o="^("+n+")?"+s+n,a="^("+n+")?"+s+n+"("+s+")?$",u="^("+n+")?"+s+n+s+n,l="^("+n+")?"+i,c=new RegExp(o),h=new RegExp(u),d=new RegExp(a),f=new RegExp(l),p=/^(.+?)(ss|i)es$/,y=/^(.+?)([^s])s$/,m=/^(.+?)eed$/,v=/^(.+?)(ed|ing)$/,g=/.$/,x=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\1$"),Q=new RegExp("^"+n+i+"[^aeiouwxy]$"),k=/^(.+?[^aeiou])y$/,S=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,L=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,b=/^(.+?)(s|t)(ion)$/,P=/^(.+?)e$/,T=/ll$/,O=new RegExp("^"+n+i+"[^aeiouwxy]$"),I=function(r){var i,n,s,o,a,u,l;if(r.length<3)return r;if(s=r.substr(0,1),"y"==s&&(r=s.toUpperCase()+r.substr(1)),o=p,a=y,o.test(r)?r=r.replace(o,"$1$2"):a.test(r)&&(r=r.replace(a,"$1$2")),o=m,a=v,o.test(r)){var I=o.exec(r);o=c,o.test(I[1])&&(o=g,r=r.replace(o,""))}else if(a.test(r)){var I=a.exec(r);i=I[1],a=f,a.test(i)&&(r=i,a=x,u=w,l=Q,a.test(r)?r+="e":u.test(r)?(o=g,r=r.replace(o,"")):l.test(r)&&(r+="e"))}if(o=k,o.test(r)){var I=o.exec(r);i=I[1],r=i+"i"}if(o=S,o.test(r)){var I=o.exec(r);i=I[1],n=I[2],o=c,o.test(i)&&(r=i+e[n])}if(o=E,o.test(r)){var I=o.exec(r);i=I[1],n=I[2],o=c,o.test(i)&&(r=i+t[n])}if(o=L,a=b,o.test(r)){var I=o.exec(r);i=I[1],o=h,o.test(i)&&(r=i)}else if(a.test(r)){var I=a.exec(r);i=I[1]+I[2],a=h,a.test(i)&&(r=i)}if(o=P,o.test(r)){var I=o.exec(r);i=I[1],o=h,a=d,u=O,(o.test(i)||a.test(i)&&!u.test(i))&&(r=i)}return o=T,a=h,o.test(r)&&a.test(r)&&(o=g,r=r.replace(o,"")),"y"==s&&(r=s.toLowerCase()+r.substr(1)),r};return function(e){return e.update(I)}}(),e.Pipeline.registerFunction(e.stemmer,"stemmer"),e.generateStopWordFilter=function(e){var t=e.reduce(function(e,t){return e[t]=t,e},{});return function(e){if(e&&t[e.toString()]!==e.toString())return e}},e.stopWordFilter=e.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),e.Pipeline.registerFunction(e.stopWordFilter,"stopWordFilter"),e.trimmer=function(e){return e.update(function(e){return e.replace(/^\W+/,"").replace(/\W+$/,"")})},e.Pipeline.registerFunction(e.trimmer,"trimmer"),e.TokenSet=function(){this["final"]=!1,this.edges={},this.id=e.TokenSet._nextId,e.TokenSet._nextId+=1},e.TokenSet._nextId=1,e.TokenSet.fromArray=function(t){for(var r=new e.TokenSet.Builder,i=0,n=t.length;i<n;i++)r.insert(t[i]);return r.finish(),r.root},e.TokenSet.fromClause=function(t){return"editDistance"in t?e.TokenSet.fromFuzzyString(t.term,t.editDistance):e.TokenSet.fromString(t.term)},e.TokenSet.fromFuzzyString=function(t,r){for(var i=new e.TokenSet,n=[{node:i,editsRemaining:r,str:t}];n.length;){var s=n.pop();if(s.str.length>0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n<s;n++){var o=t[n],a=n==s-1;if("*"==o)r.edges[o]=r,r["final"]=a;else{var u=new e.TokenSet;u["final"]=a,r.edges[o]=u,r=u}}return i},e.TokenSet.prototype.toArray=function(){for(var e=[],t=[{prefix:"",node:this}];t.length;){var r=t.pop(),i=Object.keys(r.node.edges),n=i.length;r.node["final"]&&(r.prefix.charAt(0),e.push(r.prefix));for(var s=0;s<n;s++){var o=i[s];t.push({prefix:r.prefix.concat(o),node:r.node.edges[o]})}}return e},e.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this["final"]?"1":"0",t=Object.keys(this.edges).sort(),r=t.length,i=0;i<r;i++){var n=t[i],s=this.edges[n];e=e+n+s.id}return e},e.TokenSet.prototype.intersect=function(t){for(var r=new e.TokenSet,i=void 0,n=[{qNode:t,output:r,node:this}];n.length;){i=n.pop();for(var s=Object.keys(i.qNode.edges),o=s.length,a=Object.keys(i.node.edges),u=a.length,l=0;l<o;l++)for(var c=s[l],h=0;h<u;h++){var d=a[h];if(d==c||"*"==c){var f=i.node.edges[d],p=i.qNode.edges[c],y=f["final"]&&p["final"],m=void 0;d in i.output.edges?(m=i.output.edges[d],m["final"]=m["final"]||y):(m=new e.TokenSet,m["final"]=y,i.output.edges[d]=m),n.push({qNode:p,output:m,node:f})}}}return r},e.TokenSet.Builder=function(){this.previousWord="",this.root=new e.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},e.TokenSet.Builder.prototype.insert=function(t){var r,i=0;if(t<this.previousWord)throw new Error("Out of order word insertion");for(var n=0;n<t.length&&n<this.previousWord.length&&t[n]==this.previousWord[n];n++)i++;this.minimize(i),r=0==this.uncheckedNodes.length?this.root:this.uncheckedNodes[this.uncheckedNodes.length-1].child;for(var n=i;n<t.length;n++){var s=new e.TokenSet,o=t[n];r.edges[o]=s,this.uncheckedNodes.push({parent:r,"char":o,child:s}),r=s}r["final"]=!0,this.previousWord=t},e.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},e.TokenSet.Builder.prototype.minimize=function(e){for(var t=this.uncheckedNodes.length-1;t>=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u<this.fields.length;u++)n[this.fields[u]]=new e.Vector;t.call(r,r);for(var u=0;u<r.clauses.length;u++){var l=r.clauses[u],c=null,h=e.Set.complete;c=l.usePipeline?this.pipeline.runString(l.term,{fields:l.fields}):[l.term];for(var d=0;d<c.length;d++){var f=c[d];l.term=f;var p=e.TokenSet.fromClause(l),y=this.tokenSet.intersect(p).toArray();if(0===y.length&&l.presence===e.Query.presence.REQUIRED){for(var m=0;m<l.fields.length;m++){var v=l.fields[m];o[v]=e.Set.empty}break}for(var g=0;g<y.length;g++)for(var x=y[g],w=this.invertedIndex[x],Q=w._index,m=0;m<l.fields.length;m++){var v=l.fields[m],k=w[v],S=Object.keys(k),E=x+"/"+v,L=new e.Set(S);if(l.presence==e.Query.presence.REQUIRED&&(h=h.union(L),void 0===o[v]&&(o[v]=e.Set.complete)),l.presence!=e.Query.presence.PROHIBITED){if(n[v].upsert(Q,l.boost,function(e,t){return e+t}),!s[E]){for(var b=0;b<S.length;b++){var P,T=S[b],O=new e.FieldRef(T,v),I=k[T];void 0===(P=i[O])?i[O]=new e.MatchData(x,v,I):P.add(x,v,I)}s[E]=!0}}else void 0===a[v]&&(a[v]=e.Set.empty),a[v]=a[v].union(L)}}if(l.presence===e.Query.presence.REQUIRED)for(var m=0;m<l.fields.length;m++){var v=l.fields[m];o[v]=o[v].intersect(h)}}for(var R=e.Set.complete,F=e.Set.empty,u=0;u<this.fields.length;u++){var v=this.fields[u];o[v]&&(R=R.intersect(o[v])),a[v]&&(F=F.union(a[v]))}var C=Object.keys(i),N=[],_=Object.create(null);if(r.isNegated()){C=Object.keys(this.fieldVectors);for(var u=0;u<C.length;u++){var O=C[u],j=e.FieldRef.fromString(O);i[O]=new e.MatchData}}for(var u=0;u<C.length;u++){var j=e.FieldRef.fromString(C[u]),D=j.docRef;if(R.contains(D)&&!F.contains(D)){var A,B=this.fieldVectors[j],V=n[j.fieldName].similarity(B);if(void 0!==(A=_[D]))A.score+=V,A.matchData.combine(i[j]);else{var z={ref:D,score:V,matchData:i[j]};_[D]=z,N.push(z)}}}return N.sort(function(e,t){return t.score-e.score})},e.Index.prototype.toJSON=function(){var t=Object.keys(this.invertedIndex).sort().map(function(e){return[e,this.invertedIndex[e]]},this),r=Object.keys(this.fieldVectors).map(function(e){return[e,this.fieldVectors[e].toJSON()]},this);return{version:e.version,fields:this.fields,fieldVectors:r,invertedIndex:t,pipeline:this.pipeline.toJSON()}},e.Index.load=function(t){var r={},i={},n=t.fieldVectors,s=Object.create(null),o=t.invertedIndex,a=new e.TokenSet.Builder,u=e.Pipeline.load(t.pipeline);t.version!=e.version&&e.utils.warn("Version mismatch when loading serialised index. Current version of lunr '"+e.version+"' does not match serialized index '"+t.version+"'");for(var l=0;l<n.length;l++){var c=n[l],h=c[0],d=c[1];i[h]=new e.Vector(d)}for(var l=0;l<o.length;l++){var c=o[l],f=c[0],p=c[1];a.insert(f),s[f]=p}return a.finish(),r.fields=t.fields,r.fieldVectors=i,r.invertedIndex=s,r.tokenSet=a.root,r.pipeline=u,new e.Index(r)},e.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=e.tokenizer,this.pipeline=new e.Pipeline,this.searchPipeline=new e.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},e.Builder.prototype.ref=function(e){this._ref=e},e.Builder.prototype.field=function(e,t){if(/\//.test(e))throw new RangeError("Field '"+e+"' contains illegal character '/'");this._fields[e]=t||{}},e.Builder.prototype.b=function(e){e<0?this._b=0:e>1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s<n.length;s++){var o=n[s],a=this._fields[o].extractor,u=a?a(t):t[o],l=this.tokenizer(u,{fields:[o]}),c=this.pipeline.run(l),h=new e.FieldRef(i,o),d=Object.create(null);this.fieldTermFrequencies[h]=d,this.fieldLengths[h]=0,this.fieldLengths[h]+=c.length;for(var f=0;f<c.length;f++){var p=c[f];if(void 0==d[p]&&(d[p]=0),d[p]+=1,void 0==this.invertedIndex[p]){var y=Object.create(null);y._index=this.termIndex,this.termIndex+=1;for(var m=0;m<n.length;m++)y[n[m]]=Object.create(null);this.invertedIndex[p]=y}void 0==this.invertedIndex[p][o][i]&&(this.invertedIndex[p][o][i]=Object.create(null));for(var v=0;v<this.metadataWhitelist.length;v++){var g=this.metadataWhitelist[v],x=p.metadata[g];void 0==this.invertedIndex[p][o][i][g]&&(this.invertedIndex[p][o][i][g]=[]),this.invertedIndex[p][o][i][g].push(x)}}}},e.Builder.prototype.calculateAverageFieldLengths=function(){for(var t=Object.keys(this.fieldLengths),r=t.length,i={},n={},s=0;s<r;s++){var o=e.FieldRef.fromString(t[s]),a=o.fieldName;n[a]||(n[a]=0),n[a]+=1,i[a]||(i[a]=0),i[a]+=this.fieldLengths[o]}for(var u=Object.keys(this._fields),s=0;s<u.length;s++){var l=u[s];i[l]=i[l]/n[l]}this.averageFieldLength=i},e.Builder.prototype.createFieldVectors=function(){for(var t={},r=Object.keys(this.fieldTermFrequencies),i=r.length,n=Object.create(null),s=0;s<i;s++){for(var o=e.FieldRef.fromString(r[s]),a=o.fieldName,u=this.fieldLengths[o],l=new e.Vector,c=this.fieldTermFrequencies[o],h=Object.keys(c),d=h.length,f=this._fields[a].boost||1,p=this._documents[o.docRef].boost||1,y=0;y<d;y++){var m,v,g,x=h[y],w=c[x],Q=this.invertedIndex[x]._index;void 0===n[x]?(m=e.idf(this.invertedIndex[x],this.documentCount),n[x]=m):m=n[x],v=m*((this._k1+1)*w)/(this._k1*(1-this._b+this._b*(u/this.averageFieldLength[a]))+w),v*=f,v*=p,g=Math.round(1e3*v)/1e3,l.insert(Q,g)}t[o]=l}this.fieldVectors=t},e.Builder.prototype.createTokenSet=function(){this.tokenSet=e.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},e.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new e.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:Object.keys(this._fields),pipeline:this.searchPipeline})},e.Builder.prototype.use=function(e){var t=Array.prototype.slice.call(arguments,1);t.unshift(this),e.apply(this,t)},e.MatchData=function(e,t,r){for(var i=Object.create(null),n=Object.keys(r||{}),s=0;s<n.length;s++){var o=n[s];i[o]=r[o].slice()}this.metadata=Object.create(null),void 0!==e&&(this.metadata[e]=Object.create(null),this.metadata[e][t]=i)},e.MatchData.prototype.combine=function(e){for(var t=Object.keys(e.metadata),r=0;r<t.length;r++){var i=t[r],n=Object.keys(e.metadata[i]);void 0==this.metadata[i]&&(this.metadata[i]=Object.create(null));for(var s=0;s<n.length;s++){var o=n[s],a=Object.keys(e.metadata[i][o]);void 0==this.metadata[i][o]&&(this.metadata[i][o]=Object.create(null));for(var u=0;u<a.length;u++){var l=a[u];void 0==this.metadata[i][o][l]?this.metadata[i][o][l]=e.metadata[i][o][l]:this.metadata[i][o][l]=this.metadata[i][o][l].concat(e.metadata[i][o][l])}}}},e.MatchData.prototype.add=function(e,t,r){if(!(e in this.metadata))return this.metadata[e]=Object.create(null),void(this.metadata[e][t]=r);if(!(t in this.metadata[e]))return void(this.metadata[e][t]=r);for(var i=Object.keys(r),n=0;n<i.length;n++){var s=i[n];s in this.metadata[e][t]?this.metadata[e][t][s]=this.metadata[e][t][s].concat(r[s]):this.metadata[e][t][s]=r[s]}},e.Query=function(e){this.clauses=[],this.allFields=e},e.Query.wildcard=new String("*"),e.Query.wildcard.NONE=0,e.Query.wildcard.LEADING=1,e.Query.wildcard.TRAILING=2,e.Query.presence={OPTIONAL:1,REQUIRED:2,PROHIBITED:3},e.Query.prototype.clause=function(t){return"fields"in t||(t.fields=this.allFields),"boost"in t||(t.boost=1),"usePipeline"in t||(t.usePipeline=!0),"wildcard"in t||(t.wildcard=e.Query.wildcard.NONE),t.wildcard&e.Query.wildcard.LEADING&&t.term.charAt(0)!=e.Query.wildcard&&(t.term="*"+t.term),t.wildcard&e.Query.wildcard.TRAILING&&t.term.slice(-1)!=e.Query.wildcard&&(t.term=""+t.term+"*"),"presence"in t||(t.presence=e.Query.presence.OPTIONAL),this.clauses.push(t),this},e.Query.prototype.isNegated=function(){for(var t=0;t<this.clauses.length;t++)if(this.clauses[t].presence!=e.Query.presence.PROHIBITED)return!1;return!0},e.Query.prototype.term=function(t,r){if(Array.isArray(t))return t.forEach(function(t){this.term(t,e.utils.clone(r))},this),this;var i=r||{};return i.term=t.toString(),this.clause(i),this},e.QueryParseError=function(e,t,r){this.name="QueryParseError",this.message=e,this.start=t,this.end=r},e.QueryParseError.prototype=new Error,e.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},e.QueryLexer.prototype.run=function(){for(var t=e.QueryLexer.lexText;t;)t=t(this)},e.QueryLexer.prototype.sliceString=function(){for(var e=[],t=this.start,r=this.pos,i=0;i<this.escapeCharPositions.length;i++)r=this.escapeCharPositions[i],e.push(this.str.slice(t,r)),t=r+1;return e.push(this.str.slice(t,this.pos)),this.escapeCharPositions.length=0,e.join("")},e.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},e.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},e.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos<this.length},e.QueryLexer.EOS="EOS",e.QueryLexer.FIELD="FIELD",e.QueryLexer.TERM="TERM",e.QueryLexer.EDIT_DISTANCE="EDIT_DISTANCE",e.QueryLexer.BOOST="BOOST",e.QueryLexer.PRESENCE="PRESENCE",e.QueryLexer.lexField=function(t){return t.backup(),t.emit(e.QueryLexer.FIELD),t.ignore(),e.QueryLexer.lexText},e.QueryLexer.lexTerm=function(t){if(t.width()>1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}();
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/js/lunr.min.js | javascript | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 8,870 |
```javascript
/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */
!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}S.fn=S.prototype={jquery:f,constructor:S,length:0,toArray:function(){return s.call(this)},get:function(e){return null==e?s.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=S.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return S.each(this,e)},map:function(n){return this.pushStack(S.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(s.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(S.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(S.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:u,sort:t.sort,splice:t.splice},S.extend=S.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||m(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(S.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||S.isPlainObject(n)?n:{},i=!1,a[t]=S.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},S.extend({expando:"jQuery"+(f+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==o.call(e))&&(!(t=r(e))||"function"==typeof(n=v.call(t,"constructor")&&t.constructor)&&a.call(n)===l)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){b(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(p(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},makeArray:function(e,t){var n=t||[];return null!=e&&(p(Object(e))?S.merge(n,"string"==typeof e?[e]:e):u.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:i.call(t,e,n)},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(p(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:y}),"function"==typeof Symbol&&(S.fn[Symbol.iterator]=t[Symbol.iterator]),S.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){n["[object "+t+"]"]=t.toLowerCase()});var d=function(n){var e,d,b,o,i,h,f,g,w,u,l,T,C,a,E,v,s,c,y,S="sizzle"+1*new Date,p=n.document,k=0,r=0,m=ue(),x=ue(),A=ue(),N=ue(),D=function(e,t){return e===t&&(l=!0),0},j={}.hasOwnProperty,t=[],q=t.pop,L=t.push,H=t.push,O=t.slice,P=function(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1},R="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",I="(?:\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",W="\\["+M+"*("+I+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+I+"))|)"+M+"*\\]",F=":("+I+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+W+")*)|.*)\\)|)",B=new RegExp(M+"+","g"),$=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),_=new RegExp("^"+M+"*,"+M+"*"),z=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="<a id='"+S+"'></a><select id='"+S+"-\r\\' msallowcapture=''><option selected=''></option></select>",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0<se(t,C,null,[e]).length},se.contains=function(e,t){return(e.ownerDocument||e)!=C&&T(e),y(e,t)},se.attr=function(e,t){(e.ownerDocument||e)!=C&&T(e);var n=b.attrHandle[t.toLowerCase()],r=n&&j.call(b.attrHandle,t.toLowerCase())?n(e,t,!E):void 0;return void 0!==r?r:d.attributes||!E?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},se.escape=function(e){return(e+"").replace(re,ie)},se.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},se.uniqueSort=function(e){var t,n=[],r=0,i=0;if(l=!d.detectDuplicates,u=!d.sortStable&&e.slice(0),e.sort(D),l){while(t=e[i++])t===e[i]&&(r=n.push(i));while(r--)e.splice(n[r],1)}return u=null,e},o=se.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=o(e)}else if(3===i||4===i)return e.nodeValue}else while(t=e[r++])n+=o(t);return n},(b=se.selectors={cacheLength:50,createPseudo:le,match:G,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1<t.indexOf(i):"$="===r?i&&t.slice(-i.length)===i:"~="===r?-1<(" "+t.replace(B," ")+" ").indexOf(i):"|="===r&&(t===i||t.slice(0,i.length+1)===i+"-"))}},CHILD:function(h,e,t,g,v){var y="nth"!==h.slice(0,3),m="last"!==h.slice(-4),x="of-type"===e;return 1===g&&0===v?function(e){return!!e.parentNode}:function(e,t,n){var r,i,o,a,s,u,l=y!==m?"nextSibling":"previousSibling",c=e.parentNode,f=x&&e.nodeName.toLowerCase(),p=!n&&!x,d=!1;if(c){if(y){while(l){a=e;while(a=a[l])if(x?a.nodeName.toLowerCase()===f:1===a.nodeType)return!1;u=l="only"===h&&!u&&"nextSibling"}return!0}if(u=[m?c.firstChild:c.lastChild],m&&p){d=(s=(r=(i=(o=(a=c)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1])&&r[2],a=s&&c.childNodes[s];while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if(1===a.nodeType&&++d&&a===e){i[h]=[k,s,d];break}}else if(p&&(d=s=(r=(i=(o=(a=e)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1]),!1===d)while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if((x?a.nodeName.toLowerCase()===f:1===a.nodeType)&&++d&&(p&&((i=(o=a[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]=[k,d]),a===e))break;return(d-=v)===g||d%g==0&&0<=d/g}}},PSEUDO:function(e,o){var t,a=b.pseudos[e]||b.setFilters[e.toLowerCase()]||se.error("unsupported pseudo: "+e);return a[S]?a(o):1<a.length?(t=[e,e,"",o],b.setFilters.hasOwnProperty(e.toLowerCase())?le(function(e,t){var n,r=a(e,o),i=r.length;while(i--)e[n=P(e,r[i])]=!(t[n]=r[i])}):function(e){return a(e,0,t)}):a}},pseudos:{not:le(function(e){var r=[],i=[],s=f(e.replace($,"$1"));return s[S]?le(function(e,t,n,r){var i,o=s(e,null,r,[]),a=e.length;while(a--)(i=o[a])&&(e[a]=!(t[a]=i))}):function(e,t,n){return r[0]=e,s(r,null,n,i),r[0]=null,!i.pop()}}),has:le(function(t){return function(e){return 0<se(t,e).length}}),contains:le(function(t){return t=t.replace(te,ne),function(e){return-1<(e.textContent||o(e)).indexOf(t)}}),lang:le(function(n){return V.test(n||"")||se.error("unsupported lang: "+n),n=n.replace(te,ne).toLowerCase(),function(e){var t;do{if(t=E?e.lang:e.getAttribute("xml:lang")||e.getAttribute("lang"))return(t=t.toLowerCase())===n||0===t.indexOf(n+"-")}while((e=e.parentNode)&&1===e.nodeType);return!1}}),target:function(e){var t=n.location&&n.location.hash;return t&&t.slice(1)===e.id},root:function(e){return e===a},focus:function(e){return e===C.activeElement&&(!C.hasFocus||C.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:ge(!1),disabled:ge(!0),checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!b.pseudos.empty(e)},header:function(e){return J.test(e.nodeName)},input:function(e){return Q.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:ve(function(){return[0]}),last:ve(function(e,t){return[t-1]}),eq:ve(function(e,t,n){return[n<0?n+t:n]}),even:ve(function(e,t){for(var n=0;n<t;n+=2)e.push(n);return e}),odd:ve(function(e,t){for(var n=1;n<t;n+=2)e.push(n);return e}),lt:ve(function(e,t,n){for(var r=n<0?n+t:t<n?t:n;0<=--r;)e.push(r);return e}),gt:ve(function(e,t,n){for(var r=n<0?n+t:n;++r<t;)e.push(r);return e})}}).pseudos.nth=b.pseudos.eq,{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})b.pseudos[e]=de(e);for(e in{submit:!0,reset:!0})b.pseudos[e]=he(e);function me(){}function xe(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function be(s,e,t){var u=e.dir,l=e.next,c=l||u,f=t&&"parentNode"===c,p=r++;return e.first?function(e,t,n){while(e=e[u])if(1===e.nodeType||f)return s(e,t,n);return!1}:function(e,t,n){var r,i,o,a=[k,p];if(n){while(e=e[u])if((1===e.nodeType||f)&&s(e,t,n))return!0}else while(e=e[u])if(1===e.nodeType||f)if(i=(o=e[S]||(e[S]={}))[e.uniqueID]||(o[e.uniqueID]={}),l&&l===e.nodeName.toLowerCase())e=e[u]||e;else{if((r=i[c])&&r[0]===k&&r[1]===p)return a[2]=r[2];if((i[c]=a)[2]=s(e,t,n))return!0}return!1}}function we(i){return 1<i.length?function(e,t,n){var r=i.length;while(r--)if(!i[r](e,t,n))return!1;return!0}:i[0]}function Te(e,t,n,r,i){for(var o,a=[],s=0,u=e.length,l=null!=t;s<u;s++)(o=e[s])&&(n&&!n(o,r,i)||(a.push(o),l&&t.push(s)));return a}function Ce(d,h,g,v,y,e){return v&&!v[S]&&(v=Ce(v)),y&&!y[S]&&(y=Ce(y,e)),le(function(e,t,n,r){var i,o,a,s=[],u=[],l=t.length,c=e||function(e,t,n){for(var r=0,i=t.length;r<i;r++)se(e,t[r],n);return n}(h||"*",n.nodeType?[n]:n,[]),f=!d||!e&&h?c:Te(c,s,d,n,r),p=g?y||(e?d:l||v)?[]:t:f;if(g&&g(f,p,n,r),v){i=Te(p,u),v(i,[],n,r),o=i.length;while(o--)(a=i[o])&&(p[u[o]]=!(f[u[o]]=a))}if(e){if(y||d){if(y){i=[],o=p.length;while(o--)(a=p[o])&&i.push(f[o]=a);y(null,p=[],i,r)}o=p.length;while(o--)(a=p[o])&&-1<(i=y?P(e,a):s[o])&&(e[i]=!(t[i]=a))}}else p=Te(p===t?p.splice(l,p.length):p),y?y(null,t,p,r):H.apply(t,p)})}function Ee(e){for(var i,t,n,r=e.length,o=b.relative[e[0].type],a=o||b.relative[" "],s=o?1:0,u=be(function(e){return e===i},a,!0),l=be(function(e){return-1<P(i,e)},a,!0),c=[function(e,t,n){var r=!o&&(n||t!==w)||((i=t).nodeType?u(e,t,n):l(e,t,n));return i=null,r}];s<r;s++)if(t=b.relative[e[s].type])c=[be(we(c),t)];else{if((t=b.filter[e[s].type].apply(null,e[s].matches))[S]){for(n=++s;n<r;n++)if(b.relative[e[n].type])break;return Ce(1<s&&we(c),1<s&&xe(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace($,"$1"),t,s<n&&Ee(e.slice(s,n)),n<r&&Ee(e=e.slice(n)),n<r&&xe(e))}c.push(t)}return we(c)}return me.prototype=b.filters=b.pseudos,b.setFilters=new me,h=se.tokenize=function(e,t){var n,r,i,o,a,s,u,l=x[e+" "];if(l)return t?0:l.slice(0);a=e,s=[],u=b.preFilter;while(a){for(o in n&&!(r=_.exec(a))||(r&&(a=a.slice(r[0].length)||a),s.push(i=[])),n=!1,(r=z.exec(a))&&(n=r.shift(),i.push({value:n,type:r[0].replace($," ")}),a=a.slice(n.length)),b.filter)!(r=G[o].exec(a))||u[o]&&!(r=u[o](r))||(n=r.shift(),i.push({value:n,type:o,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?se.error(e):x(e,s).slice(0)},f=se.compile=function(e,t){var n,v,y,m,x,r,i=[],o=[],a=A[e+" "];if(!a){t||(t=h(e)),n=t.length;while(n--)(a=Ee(t[n]))[S]?i.push(a):o.push(a);(a=A(e,(v=o,m=0<(y=i).length,x=0<v.length,r=function(e,t,n,r,i){var o,a,s,u=0,l="0",c=e&&[],f=[],p=w,d=e||x&&b.find.TAG("*",i),h=k+=null==p?1:Math.random()||.1,g=d.length;for(i&&(w=t==C||t||i);l!==g&&null!=(o=d[l]);l++){if(x&&o){a=0,t||o.ownerDocument==C||(T(o),n=!E);while(s=v[a++])if(s(o,t||C,n)){r.push(o);break}i&&(k=h)}m&&((o=!s&&o)&&u--,e&&c.push(o))}if(u+=l,m&&l!==u){a=0;while(s=y[a++])s(c,f,t,n);if(e){if(0<u)while(l--)c[l]||f[l]||(f[l]=q.call(r));f=Te(f)}H.apply(r,f),i&&!e&&0<f.length&&1<u+y.length&&se.uniqueSort(r)}return i&&(k=h,w=p),c},m?le(r):r))).selector=e}return a},g=se.select=function(e,t,n,r){var i,o,a,s,u,l="function"==typeof e&&e,c=!r&&h(e=l.selector||e);if(n=n||[],1===c.length){if(2<(o=c[0]=c[0].slice(0)).length&&"ID"===(a=o[0]).type&&9===t.nodeType&&E&&b.relative[o[1].type]){if(!(t=(b.find.ID(a.matches[0].replace(te,ne),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}i=G.needsContext.test(e)?0:o.length;while(i--){if(a=o[i],b.relative[s=a.type])break;if((u=b.find[s])&&(r=u(a.matches[0].replace(te,ne),ee.test(o[0].type)&&ye(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&xe(o)))return H.apply(n,r),n;break}}}return(l||f(e,c))(r,t,!E,n,!t||ee.test(e)&&ye(t.parentNode)||t),n},d.sortStable=S.split("").sort(D).join("")===S,d.detectDuplicates=!!l,T(),d.sortDetached=ce(function(e){return 1&e.compareDocumentPosition(C.createElement("fieldset"))}),ce(function(e){return e.innerHTML="<a href='#'></a>","#"===e.firstChild.getAttribute("href")})||fe("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),d.attributes&&ce(function(e){return e.innerHTML="<input/>",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||fe("value",function(e,t,n){if(!n&&"input"===e.nodeName.toLowerCase())return e.defaultValue}),ce(function(e){return null==e.getAttribute("disabled")})||fe(R,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),se}(C);S.find=d,S.expr=d.selectors,S.expr[":"]=S.expr.pseudos,S.uniqueSort=S.unique=d.uniqueSort,S.text=d.getText,S.isXMLDoc=d.isXML,S.contains=d.contains,S.escapeSelector=d.escape;var h=function(e,t,n){var r=[],i=void 0!==n;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&S(e).is(n))break;r.push(e)}return r},T=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},k=S.expr.match.needsContext;function A(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}var N=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1<i.call(n,e)!==r}):S.filter(n,e,r)}S.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?S.find.matchesSelector(r,e)?[r]:[]:S.find.matches(e,S.grep(t,function(e){return 1===e.nodeType}))},S.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(S(e).filter(function(){for(t=0;t<r;t++)if(S.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)S.find(e,i[t],n);return 1<r?S.uniqueSort(n):n},filter:function(e){return this.pushStack(D(this,e||[],!1))},not:function(e){return this.pushStack(D(this,e||[],!0))},is:function(e){return!!D(this,"string"==typeof e&&k.test(e)?S(e):e||[],!1).length}});var j,q=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(S.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],a="string"!=typeof e&&S(e);if(!k.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(a?-1<a.index(n):1===n.nodeType&&S.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(1<o.length?S.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?i.call(S(e),this[0]):i.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(S.uniqueSort(S.merge(this.get(),S(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),S.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return h(e,"parentNode")},parentsUntil:function(e,t,n){return h(e,"parentNode",n)},next:function(e){return O(e,"nextSibling")},prev:function(e){return O(e,"previousSibling")},nextAll:function(e){return h(e,"nextSibling")},prevAll:function(e){return h(e,"previousSibling")},nextUntil:function(e,t,n){return h(e,"nextSibling",n)},prevUntil:function(e,t,n){return h(e,"previousSibling",n)},siblings:function(e){return T((e.parentNode||{}).firstChild,e)},children:function(e){return T(e.firstChild)},contents:function(e){return null!=e.contentDocument&&r(e.contentDocument)?e.contentDocument:(A(e,"template")&&(e=e.content||e),S.merge([],e.childNodes))}},function(r,i){S.fn[r]=function(e,t){var n=S.map(this,i,e);return"Until"!==r.slice(-5)&&(t=e),t&&"string"==typeof t&&(n=S.filter(t,n)),1<this.length&&(H[r]||S.uniqueSort(n),L.test(r)&&n.reverse()),this.pushStack(n)}});var P=/[^\x20\t\r\n\f]+/g;function R(e){return e}function M(e){throw e}function I(e,t,n,r){var i;try{e&&m(i=e.promise)?i.call(e).done(t).fail(n):e&&m(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}S.Callbacks=function(r){var e,n;r="string"==typeof r?(e=r,n={},S.each(e.match(P)||[],function(e,t){n[t]=!0}),n):S.extend({},r);var i,t,o,a,s=[],u=[],l=-1,c=function(){for(a=a||r.once,o=i=!0;u.length;l=-1){t=u.shift();while(++l<s.length)!1===s[l].apply(t[0],t[1])&&r.stopOnFalse&&(l=s.length,t=!1)}r.memory||(t=!1),i=!1,a&&(s=t?[]:"")},f={add:function(){return s&&(t&&!i&&(l=s.length-1,u.push(t)),function n(e){S.each(e,function(e,t){m(t)?r.unique&&f.has(t)||s.push(t):t&&t.length&&"string"!==w(t)&&n(t)})}(arguments),t&&!i&&c()),this},remove:function(){return S.each(arguments,function(e,t){var n;while(-1<(n=S.inArray(t,s,n)))s.splice(n,1),n<=l&&l--}),this},has:function(e){return e?-1<S.inArray(e,s):0<s.length},empty:function(){return s&&(s=[]),this},disable:function(){return a=u=[],s=t="",this},disabled:function(){return!s},lock:function(){return a=u=[],t||i||(s=t=""),this},locked:function(){return!!a},fireWith:function(e,t){return a||(t=[e,(t=t||[]).slice?t.slice():t],u.push(t),i||c()),this},fire:function(){return f.fireWith(this,arguments),this},fired:function(){return!!o}};return f},S.extend({Deferred:function(e){var o=[["notify","progress",S.Callbacks("memory"),S.Callbacks("memory"),2],["resolve","done",S.Callbacks("once memory"),S.Callbacks("once memory"),0,"resolved"],["reject","fail",S.Callbacks("once memory"),S.Callbacks("once memory"),1,"rejected"]],i="pending",a={state:function(){return i},always:function(){return s.done(arguments).fail(arguments),this},"catch":function(e){return a.then(null,e)},pipe:function(){var i=arguments;return S.Deferred(function(r){S.each(o,function(e,t){var n=m(i[t[4]])&&i[t[4]];s[t[1]](function(){var e=n&&n.apply(this,arguments);e&&m(e.promise)?e.promise().progress(r.notify).done(r.resolve).fail(r.reject):r[t[0]+"With"](this,n?[e]:arguments)})}),i=null}).promise()},then:function(t,n,r){var u=0;function l(i,o,a,s){return function(){var n=this,r=arguments,e=function(){var e,t;if(!(i<u)){if((e=a.apply(n,r))===o.promise())throw new TypeError("Thenable self-resolution");t=e&&("object"==typeof e||"function"==typeof e)&&e.then,m(t)?s?t.call(e,l(u,o,R,s),l(u,o,M,s)):(u++,t.call(e,l(u,o,R,s),l(u,o,M,s),l(u,o,R,o.notifyWith))):(a!==R&&(n=void 0,r=[e]),(s||o.resolveWith)(n,r))}},t=s?e:function(){try{e()}catch(e){S.Deferred.exceptionHook&&S.Deferred.exceptionHook(e,t.stackTrace),u<=i+1&&(a!==M&&(n=void 0,r=[e]),o.rejectWith(n,r))}};i?t():(S.Deferred.getStackHook&&(t.stackTrace=S.Deferred.getStackHook()),C.setTimeout(t))}}return S.Deferred(function(e){o[0][3].add(l(0,e,m(r)?r:R,e.notifyWith)),o[1][3].add(l(0,e,m(t)?t:R)),o[2][3].add(l(0,e,m(n)?n:M))}).promise()},promise:function(e){return null!=e?S.extend(e,a):a}},s={};return S.each(o,function(e,t){var n=t[2],r=t[5];a[t[1]]=n.add,r&&n.add(function(){i=r},o[3-e][2].disable,o[3-e][3].disable,o[0][2].lock,o[0][3].lock),n.add(t[3].fire),s[t[0]]=function(){return s[t[0]+"With"](this===s?void 0:this,arguments),this},s[t[0]+"With"]=n.fireWith}),a.promise(s),e&&e.call(s,s),s},when:function(e){var n=arguments.length,t=n,r=Array(t),i=s.call(arguments),o=S.Deferred(),a=function(t){return function(e){r[t]=this,i[t]=1<arguments.length?s.call(arguments):e,--n||o.resolveWith(r,i)}};if(n<=1&&(I(e,o.done(a(t)).resolve,o.reject,!n),"pending"===o.state()||m(i[t]&&i[t].then)))return o.then();while(t--)I(i[t],a(t),o.reject);return o.promise()}});var W=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;S.Deferred.exceptionHook=function(e,t){C.console&&C.console.warn&&e&&W.test(e.name)&&C.console.warn("jQuery.Deferred exception: "+e.message,e.stack,t)},S.readyException=function(e){C.setTimeout(function(){throw e})};var F=S.Deferred();function B(){E.removeEventListener("DOMContentLoaded",B),C.removeEventListener("load",B),S.ready()}S.fn.ready=function(e){return F.then(e)["catch"](function(e){S.readyException(e)}),this},S.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--S.readyWait:S.isReady)||(S.isReady=!0)!==e&&0<--S.readyWait||F.resolveWith(E,[S])}}),S.ready.then=F.then,"complete"===E.readyState||"loading"!==E.readyState&&!E.documentElement.doScroll?C.setTimeout(S.ready):(E.addEventListener("DOMContentLoaded",B),C.addEventListener("load",B));var $=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===w(n))for(s in i=!0,n)$(e,t,s,n[s],!0,o,a);else if(void 0!==r&&(i=!0,m(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(S(e),n)})),t))for(;s<u;s++)t(e[s],n,a?r:r.call(e[s],s,t(e[s],n)));return i?e:l?t.call(e):u?t(e[0],n):o},_=/^-ms-/,z=/-([a-z])/g;function U(e,t){return t.toUpperCase()}function X(e){return e.replace(_,"ms-").replace(z,U)}var V=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};function G(){this.expando=S.expando+G.uid++}G.uid=1,G.prototype={cache:function(e){var t=e[this.expando];return t||(t={},V(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[X(t)]=n;else for(r in t)i[X(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][X(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){n=(t=Array.isArray(t)?t.map(X):(t=X(t))in r?[t]:t.match(P)||[]).length;while(n--)delete r[t[n]]}(void 0===t||S.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!S.isEmptyObject(t)}};var Y=new G,Q=new G,J=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,K=/[A-Z]/g;function Z(e,t,n){var r,i;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(K,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===(i=n)||"false"!==i&&("null"===i?null:i===+i+""?+i:J.test(i)?JSON.parse(i):i)}catch(e){}Q.set(e,t,n)}else n=void 0;return n}S.extend({hasData:function(e){return Q.hasData(e)||Y.hasData(e)},data:function(e,t,n){return Q.access(e,t,n)},removeData:function(e,t){Q.remove(e,t)},_data:function(e,t,n){return Y.access(e,t,n)},_removeData:function(e,t){Y.remove(e,t)}}),S.fn.extend({data:function(n,e){var t,r,i,o=this[0],a=o&&o.attributes;if(void 0===n){if(this.length&&(i=Q.get(o),1===o.nodeType&&!Y.get(o,"hasDataAttrs"))){t=a.length;while(t--)a[t]&&0===(r=a[t].name).indexOf("data-")&&(r=X(r.slice(5)),Z(o,r,i[r]));Y.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof n?this.each(function(){Q.set(this,n)}):$(this,function(e){var t;if(o&&void 0===e)return void 0!==(t=Q.get(o,n))?t:void 0!==(t=Z(o,n))?t:void 0;this.each(function(){Q.set(this,n,e)})},null,e,1<arguments.length,null,!0)},removeData:function(e){return this.each(function(){Q.remove(this,e)})}}),S.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=Y.get(e,t),n&&(!r||Array.isArray(n)?r=Y.access(e,t,S.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=S.queue(e,t),r=n.length,i=n.shift(),o=S._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){S.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return Y.get(e,n)||Y.access(e,n,{empty:S.Callbacks("once memory").add(function(){Y.remove(e,[t+"queue",n])})})}}),S.fn.extend({queue:function(t,n){var e=2;return"string"!=typeof t&&(n=t,t="fx",e--),arguments.length<e?S.queue(this[0],t):void 0===n?this:this.each(function(){var e=S.queue(this,t,n);S._queueHooks(this,t),"fx"===t&&"inprogress"!==e[0]&&S.dequeue(this,t)})},dequeue:function(e){return this.each(function(){S.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=S.Deferred(),o=this,a=this.length,s=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=void 0),e=e||"fx";while(a--)(n=Y.get(o[a],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(s));return s(),i.promise(t)}});var ee=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,te=new RegExp("^(?:([+-])=|)("+ee+")([a-z%]*)$","i"),ne=["Top","Right","Bottom","Left"],re=E.documentElement,ie=function(e){return S.contains(e.ownerDocument,e)},oe={composed:!0};re.getRootNode&&(ie=function(e){return S.contains(e.ownerDocument,e)||e.getRootNode(oe)===e.ownerDocument});var ae=function(e,t){return"none"===(e=t||e).style.display||""===e.style.display&&ie(e)&&"none"===S.css(e,"display")};function se(e,t,n,r){var i,o,a=20,s=r?function(){return r.cur()}:function(){return S.css(e,t,"")},u=s(),l=n&&n[3]||(S.cssNumber[t]?"":"px"),c=e.nodeType&&(S.cssNumber[t]||"px"!==l&&+u)&&te.exec(S.css(e,t));if(c&&c[3]!==l){u/=2,l=l||c[3],c=+u||1;while(a--)S.style(e,t,c+l),(1-o)*(1-(o=s()/u||.5))<=0&&(a=0),c/=o;c*=2,S.style(e,t,c+l),n=n||[]}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}var ue={};function le(e,t){for(var n,r,i,o,a,s,u,l=[],c=0,f=e.length;c<f;c++)(r=e[c]).style&&(n=r.style.display,t?("none"===n&&(l[c]=Y.get(r,"display")||null,l[c]||(r.style.display="")),""===r.style.display&&ae(r)&&(l[c]=(u=a=o=void 0,a=(i=r).ownerDocument,s=i.nodeName,(u=ue[s])||(o=a.body.appendChild(a.createElement(s)),u=S.css(o,"display"),o.parentNode.removeChild(o),"none"===u&&(u="block"),ue[s]=u)))):"none"!==n&&(l[c]="none",Y.set(r,"display",n)));for(c=0;c<f;c++)null!=l[c]&&(e[c].style.display=l[c]);return e}S.fn.extend({show:function(){return le(this,!0)},hide:function(){return le(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){ae(this)?S(this).show():S(this).hide()})}});var ce,fe,pe=/^(?:checkbox|radio)$/i,de=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="<textarea>x</textarea>",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="<option></option>",y.option=!!ce.lastChild;var ge={thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n<r;n++)Y.set(e[n],"globalEval",!t||Y.get(t[n],"globalEval"))}ge.tbody=ge.tfoot=ge.colgroup=ge.caption=ge.thead,ge.th=ge.td,y.option||(ge.optgroup=ge.option=[1,"<select multiple='multiple'>","</select>"]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d<h;d++)if((o=e[d])||0===o)if("object"===w(o))S.merge(p,o.nodeType?[o]:o);else if(me.test(o)){a=a||f.appendChild(t.createElement("div")),s=(de.exec(o)||["",""])[1].toLowerCase(),u=ge[s]||ge._default,a.innerHTML=u[1]+S.htmlPrefilter(o)+u[2],c=u[0];while(c--)a=a.lastChild;S.merge(p,a.childNodes),(a=f.firstChild).textContent=""}else p.push(t.createTextNode(o));f.textContent="",d=0;while(o=p[d++])if(r&&-1<S.inArray(o,r))i&&i.push(o);else if(l=ie(o),a=ve(f.appendChild(o),"script"),l&&ye(a),n){c=0;while(o=a[c++])he.test(o.type||"")&&n.push(o)}return f}var be=/^key/,we=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Te=/^([^.]*)(?:\.(.+)|)/;function Ce(){return!0}function Ee(){return!1}function Se(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function ke(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)ke(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Ee;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return S().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=S.guid++)),e.each(function(){S.event.add(this,t,i,r,n)})}function Ae(e,i,o){o?(Y.set(e,i,!1),S.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Y.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(S.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Y.set(this,i,r),t=o(this,i),this[i](),r!==(n=Y.get(this,i))||t?Y.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Y.set(this,i,{value:S.event.trigger(S.extend(r[0],S.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Y.get(e,i)&&S.event.add(e,i,Ce)}S.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.get(t);if(V(t)){n.handler&&(n=(o=n).handler,i=o.selector),i&&S.find.matchesSelector(re,i),n.guid||(n.guid=S.guid++),(u=v.events)||(u=v.events=Object.create(null)),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof S&&S.event.triggered!==e.type?S.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(P)||[""]).length;while(l--)d=g=(s=Te.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=S.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=S.event.special[d]||{},c=S.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&S.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),S.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.hasData(e)&&Y.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(P)||[""]).length;while(l--)if(d=g=(s=Te.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=S.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||S.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)S.event.remove(e,d+t[l],n,r,!0);S.isEmptyObject(u)&&Y.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=new Array(arguments.length),u=S.event.fix(e),l=(Y.get(this,"events")||Object.create(null))[u.type]||[],c=S.event.special[u.type]||{};for(s[0]=u,t=1;t<arguments.length;t++)s[t]=arguments[t];if(u.delegateTarget=this,!c.preDispatch||!1!==c.preDispatch.call(this,u)){a=S.event.handlers.call(this,u,l),t=0;while((i=a[t++])&&!u.isPropagationStopped()){u.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!u.isImmediatePropagationStopped())u.rnamespace&&!1!==o.namespace&&!u.rnamespace.test(o.namespace)||(u.handleObj=o,u.data=o.data,void 0!==(r=((S.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,s))&&!1===(u.result=r)&&(u.preventDefault(),u.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,u),u.result}},handlers:function(e,t){var n,r,i,o,a,s=[],u=t.delegateCount,l=e.target;if(u&&l.nodeType&&!("click"===e.type&&1<=e.button))for(;l!==this;l=l.parentNode||this)if(1===l.nodeType&&("click"!==e.type||!0!==l.disabled)){for(o=[],a={},n=0;n<u;n++)void 0===a[i=(r=t[n]).selector+" "]&&(a[i]=r.needsContext?-1<S(i,this).index(l):S.find(i,this,null,[l]).length),a[i]&&o.push(r);o.length&&s.push({elem:l,handlers:o})}return l=this,u<t.length&&s.push({elem:l,handlers:t.slice(u)}),s},addProp:function(t,e){Object.defineProperty(S.Event.prototype,t,{enumerable:!0,configurable:!0,get:m(e)?function(){if(this.originalEvent)return e(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[t]},set:function(e){Object.defineProperty(this,t,{enumerable:!0,configurable:!0,writable:!0,value:e})}})},fix:function(e){return e[S.expando]?e:new S.Event(e)},special:{load:{noBubble:!0},click:{setup:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click",Ce),!1},trigger:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click"),!0},_default:function(e){var t=e.target;return pe.test(t.type)&&t.click&&A(t,"input")&&Y.get(t,"click")||A(t,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},S.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},S.Event=function(e,t){if(!(this instanceof S.Event))return new S.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?Ce:Ee,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&S.extend(this,t),this.timeStamp=e&&e.timeStamp||Date.now(),this[S.expando]=!0},S.Event.prototype={constructor:S.Event,isDefaultPrevented:Ee,isPropagationStopped:Ee,isImmediatePropagationStopped:Ee,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=Ce,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=Ce,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=Ce,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},S.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,code:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(e){var t=e.button;return null==e.which&&be.test(e.type)?null!=e.charCode?e.charCode:e.keyCode:!e.which&&void 0!==t&&we.test(e.type)?1&t?1:2&t?3:4&t?2:0:e.which}},S.event.addProp),S.each({focus:"focusin",blur:"focusout"},function(e,t){S.event.special[e]={setup:function(){return Ae(this,e,Se),!1},trigger:function(){return Ae(this,e),!0},delegateType:t}}),S.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,i){S.event.special[e]={delegateType:i,bindType:i,handle:function(e){var t,n=e.relatedTarget,r=e.handleObj;return n&&(n===this||S.contains(this,n))||(e.type=r.origType,t=r.handler.apply(this,arguments),e.type=i),t}}}),S.fn.extend({on:function(e,t,n,r){return ke(this,e,t,n,r)},one:function(e,t,n,r){return ke(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,S(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=Ee),this.each(function(){S.event.remove(this,e,n,t)})}});var Ne=/<script|<style|<link/i,De=/checked\s*(?:[^=]|=\s*.checked.)/i,je=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n<r;n++)S.event.add(t,i,s[i][n]);Q.hasData(e)&&(o=Q.access(e),a=S.extend({},o),Q.set(t,a))}}function Pe(n,r,i,o){r=g(r);var e,t,a,s,u,l,c=0,f=n.length,p=f-1,d=r[0],h=m(d);if(h||1<f&&"string"==typeof d&&!y.checkClone&&De.test(d))return n.each(function(e){var t=n.eq(e);h&&(r[0]=d.call(this,e,t.html())),Pe(t,r,i,o)});if(f&&(t=(e=xe(r,n[0].ownerDocument,!1,n,o)).firstChild,1===e.childNodes.length&&(e=t),t||o)){for(s=(a=S.map(ve(e,"script"),Le)).length;c<f;c++)u=e,c!==p&&(u=S.clone(u,!0,!0),s&&S.merge(a,ve(u,"script"))),i.call(n[c],u,c);if(s)for(l=a[a.length-1].ownerDocument,S.map(a,He),c=0;c<s;c++)u=a[c],he.test(u.type||"")&&!Y.access(u,"globalEval")&&S.contains(l,u)&&(u.src&&"module"!==(u.type||"").toLowerCase()?S._evalUrl&&!u.noModule&&S._evalUrl(u.src,{nonce:u.nonce||u.getAttribute("nonce")},l):b(u.textContent.replace(je,""),u,l))}return n}function Re(e,t,n){for(var r,i=t?S.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||S.cleanData(ve(r)),r.parentNode&&(n&&ie(r)&&ye(ve(r,"script")),r.parentNode.removeChild(r));return e}S.extend({htmlPrefilter:function(e){return e},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=ie(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||S.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r<i;r++)s=o[r],u=a[r],void 0,"input"===(l=u.nodeName.toLowerCase())&&pe.test(s.type)?u.checked=s.checked:"input"!==l&&"textarea"!==l||(u.defaultValue=s.defaultValue);if(t)if(n)for(o=o||ve(e),a=a||ve(c),r=0,i=o.length;r<i;r++)Oe(o[r],a[r]);else Oe(e,c);return 0<(a=ve(c,"script")).length&&ye(a,!f&&ve(e,"script")),c},cleanData:function(e){for(var t,n,r,i=S.event.special,o=0;void 0!==(n=e[o]);o++)if(V(n)){if(t=n[Y.expando]){if(t.events)for(r in t.events)i[r]?S.event.remove(n,r):S.removeEvent(n,r,t.handle);n[Y.expando]=void 0}n[Q.expando]&&(n[Q.expando]=void 0)}}}),S.fn.extend({detach:function(e){return Re(this,e,!0)},remove:function(e){return Re(this,e)},text:function(e){return $(this,function(e){return void 0===e?S.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return Pe(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||qe(this,e).appendChild(e)})},prepend:function(){return Pe(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=qe(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(S.cleanData(ve(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return S.clone(this,e,t)})},html:function(e){return $(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Ne.test(e)&&!ge[(de.exec(e)||["",""])[1].toLowerCase()]){e=S.htmlPrefilter(e);try{for(;n<r;n++)1===(t=this[n]||{}).nodeType&&(S.cleanData(ve(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var n=[];return Pe(this,arguments,function(e){var t=this.parentNode;S.inArray(this,n)<0&&(S.cleanData(ve(this)),t&&t.replaceChild(e,this))},n)}}),S.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,a){S.fn[e]=function(e){for(var t,n=[],r=S(e),i=r.length-1,o=0;o<=i;o++)t=o===i?this:this.clone(!0),S(r[o])[a](t),u.apply(n,t.get());return this.pushStack(n)}});var Me=new RegExp("^("+ee+")(?!px)[a-z%]+$","i"),Ie=function(e){var t=e.ownerDocument.defaultView;return t&&t.opener||(t=C),t.getComputedStyle(e)},We=function(e,t,n){var r,i,o={};for(i in t)o[i]=e.style[i],e.style[i]=t[i];for(i in r=n.call(e),t)e.style[i]=o[i];return r},Fe=new RegExp(ne.join("|"),"i");function Be(e,t,n){var r,i,o,a,s=e.style;return(n=n||Ie(e))&&(""!==(a=n.getPropertyValue(t)||n[t])||ie(e)||(a=S.style(e,t)),!y.pixelBoxStyles()&&Me.test(a)&&Fe.test(t)&&(r=s.width,i=s.minWidth,o=s.maxWidth,s.minWidth=s.maxWidth=s.width=a,a=n.width,s.width=r,s.minWidth=i,s.maxWidth=o)),void 0!==a?a+"":a}function $e(e,t){return{get:function(){if(!e())return(this.get=t).apply(this,arguments);delete this.get}}}!function(){function e(){if(l){u.style.cssText="position:absolute;left:-11111px;width:60px;margin-top:1px;padding:0;border:0",l.style.cssText="position:relative;display:block;box-sizing:border-box;overflow:scroll;margin:auto;border:1px;padding:1px;width:60%;top:1%",re.appendChild(u).appendChild(l);var e=C.getComputedStyle(l);n="1%"!==e.top,s=12===t(e.marginLeft),l.style.right="60%",o=36===t(e.right),r=36===t(e.width),l.style.position="absolute",i=12===t(l.offsetWidth/3),re.removeChild(u),l=null}}function t(e){return Math.round(parseFloat(e))}var n,r,i,o,a,s,u=E.createElement("div"),l=E.createElement("div");l.style&&(l.style.backgroundClip="content-box",l.cloneNode(!0).style.backgroundClip="",y.clearCloneStyle="content-box"===l.style.backgroundClip,S.extend(y,{boxSizingReliable:function(){return e(),r},pixelBoxStyles:function(){return e(),o},pixelPosition:function(){return e(),n},reliableMarginLeft:function(){return e(),s},scrollboxSize:function(){return e(),i},reliableTrDimensions:function(){var e,t,n,r;return null==a&&(e=E.createElement("table"),t=E.createElement("tr"),n=E.createElement("div"),e.style.cssText="position:absolute;left:-11111px",t.style.height="1px",n.style.height="9px",re.appendChild(e).appendChild(t).appendChild(n),r=C.getComputedStyle(t),a=3<parseInt(r.height),re.removeChild(e)),a}}))}();var _e=["Webkit","Moz","ms"],ze=E.createElement("div").style,Ue={};function Xe(e){var t=S.cssProps[e]||Ue[e];return t||(e in ze?e:Ue[e]=function(e){var t=e[0].toUpperCase()+e.slice(1),n=_e.length;while(n--)if((e=_e[n]+t)in ze)return e}(e)||e)}var Ve=/^(none|table(?!-c[ea]).+)/,Ge=/^--/,Ye={position:"absolute",visibility:"hidden",display:"block"},Qe={letterSpacing:"0",fontWeight:"400"};function Je(e,t,n){var r=te.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function Ke(e,t,n,r,i,o){var a="width"===t?1:0,s=0,u=0;if(n===(r?"border":"content"))return 0;for(;a<4;a+=2)"margin"===n&&(u+=S.css(e,n+ne[a],!0,i)),r?("content"===n&&(u-=S.css(e,"padding"+ne[a],!0,i)),"margin"!==n&&(u-=S.css(e,"border"+ne[a]+"Width",!0,i))):(u+=S.css(e,"padding"+ne[a],!0,i),"padding"!==n?u+=S.css(e,"border"+ne[a]+"Width",!0,i):s+=S.css(e,"border"+ne[a]+"Width",!0,i));return!r&&0<=o&&(u+=Math.max(0,Math.ceil(e["offset"+t[0].toUpperCase()+t.slice(1)]-o-u-s-.5))||0),u}function Ze(e,t,n){var r=Ie(e),i=(!y.boxSizingReliable()||n)&&"border-box"===S.css(e,"boxSizing",!1,r),o=i,a=Be(e,t,r),s="offset"+t[0].toUpperCase()+t.slice(1);if(Me.test(a)){if(!n)return a;a="auto"}return(!y.boxSizingReliable()&&i||!y.reliableTrDimensions()&&A(e,"tr")||"auto"===a||!parseFloat(a)&&"inline"===S.css(e,"display",!1,r))&&e.getClientRects().length&&(i="border-box"===S.css(e,"boxSizing",!1,r),(o=s in e)&&(a=e[s])),(a=parseFloat(a)||0)+Ke(e,t,n||(i?"border":"content"),o,r,a)+"px"}function et(e,t,n,r,i){return new et.prototype.init(e,t,n,r,i)}S.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Be(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,gridArea:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnStart:!0,gridRow:!0,gridRowEnd:!0,gridRowStart:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,a,s=X(t),u=Ge.test(t),l=e.style;if(u||(t=Xe(s)),a=S.cssHooks[t]||S.cssHooks[s],void 0===n)return a&&"get"in a&&void 0!==(i=a.get(e,!1,r))?i:l[t];"string"===(o=typeof n)&&(i=te.exec(n))&&i[1]&&(n=se(e,t,i),o="number"),null!=n&&n==n&&("number"!==o||u||(n+=i&&i[3]||(S.cssNumber[s]?"":"px")),y.clearCloneStyle||""!==n||0!==t.indexOf("background")||(l[t]="inherit"),a&&"set"in a&&void 0===(n=a.set(e,n,r))||(u?l.setProperty(t,n):l[t]=n))}},css:function(e,t,n,r){var i,o,a,s=X(t);return Ge.test(t)||(t=Xe(s)),(a=S.cssHooks[t]||S.cssHooks[s])&&"get"in a&&(i=a.get(e,!0,n)),void 0===i&&(i=Be(e,t,r)),"normal"===i&&t in Qe&&(i=Qe[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),S.each(["height","width"],function(e,u){S.cssHooks[u]={get:function(e,t,n){if(t)return!Ve.test(S.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?Ze(e,u,n):We(e,Ye,function(){return Ze(e,u,n)})},set:function(e,t,n){var r,i=Ie(e),o=!y.scrollboxSize()&&"absolute"===i.position,a=(o||n)&&"border-box"===S.css(e,"boxSizing",!1,i),s=n?Ke(e,u,n,a,i):0;return a&&o&&(s-=Math.ceil(e["offset"+u[0].toUpperCase()+u.slice(1)]-parseFloat(i[u])-Ke(e,u,"border",!1,i)-.5)),s&&(r=te.exec(t))&&"px"!==(r[3]||"px")&&(e.style[u]=t,t=S.css(e,u)),Je(0,t,s)}}}),S.cssHooks.marginLeft=$e(y.reliableMarginLeft,function(e,t){if(t)return(parseFloat(Be(e,"marginLeft"))||e.getBoundingClientRect().left-We(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),S.each({margin:"",padding:"",border:"Width"},function(i,o){S.cssHooks[i+o]={expand:function(e){for(var t=0,n={},r="string"==typeof e?e.split(" "):[e];t<4;t++)n[i+ne[t]+o]=r[t]||r[t-2]||r[0];return n}},"margin"!==i&&(S.cssHooks[i+o].set=Je)}),S.fn.extend({css:function(e,t){return $(this,function(e,t,n){var r,i,o={},a=0;if(Array.isArray(t)){for(r=Ie(e),i=t.length;a<i;a++)o[t[a]]=S.css(e,t[a],!1,r);return o}return void 0!==n?S.style(e,t,n):S.css(e,t)},e,t,1<arguments.length)}}),((S.Tween=et).prototype={constructor:et,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||S.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(S.cssNumber[n]?"":"px")},cur:function(){var e=et.propHooks[this.prop];return e&&e.get?e.get(this):et.propHooks._default.get(this)},run:function(e){var t,n=et.propHooks[this.prop];return this.options.duration?this.pos=t=S.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):et.propHooks._default.set(this),this}}).init.prototype=et.prototype,(et.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=S.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){S.fx.step[e.prop]?S.fx.step[e.prop](e):1!==e.elem.nodeType||!S.cssHooks[e.prop]&&null==e.elem.style[Xe(e.prop)]?e.elem[e.prop]=e.now:S.style(e.elem,e.prop,e.now+e.unit)}}}).scrollTop=et.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},S.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},S.fx=et.prototype.init,S.fx.step={};var tt,nt,rt,it,ot=/^(?:toggle|show|hide)$/,at=/queueHooks$/;function st(){nt&&(!1===E.hidden&&C.requestAnimationFrame?C.requestAnimationFrame(st):C.setTimeout(st,S.fx.interval),S.fx.tick())}function ut(){return C.setTimeout(function(){tt=void 0}),tt=Date.now()}function lt(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)i["margin"+(n=ne[r])]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function ct(e,t,n){for(var r,i=(ft.tweeners[t]||[]).concat(ft.tweeners["*"]),o=0,a=i.length;o<a;o++)if(r=i[o].call(n,t,e))return r}function ft(o,e,t){var n,a,r=0,i=ft.prefilters.length,s=S.Deferred().always(function(){delete u.elem}),u=function(){if(a)return!1;for(var e=tt||ut(),t=Math.max(0,l.startTime+l.duration-e),n=1-(t/l.duration||0),r=0,i=l.tweens.length;r<i;r++)l.tweens[r].run(n);return s.notifyWith(o,[l,n,t]),n<1&&i?t:(i||s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l]),!1)},l=s.promise({elem:o,props:S.extend({},e),opts:S.extend(!0,{specialEasing:{},easing:S.easing._default},t),originalProperties:e,originalOptions:t,startTime:tt||ut(),duration:t.duration,tweens:[],createTween:function(e,t){var n=S.Tween(o,l.opts,e,t,l.opts.specialEasing[e]||l.opts.easing);return l.tweens.push(n),n},stop:function(e){var t=0,n=e?l.tweens.length:0;if(a)return this;for(a=!0;t<n;t++)l.tweens[t].run(1);return e?(s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l,e])):s.rejectWith(o,[l,e]),this}}),c=l.props;for(!function(e,t){var n,r,i,o,a;for(n in e)if(i=t[r=X(n)],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(a=S.cssHooks[r])&&"expand"in a)for(n in o=a.expand(o),delete e[r],o)n in e||(e[n]=o[n],t[n]=i);else t[r]=i}(c,l.opts.specialEasing);r<i;r++)if(n=ft.prefilters[r].call(l,o,c,l.opts))return m(n.stop)&&(S._queueHooks(l.elem,l.opts.queue).stop=n.stop.bind(n)),n;return S.map(c,ct,l),m(l.opts.start)&&l.opts.start.call(o,l),l.progress(l.opts.progress).done(l.opts.done,l.opts.complete).fail(l.opts.fail).always(l.opts.always),S.fx.timer(S.extend(u,{elem:o,anim:l,queue:l.opts.queue})),l}S.Animation=S.extend(ft,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return se(n.elem,e,te.exec(t),n),n}]},tweener:function(e,t){m(e)?(t=e,e=["*"]):e=e.match(P);for(var n,r=0,i=e.length;r<i;r++)n=e[r],ft.tweeners[n]=ft.tweeners[n]||[],ft.tweeners[n].unshift(t)},prefilters:[function(e,t,n){var r,i,o,a,s,u,l,c,f="width"in t||"height"in t,p=this,d={},h=e.style,g=e.nodeType&&ae(e),v=Y.get(e,"fxshow");for(r in n.queue||(null==(a=S._queueHooks(e,"fx")).unqueued&&(a.unqueued=0,s=a.empty.fire,a.empty.fire=function(){a.unqueued||s()}),a.unqueued++,p.always(function(){p.always(function(){a.unqueued--,S.queue(e,"fx").length||a.empty.fire()})})),t)if(i=t[r],ot.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}d[r]=v&&v[r]||S.style(e,r)}if((u=!S.isEmptyObject(t))||!S.isEmptyObject(d))for(r in f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],null==(l=v&&v.display)&&(l=Y.get(e,"display")),"none"===(c=S.css(e,"display"))&&(l?c=l:(le([e],!0),l=e.style.display||l,c=S.css(e,"display"),le([e]))),("inline"===c||"inline-block"===c&&null!=l)&&"none"===S.css(e,"float")&&(u||(p.done(function(){h.display=l}),null==l&&(c=h.display,l="none"===c?"":c)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",p.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1,d)u||(v?"hidden"in v&&(g=v.hidden):v=Y.access(e,"fxshow",{display:l}),o&&(v.hidden=!g),g&&le([e],!0),p.done(function(){for(r in g||le([e]),Y.remove(e,"fxshow"),d)S.style(e,r,d[r])})),u=ct(g?v[r]:0,r,p),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}],prefilter:function(e,t){t?ft.prefilters.unshift(e):ft.prefilters.push(e)}}),S.speed=function(e,t,n){var r=e&&"object"==typeof e?S.extend({},e):{complete:n||!n&&t||m(e)&&e,duration:e,easing:n&&t||t&&!m(t)&&t};return S.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in S.fx.speeds?r.duration=S.fx.speeds[r.duration]:r.duration=S.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){m(r.old)&&r.old.call(this),r.queue&&S.dequeue(this,r.queue)},r},S.fn.extend({fadeTo:function(e,t,n,r){return this.filter(ae).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(t,e,n,r){var i=S.isEmptyObject(t),o=S.speed(e,n,r),a=function(){var e=ft(this,S.extend({},t),o);(i||Y.get(this,"finish"))&&e.stop(!0)};return a.finish=a,i||!1===o.queue?this.each(a):this.queue(o.queue,a)},stop:function(i,e,o){var a=function(e){var t=e.stop;delete e.stop,t(o)};return"string"!=typeof i&&(o=e,e=i,i=void 0),e&&this.queue(i||"fx",[]),this.each(function(){var e=!0,t=null!=i&&i+"queueHooks",n=S.timers,r=Y.get(this);if(t)r[t]&&r[t].stop&&a(r[t]);else for(t in r)r[t]&&r[t].stop&&at.test(t)&&a(r[t]);for(t=n.length;t--;)n[t].elem!==this||null!=i&&n[t].queue!==i||(n[t].anim.stop(o),e=!1,n.splice(t,1));!e&&o||S.dequeue(this,i)})},finish:function(a){return!1!==a&&(a=a||"fx"),this.each(function(){var e,t=Y.get(this),n=t[a+"queue"],r=t[a+"queueHooks"],i=S.timers,o=n?n.length:0;for(t.finish=!0,S.queue(this,a,[]),r&&r.stop&&r.stop.call(this,!0),e=i.length;e--;)i[e].elem===this&&i[e].queue===a&&(i[e].anim.stop(!0),i.splice(e,1));for(e=0;e<o;e++)n[e]&&n[e].finish&&n[e].finish.call(this);delete t.finish})}}),S.each(["toggle","show","hide"],function(e,r){var i=S.fn[r];S.fn[r]=function(e,t,n){return null==e||"boolean"==typeof e?i.apply(this,arguments):this.animate(lt(r,!0),e,t,n)}}),S.each({slideDown:lt("show"),slideUp:lt("hide"),slideToggle:lt("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(e,r){S.fn[e]=function(e,t,n){return this.animate(r,e,t,n)}}),S.timers=[],S.fx.tick=function(){var e,t=0,n=S.timers;for(tt=Date.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||S.fx.stop(),tt=void 0},S.fx.timer=function(e){S.timers.push(e),S.fx.start()},S.fx.interval=13,S.fx.start=function(){nt||(nt=!0,st())},S.fx.stop=function(){nt=null},S.fx.speeds={slow:600,fast:200,_default:400},S.fn.delay=function(r,e){return r=S.fx&&S.fx.speeds[r]||r,e=e||"fx",this.queue(e,function(e,t){var n=C.setTimeout(e,r);t.stop=function(){C.clearTimeout(n)}})},rt=E.createElement("input"),it=E.createElement("select").appendChild(E.createElement("option")),rt.type="checkbox",y.checkOn=""!==rt.value,y.optSelected=it.selected,(rt=E.createElement("input")).value="t",rt.type="radio",y.radioValue="t"===rt.value;var pt,dt=S.expr.attrHandle;S.fn.extend({attr:function(e,t){return $(this,S.attr,e,t,1<arguments.length)},removeAttr:function(e){return this.each(function(){S.removeAttr(this,e)})}}),S.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return"undefined"==typeof e.getAttribute?S.prop(e,t,n):(1===o&&S.isXMLDoc(e)||(i=S.attrHooks[t.toLowerCase()]||(S.expr.match.bool.test(t)?pt:void 0)),void 0!==n?null===n?void S.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=S.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!y.radioValue&&"radio"===t&&A(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(P);if(i&&1===e.nodeType)while(n=i[r++])e.removeAttribute(n)}}),pt={set:function(e,t,n){return!1===t?S.removeAttr(e,n):e.setAttribute(n,n),n}},S.each(S.expr.match.bool.source.match(/\w+/g),function(e,t){var a=dt[t]||S.find.attr;dt[t]=function(e,t,n){var r,i,o=t.toLowerCase();return n||(i=dt[o],dt[o]=r,r=null!=a(e,t,n)?o:null,dt[o]=i),r}});var ht=/^(?:input|select|textarea|button)$/i,gt=/^(?:a|area)$/i;function vt(e){return(e.match(P)||[]).join(" ")}function yt(e){return e.getAttribute&&e.getAttribute("class")||""}function mt(e){return Array.isArray(e)?e:"string"==typeof e&&e.match(P)||[]}S.fn.extend({prop:function(e,t){return $(this,S.prop,e,t,1<arguments.length)},removeProp:function(e){return this.each(function(){delete this[S.propFix[e]||e]})}}),S.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&S.isXMLDoc(e)||(t=S.propFix[t]||t,i=S.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=S.find.attr(e,"tabindex");return t?parseInt(t,10):ht.test(e.nodeName)||gt.test(e.nodeName)&&e.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),y.optSelected||(S.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),S.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){S.propFix[this.toLowerCase()]=this}),S.fn.extend({addClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).addClass(t.call(this,e,yt(this)))});if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])r.indexOf(" "+o+" ")<0&&(r+=o+" ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},removeClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).removeClass(t.call(this,e,yt(this)))});if(!arguments.length)return this.attr("class","");if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])while(-1<r.indexOf(" "+o+" "))r=r.replace(" "+o+" "," ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},toggleClass:function(i,t){var o=typeof i,a="string"===o||Array.isArray(i);return"boolean"==typeof t&&a?t?this.addClass(i):this.removeClass(i):m(i)?this.each(function(e){S(this).toggleClass(i.call(this,e,yt(this),t),t)}):this.each(function(){var e,t,n,r;if(a){t=0,n=S(this),r=mt(i);while(e=r[t++])n.hasClass(e)?n.removeClass(e):n.addClass(e)}else void 0!==i&&"boolean"!==o||((e=yt(this))&&Y.set(this,"__className__",e),this.setAttribute&&this.setAttribute("class",e||!1===i?"":Y.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;t=" "+e+" ";while(n=this[r++])if(1===n.nodeType&&-1<(" "+vt(yt(n))+" ").indexOf(t))return!0;return!1}});var xt=/\r/g;S.fn.extend({val:function(n){var r,e,i,t=this[0];return arguments.length?(i=m(n),this.each(function(e){var t;1===this.nodeType&&(null==(t=i?n.call(this,e,S(this).val()):n)?t="":"number"==typeof t?t+="":Array.isArray(t)&&(t=S.map(t,function(e){return null==e?"":e+""})),(r=S.valHooks[this.type]||S.valHooks[this.nodeName.toLowerCase()])&&"set"in r&&void 0!==r.set(this,t,"value")||(this.value=t))})):t?(r=S.valHooks[t.type]||S.valHooks[t.nodeName.toLowerCase()])&&"get"in r&&void 0!==(e=r.get(t,"value"))?e:"string"==typeof(e=t.value)?e.replace(xt,""):null==e?"":e:void 0}}),S.extend({valHooks:{option:{get:function(e){var t=S.find.attr(e,"value");return null!=t?t:vt(S.text(e))}},select:{get:function(e){var t,n,r,i=e.options,o=e.selectedIndex,a="select-one"===e.type,s=a?null:[],u=a?o+1:i.length;for(r=o<0?u:a?o:0;r<u;r++)if(((n=i[r]).selected||r===o)&&!n.disabled&&(!n.parentNode.disabled||!A(n.parentNode,"optgroup"))){if(t=S(n).val(),a)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=S.makeArray(t),a=i.length;while(a--)((r=i[a]).selected=-1<S.inArray(S.valHooks.option.get(r),o))&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),S.each(["radio","checkbox"],function(){S.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=-1<S.inArray(S(e).val(),t)}},y.checkOn||(S.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})}),y.focusin="onfocusin"in C;var bt=/^(?:focusinfocus|focusoutblur)$/,wt=function(e){e.stopPropagation()};S.extend(S.event,{trigger:function(e,t,n,r){var i,o,a,s,u,l,c,f,p=[n||E],d=v.call(e,"type")?e.type:e,h=v.call(e,"namespace")?e.namespace.split("."):[];if(o=f=a=n=n||E,3!==n.nodeType&&8!==n.nodeType&&!bt.test(d+S.event.triggered)&&(-1<d.indexOf(".")&&(d=(h=d.split(".")).shift(),h.sort()),u=d.indexOf(":")<0&&"on"+d,(e=e[S.expando]?e:new S.Event(d,"object"==typeof e&&e)).isTrigger=r?2:3,e.namespace=h.join("."),e.rnamespace=e.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,e.result=void 0,e.target||(e.target=n),t=null==t?[e]:S.makeArray(t,[e]),c=S.event.special[d]||{},r||!c.trigger||!1!==c.trigger.apply(n,t))){if(!r&&!c.noBubble&&!x(n)){for(s=c.delegateType||d,bt.test(s+d)||(o=o.parentNode);o;o=o.parentNode)p.push(o),a=o;a===(n.ownerDocument||E)&&p.push(a.defaultView||a.parentWindow||C)}i=0;while((o=p[i++])&&!e.isPropagationStopped())f=o,e.type=1<i?s:c.bindType||d,(l=(Y.get(o,"events")||Object.create(null))[e.type]&&Y.get(o,"handle"))&&l.apply(o,t),(l=u&&o[u])&&l.apply&&V(o)&&(e.result=l.apply(o,t),!1===e.result&&e.preventDefault());return e.type=d,r||e.isDefaultPrevented()||c._default&&!1!==c._default.apply(p.pop(),t)||!V(n)||u&&m(n[d])&&!x(n)&&((a=n[u])&&(n[u]=null),S.event.triggered=d,e.isPropagationStopped()&&f.addEventListener(d,wt),n[d](),e.isPropagationStopped()&&f.removeEventListener(d,wt),S.event.triggered=void 0,a&&(n[u]=a)),e.result}},simulate:function(e,t,n){var r=S.extend(new S.Event,n,{type:e,isSimulated:!0});S.event.trigger(r,null,t)}}),S.fn.extend({trigger:function(e,t){return this.each(function(){S.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return S.event.trigger(e,t,n,!0)}}),y.focusin||S.each({focus:"focusin",blur:"focusout"},function(n,r){var i=function(e){S.event.simulate(r,e.target,S.event.fix(e))};S.event.special[r]={setup:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r);t||e.addEventListener(n,i,!0),Y.access(e,r,(t||0)+1)},teardown:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r)-1;t?Y.access(e,r,t):(e.removeEventListener(n,i,!0),Y.remove(e,r))}}});var Tt=C.location,Ct={guid:Date.now()},Et=/\?/;S.parseXML=function(e){var t;if(!e||"string"!=typeof e)return null;try{t=(new C.DOMParser).parseFromString(e,"text/xml")}catch(e){t=void 0}return t&&!t.getElementsByTagName("parsererror").length||S.error("Invalid XML: "+e),t};var St=/\[\]$/,kt=/\r?\n/g,At=/^(?:submit|button|image|reset|file)$/i,Nt=/^(?:input|select|textarea|keygen)/i;function Dt(n,e,r,i){var t;if(Array.isArray(e))S.each(e,function(e,t){r||St.test(n)?i(n,t):Dt(n+"["+("object"==typeof t&&null!=t?e:"")+"]",t,r,i)});else if(r||"object"!==w(e))i(n,e);else for(t in e)Dt(n+"["+t+"]",e[t],r,i)}S.param=function(e,t){var n,r=[],i=function(e,t){var n=m(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(null==e)return"";if(Array.isArray(e)||e.jquery&&!S.isPlainObject(e))S.each(e,function(){i(this.name,this.value)});else for(n in e)Dt(n,e[n],t,i);return r.join("&")},S.fn.extend({serialize:function(){return S.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=S.prop(this,"elements");return e?S.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!S(this).is(":disabled")&&Nt.test(this.nodeName)&&!At.test(e)&&(this.checked||!pe.test(e))}).map(function(e,t){var n=S(this).val();return null==n?null:Array.isArray(n)?S.map(n,function(e){return{name:t.name,value:e.replace(kt,"\r\n")}}):{name:t.name,value:n.replace(kt,"\r\n")}}).get()}});var jt=/%20/g,qt=/#.*$/,Lt=/([?&])_=[^&]*/,Ht=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ot=/^(?:GET|HEAD)$/,Pt=/^\/\//,Rt={},Mt={},It="*/".concat("*"),Wt=E.createElement("a");function Ft(o){return function(e,t){"string"!=typeof e&&(t=e,e="*");var n,r=0,i=e.toLowerCase().match(P)||[];if(m(t))while(n=i[r++])"+"===n[0]?(n=n.slice(1)||"*",(o[n]=o[n]||[]).unshift(t)):(o[n]=o[n]||[]).push(t)}}function Bt(t,i,o,a){var s={},u=t===Mt;function l(e){var r;return s[e]=!0,S.each(t[e]||[],function(e,t){var n=t(i,o,a);return"string"!=typeof n||u||s[n]?u?!(r=n):void 0:(i.dataTypes.unshift(n),l(n),!1)}),r}return l(i.dataTypes[0])||!s["*"]&&l("*")}function $t(e,t){var n,r,i=S.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&S.extend(!0,e,r),e}Wt.href=Tt.href,S.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Tt.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(Tt.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":It,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":S.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?$t($t(e,S.ajaxSettings),t):$t(S.ajaxSettings,e)},ajaxPrefilter:Ft(Rt),ajaxTransport:Ft(Mt),ajax:function(e,t){"object"==typeof e&&(t=e,e=void 0),t=t||{};var c,f,p,n,d,r,h,g,i,o,v=S.ajaxSetup({},t),y=v.context||v,m=v.context&&(y.nodeType||y.jquery)?S(y):S.event,x=S.Deferred(),b=S.Callbacks("once memory"),w=v.statusCode||{},a={},s={},u="canceled",T={readyState:0,getResponseHeader:function(e){var t;if(h){if(!n){n={};while(t=Ht.exec(p))n[t[1].toLowerCase()+" "]=(n[t[1].toLowerCase()+" "]||[]).concat(t[2])}t=n[e.toLowerCase()+" "]}return null==t?null:t.join(", ")},getAllResponseHeaders:function(){return h?p:null},setRequestHeader:function(e,t){return null==h&&(e=s[e.toLowerCase()]=s[e.toLowerCase()]||e,a[e]=t),this},overrideMimeType:function(e){return null==h&&(v.mimeType=e),this},statusCode:function(e){var t;if(e)if(h)T.always(e[T.status]);else for(t in e)w[t]=[w[t],e[t]];return this},abort:function(e){var t=e||u;return c&&c.abort(t),l(0,t),this}};if(x.promise(T),v.url=((e||v.url||Tt.href)+"").replace(Pt,Tt.protocol+"//"),v.type=t.method||t.type||v.method||v.type,v.dataTypes=(v.dataType||"*").toLowerCase().match(P)||[""],null==v.crossDomain){r=E.createElement("a");try{r.href=v.url,r.href=r.href,v.crossDomain=Wt.protocol+"//"+Wt.host!=r.protocol+"//"+r.host}catch(e){v.crossDomain=!0}}if(v.data&&v.processData&&"string"!=typeof v.data&&(v.data=S.param(v.data,v.traditional)),Bt(Rt,v,t,T),h)return T;for(i in(g=S.event&&v.global)&&0==S.active++&&S.event.trigger("ajaxStart"),v.type=v.type.toUpperCase(),v.hasContent=!Ot.test(v.type),f=v.url.replace(qt,""),v.hasContent?v.data&&v.processData&&0===(v.contentType||"").indexOf("application/x-www-form-urlencoded")&&(v.data=v.data.replace(jt,"+")):(o=v.url.slice(f.length),v.data&&(v.processData||"string"==typeof v.data)&&(f+=(Et.test(f)?"&":"?")+v.data,delete v.data),!1===v.cache&&(f=f.replace(Lt,"$1"),o=(Et.test(f)?"&":"?")+"_="+Ct.guid+++o),v.url=f+o),v.ifModified&&(S.lastModified[f]&&T.setRequestHeader("If-Modified-Since",S.lastModified[f]),S.etag[f]&&T.setRequestHeader("If-None-Match",S.etag[f])),(v.data&&v.hasContent&&!1!==v.contentType||t.contentType)&&T.setRequestHeader("Content-Type",v.contentType),T.setRequestHeader("Accept",v.dataTypes[0]&&v.accepts[v.dataTypes[0]]?v.accepts[v.dataTypes[0]]+("*"!==v.dataTypes[0]?", "+It+"; q=0.01":""):v.accepts["*"]),v.headers)T.setRequestHeader(i,v.headers[i]);if(v.beforeSend&&(!1===v.beforeSend.call(y,T,v)||h))return T.abort();if(u="abort",b.add(v.complete),T.done(v.success),T.fail(v.error),c=Bt(Mt,v,t,T)){if(T.readyState=1,g&&m.trigger("ajaxSend",[T,v]),h)return T;v.async&&0<v.timeout&&(d=C.setTimeout(function(){T.abort("timeout")},v.timeout));try{h=!1,c.send(a,l)}catch(e){if(h)throw e;l(-1,e)}}else l(-1,"No Transport");function l(e,t,n,r){var i,o,a,s,u,l=t;h||(h=!0,d&&C.clearTimeout(d),c=void 0,p=r||"",T.readyState=0<e?4:0,i=200<=e&&e<300||304===e,n&&(s=function(e,t,n){var r,i,o,a,s=e.contents,u=e.dataTypes;while("*"===u[0])u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in s)if(s[i]&&s[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}a||(a=i)}o=o||a}if(o)return o!==u[0]&&u.unshift(o),n[o]}(v,T,n)),!i&&-1<S.inArray("script",v.dataTypes)&&(v.converters["text script"]=function(){}),s=function(e,t,n,r){var i,o,a,s,u,l={},c=e.dataTypes.slice();if(c[1])for(a in e.converters)l[a.toLowerCase()]=e.converters[a];o=c.shift();while(o)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=c.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(a=l[u+" "+o]||l["* "+o]))for(i in l)if((s=i.split(" "))[1]===o&&(a=l[u+" "+s[0]]||l["* "+s[0]])){!0===a?a=l[i]:!0!==l[i]&&(o=s[0],c.unshift(s[1]));break}if(!0!==a)if(a&&e["throws"])t=a(t);else try{t=a(t)}catch(e){return{state:"parsererror",error:a?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}(v,s,T,i),i?(v.ifModified&&((u=T.getResponseHeader("Last-Modified"))&&(S.lastModified[f]=u),(u=T.getResponseHeader("etag"))&&(S.etag[f]=u)),204===e||"HEAD"===v.type?l="nocontent":304===e?l="notmodified":(l=s.state,o=s.data,i=!(a=s.error))):(a=l,!e&&l||(l="error",e<0&&(e=0))),T.status=e,T.statusText=(t||l)+"",i?x.resolveWith(y,[o,l,T]):x.rejectWith(y,[T,l,a]),T.statusCode(w),w=void 0,g&&m.trigger(i?"ajaxSuccess":"ajaxError",[T,v,i?o:a]),b.fireWith(y,[T,l]),g&&(m.trigger("ajaxComplete",[T,v]),--S.active||S.event.trigger("ajaxStop")))}return T},getJSON:function(e,t,n){return S.get(e,t,n,"json")},getScript:function(e,t){return S.get(e,void 0,t,"script")}}),S.each(["get","post"],function(e,i){S[i]=function(e,t,n,r){return m(t)&&(r=r||n,n=t,t=void 0),S.ajax(S.extend({url:e,type:i,dataType:r,data:t,success:n},S.isPlainObject(e)&&e))}}),S.ajaxPrefilter(function(e){var t;for(t in e.headers)"content-type"===t.toLowerCase()&&(e.contentType=e.headers[t]||"")}),S._evalUrl=function(e,t,n){return S.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,converters:{"text script":function(){}},dataFilter:function(e){S.globalEval(e,t,n)}})},S.fn.extend({wrapAll:function(e){var t;return this[0]&&(m(e)&&(e=e.call(this[0])),t=S(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(n){return m(n)?this.each(function(e){S(this).wrapInner(n.call(this,e))}):this.each(function(){var e=S(this),t=e.contents();t.length?t.wrapAll(n):e.append(n)})},wrap:function(t){var n=m(t);return this.each(function(e){S(this).wrapAll(n?t.call(this,e):t)})},unwrap:function(e){return this.parent(e).not("body").each(function(){S(this).replaceWith(this.childNodes)}),this}}),S.expr.pseudos.hidden=function(e){return!S.expr.pseudos.visible(e)},S.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},S.ajaxSettings.xhr=function(){try{return new C.XMLHttpRequest}catch(e){}};var _t={0:200,1223:204},zt=S.ajaxSettings.xhr();y.cors=!!zt&&"withCredentials"in zt,y.ajax=zt=!!zt,S.ajaxTransport(function(i){var o,a;if(y.cors||zt&&!i.crossDomain)return{send:function(e,t){var n,r=i.xhr();if(r.open(i.type,i.url,i.async,i.username,i.password),i.xhrFields)for(n in i.xhrFields)r[n]=i.xhrFields[n];for(n in i.mimeType&&r.overrideMimeType&&r.overrideMimeType(i.mimeType),i.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest"),e)r.setRequestHeader(n,e[n]);o=function(e){return function(){o&&(o=a=r.onload=r.onerror=r.onabort=r.ontimeout=r.onreadystatechange=null,"abort"===e?r.abort():"error"===e?"number"!=typeof r.status?t(0,"error"):t(r.status,r.statusText):t(_t[r.status]||r.status,r.statusText,"text"!==(r.responseType||"text")||"string"!=typeof r.responseText?{binary:r.response}:{text:r.responseText},r.getAllResponseHeaders()))}},r.onload=o(),a=r.onerror=r.ontimeout=o("error"),void 0!==r.onabort?r.onabort=a:r.onreadystatechange=function(){4===r.readyState&&C.setTimeout(function(){o&&a()})},o=o("abort");try{r.send(i.hasContent&&i.data||null)}catch(e){if(o)throw e}},abort:function(){o&&o()}}}),S.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),S.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return S.globalEval(e),e}}}),S.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),S.ajaxTransport("script",function(n){var r,i;if(n.crossDomain||n.scriptAttrs)return{send:function(e,t){r=S("<script>").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="<form></form><form></form>",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1<s&&(r=vt(e.slice(s)),e=e.slice(0,s)),m(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),0<a.length&&S.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,a.html(r?S("<div>").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0<arguments.length?this.on(n,null,e,t):this.trigger(n)}});var Gt=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;S.proxy=function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),m(e))return r=s.call(arguments,2),(i=function(){return e.apply(t||this,r.concat(s.call(arguments)))}).guid=e.guid=e.guid||S.guid++,i},S.holdReady=function(e){e?S.readyWait++:S.ready(!0)},S.isArray=Array.isArray,S.parseJSON=JSON.parse,S.nodeName=A,S.isFunction=m,S.isWindow=x,S.camelCase=X,S.type=w,S.now=Date.now,S.isNumeric=function(e){var t=S.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},S.trim=function(e){return null==e?"":(e+"").replace(Gt,"")},"function"==typeof define&&define.amd&&define("jquery",[],function(){return S});var Yt=C.jQuery,Qt=C.$;return S.noConflict=function(e){return C.$===S&&(C.$=Qt),e&&C.jQuery===S&&(C.jQuery=Yt),S},"undefined"==typeof e&&(C.jQuery=C.$=S),S});
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/js/jquery.min.js | javascript | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 30,126 |
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>DispatchQueue Extension Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Extension/DispatchQueue" class="dashAnchor"></a>
<a title="DispatchQueue Extension Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Katana 5.1.1 Docs
</a>
(99% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="path_to_url">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Katana Reference</a>
<img class="carat" src="../img/carat.png" />
DispatchQueue Extension Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/EmptySideEffectDependencyContainer.html">EmptySideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PartialStore.html">PartialStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store.html">Store</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Store/Configuration.html"> Configuration</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/DispatchableLogger.html">DispatchableLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffect.html">AnySideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnySideEffectContext.html">AnySideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStateUpdater.html">AnyStateUpdater</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AnyStore.html">AnyStore</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AsyncProvider.html">AsyncProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DispatchObserverDispatchable.html">DispatchObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Dispatchable.html">Dispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/NotificationObserverDispatchable.html">NotificationObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/OnStartObserverDispatchable.html">OnStartObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ReturningSideEffect.html">ReturningSideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffect.html">SideEffect</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/SideEffectDependencyContainer.html">SideEffectDependencyContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/State.html">State</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateObserverDispatchable.html">StateObserverDispatchable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/StateUpdater.html">StateUpdater</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor.html">ObserverInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ObserverInterceptor/ObserverType.html"> ObserverType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SideEffectContext.html">SideEffectContext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SignpostLogger.html">SignpostLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana11AnyDispatcha">AnyDispatch</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16AnyStoreListenera">AnyStoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana8GetStatea">GetState</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreInterceptora">StoreInterceptor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana20StoreInterceptorNexta">StoreInterceptorNext</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana13StoreListenera">StoreListener</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:6Katana16StoreUnsubscribea">StoreUnsubscribe</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>DispatchQueue</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DispatchQueue</span><span class="p">:</span> <span class="kt"><a href="../Protocols/AsyncProvider.html">AsyncProvider</a></span></code></pre>
</div>
</div>
<p>DispatchQueue conformance to <code><a href="../Protocols/AsyncProvider.html">AsyncProvider</a></code> so that <code>DispatchQueue.main</code> can be used</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:6Katana13AsyncProviderP7executeyyyycF"></a>
<a name="//apple_ref/swift/Method/execute(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:6Katana13AsyncProviderP7executeyyyycF">execute(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">execute</span><span class="p">(</span><span class="n">_</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="path_to_url#L45-L47">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2021 <a class="link" href="path_to_url" target="_blank" rel="external">Bending Spoons Team</a>. All rights reserved. (Last updated: 2021-04-29)</p>
<p>Generated by <a class="link" href="path_to_url" target="_blank" rel="external">jazzy v0.13.6</a>, a <a class="link" href="path_to_url" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
``` | /content/code_sandbox/docs/latest/docsets/Katana.docset/Contents/Resources/Documents/Extensions/DispatchQueue.html | html | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,741 |
```objective-c
//
// Katana.h
// Katana
//
// See the LICENSE file for more information.
#import <Foundation/Foundation.h>
//! Project version number for Katana.
FOUNDATION_EXPORT double KatanaVersionNumber;
//! Project version string for Katana.
FOUNDATION_EXPORT const unsigned char KatanaVersionString[];
// In this header, you should import all the public headers of your framework using statements like #import <Katana/PublicHeader.h>
``` | /content/code_sandbox/Sources/Katana.h | objective-c | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 91 |
```swift
//
// Types.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
import Hydra
/**
Typealias for the type erased function that is invoked when the state changes.
- parameter oldState: the state before the update
- parameter newState: the state after the update
*/
public typealias AnyStoreListener = (_ oldState: State, _ newState: State) -> Void
/**
Typealias for the function that is invoked when the state changes.
- parameter oldState: the state before the update
- parameter newState: the state after the update
*/
public typealias StoreListener<S: State> = (_ oldState: S, _ newState: S) -> Void
/// Typealias for the `Store` listener unsubscribe closure
public typealias StoreUnsubscribe = () -> Void
/// Typealias for a type that returns the `Store`'s state
public typealias GetState = () -> State
/// Typealias for the `Store.anyDispatch` function with the ability of managing the output with a promise
public typealias AnyDispatch = (_: Dispatchable) -> Promise<Any>
/// See `Executor`
@available(*, deprecated, message: "Use the new `Executor` instead")
public typealias AsyncProvider = Executor
/// Entity capable of executing a closure. This can be useful in tests to control where and when tasks
/// are executed.
///
/// - warning: Katana assumes that implementations of this protocol will always guarantee that the tasks
/// given as arguments are never executed in parallel.
public protocol Executor {
/// Calling this method will enqueue a task to be executed asynchronously
@available(*, deprecated, message: "Use the new `executeAsync` instead")
func execute(_ closure: @escaping () -> Void)
/// Calling this method will immediately execute a task, blocking the current thread until the task is
/// finished. It needs to be reentrant (it can be called again from the closure argument without
/// causing a deadlock).
@discardableResult
func executeSync<T>(_ closure: @escaping () -> T) -> T
}
extension Executor {
/// Calling this method will enqueue a task to be executed asynchronously
///
/// Note: this is the method that supersedes `execute(_:)`
public func executeAsync(_ closure: @escaping () -> Void) {
self.execute(closure)
}
/// Calling this method will immediately execute a task, blocking the current thread until the task is
/// finished.
///
/// Note: this default implementation will not use the underlying context for executing the closure. It
/// will not use `executeAsync` under the hood, so you should not use this implementation if you need, for
/// example, to execute the closure on a specific thread/queue.
///
/// This is an default implementation made to avoid having a breaking change in the code. It
/// will be removed in the future.
@available(*, deprecated, message: "Use a proper primitive given by your underlying implementation")
public func executeSync<T>(_ closure: @escaping () -> T) -> T {
return closure()
}
}
/// DispatchQueue conformance to `Executor` so that `DispatchQueue.main` can be used
extension DispatchQueue: Executor {
public func execute(_ closure: @escaping () -> Void) {
self.async(execute: closure)
}
public func executeSync<T>(_ closure: @escaping () -> T) -> T {
// Since `DispatchQueue.sync` is not reentrant (it will just crash the app) a proper
// check is needed. The idea is to use `.setSpecific` to add a value to the queue, and
// then `.getSpecific` to get the value back. Note that `.getSpecific` does not operate
// on `self`, but on the queue this thread is belonging to. This means that `.getSpecific`
// will return the value set only if this function is executed in the queue (and therefore,
// the closure must not be wrapped in a `self.sync`).
let key = DispatchSpecificKey<Void>()
self.setSpecific(key: key, value: ())
defer {
self.setSpecific(key: key, value: nil)
}
if DispatchQueue.getSpecific(key: key) != nil {
return closure()
} else {
return self.sync(execute: closure)
}
}
}
``` | /content/code_sandbox/Sources/Types.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 922 |
```swift
//
// StateUpdater.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
/**
Type erasure for `StateUpdater`
- seeAlso: `StateUpdater`
*/
public protocol AnyStateUpdater: Dispatchable {
/**
Creates the new state starting from the current state.
- parameter currentState: the current configuration of the state
- returns: the new version of the state
- seeAlso: `StateUpdater`
*/
func updatedState(currentState: State) -> State
}
/**
A `StateUpdater` is a `Dispatchable` that can be used to update the `Store`
state configuration.
The `StateUpdater` is strongly tied to the state that it handles. This greatly simplifies
the code written in normal situations. However, if you need to create updaters that are not strictly
tied to a concrete state type (e.g., in a library) you can use `AnyStateUpdater`.
### App Tips & Tricks
To additionally simplify the usage of a `StateUpdater` you can add to your application an helper protocol
```swift
/// assuming `AppState` is the type of your application's state
protocol AppStateUpdater: StateUpdater where StateType == AppState {}
```
By conforming to `AppStateUpdater`, you will get better autocompletion
*/
public protocol StateUpdater: AnyStateUpdater {
/// The concrete state type that the updater manages
associatedtype StateType: State
/**
Updates the current state. It is important to note that `updateState(currentState:)`
should be a [pure function](path_to_url that is
a function that given the same input always returns the same output and it also
doesn't have any side effect. This is really important because it is an assumption
that Katana (and related tools) makes in order to implement some functionalities.
- parameter state: the current configuration of the state. The method is meant to update
the value of the state in place
*/
func updateState(_ state: inout StateType)
}
extension StateUpdater {
/// Conformance of `StateUpdater` to `AnyStateUpdater`
public func updatedState(currentState: State) -> State {
guard var typedState = currentState as? StateType else {
fatalError("[Katana] updateState invoked with the wrong state type")
}
self.updateState(&typedState)
return typedState
}
}
``` | /content/code_sandbox/Sources/StateUpdater.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 513 |
```swift
//
// State.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
/**
Protocol for the state of the applications.
In Katana, all the relevant application information should be placed in a single
struct that has to implement the `State` protocol.
*/
public protocol State {
/**
Returns the initial configuration of the `State` implementation.
It is used by Katana to create the very initial configuration of the application.
*/
init()
}
``` | /content/code_sandbox/Sources/State.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 104 |
```swift
//
// SideEffectDependencyContainer.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
import Hydra
/// Protocol that the side effect dependencies container should implement
public protocol SideEffectDependencyContainer: AnyObject {
/**
Creates a new instance of the container.
The container is instantiated when the store is instantiated
- parameter dispatch: a closure that can be used to dispatch dispatchables
- parameter getState: a closure that returns the current state
- returns: an instance of the container
*/
init(dispatch: @escaping AnyDispatch, getState: @escaping GetState)
}
/// An empty dependencies container. It can be used for testing purposes or you don't need dependencies
public class EmptySideEffectDependencyContainer: SideEffectDependencyContainer {
/**
Creates an empty dependency container
- parameter dispatch: a closure that can be used to dispatch dispatchables
- returns: an instance of the container
*/
public required init(dispatch _: @escaping AnyDispatch, getState _: @escaping GetState) {}
}
``` | /content/code_sandbox/Sources/SideEffectDependencyContainer.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 225 |
```swift
//
// SignpostLogger.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
import os.signpost
/**
Wrapper around the signpost API offered starting from iOS12.
The logger will automatically track side effects, state updaters and side effects
in Instruments. You will get a nice visualization of the operations that are ongoing,
the parallelism level and the time that each operation requires.
- seeAlso: path_to_url
*/
public struct SignpostLogger {
/// A closure that must be invoked when the operation is completed
typealias LogEndClosure = () -> Void
/// Whether the logging is enabled. You should invoke this before instantiating
/// the store in your application
public static var isEnabled = false
/// The shared value of the singleton
static var shared = SignpostLogger()
/// An utility function
static var noop: LogEndClosure = {}
/// The type of operation that should be logged
enum LogType {
/// Log a state updater operation
case stateUpdater
/// Log a side effect operation
case sideEffect
}
/// The `OSLog` instance that backs the logger
let katanaLogger: OSLog?
/**
Starts to log an operation
- parameter type: the type of operation
- parameter name: a unique name associated with the log
- returns: a closure to invoke when the related operations ends
*/
func logStart(type: LogType, name: String) -> LogEndClosure {
guard let log = self.katanaLogger else {
return SignpostLogger.noop
}
if #available(iOS 12.0, OSX 10.14, *) {
switch type {
case .stateUpdater:
return self.logStateUpdater(log: log, name: name)
case .sideEffect:
return self.logSideEffect(log: log, name: name)
}
}
return SignpostLogger.noop
}
/**
Starts to log a state updater operation
- parameter log: the underlying log to use
- parameter name: a unique name associated with the log
- returns: a closure to invoke when the related operations end
*/
@available(iOS 12.0, OSX 10.14, *)
func logStateUpdater(log: OSLog, name: String) -> LogEndClosure {
let signpostID = OSSignpostID(log: log)
os_signpost(.begin, log: log, name: "State Updater", signpostID: signpostID, "%{public}s", name)
return {
os_signpost(.end, log: log, name: "State Updater", signpostID: signpostID, "%{public}s", name)
}
}
/**
Starts to log a side effect operation
- parameter log: the underlying log to use
- parameter name: a unique name associated with the log
- returns: a closure to invoke when the related operation ends
*/
@available(iOS 12.0, OSX 10.14, *)
func logSideEffect(log: OSLog, name: String) -> LogEndClosure {
let signpostID = OSSignpostID(log: log)
os_signpost(.begin, log: log, name: "Side Effect", signpostID: signpostID, "%{public}s", name)
return {
os_signpost(.end, log: log, name: "Side Effect", signpostID: signpostID, "%{public}s", name)
}
}
}
// MARK: Private
extension SignpostLogger {
/// Creates an instance of the logger.
/// If the `isEnabled` flag is false, then an empty logger is created
/// (that is, a logger that does nothing)
private init() {
if #available(iOS 10.0, OSX 10.12, *), SignpostLogger.isEnabled {
self.katanaLogger = OSLog(subsystem: "Katana", category: "Katana")
} else {
self.katanaLogger = nil
}
}
}
``` | /content/code_sandbox/Sources/SignpostLogger.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 887 |
```swift
//
// Dispatchable.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
/**
Protocol that marks something that can be actually dispatched into the `Store`.
It doesn't have any particular requirement, and the protocol is actually used to
simply mark a category of items. Currently the `Store` is able to manage 2 types
of `Dispatchable`: `SideEffect`, `StateUpdater`.
*/
public protocol Dispatchable {}
extension Dispatchable {
/// Implementation of the `CustomDebugStringConvertible` protocol
public var debugDescription: String {
return String(reflecting: type(of: self))
}
}
``` | /content/code_sandbox/Sources/Dispatchable.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 137 |
```swift
//
// Store.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
import Hydra
/// Type Erasure for `Store`
public protocol AnyStore: AnyObject {
/// Type Erasure for the `Store` `state`
var anyState: State { get }
/**
Dispatches a generic `Dispatchable` item. This is useful for customizing Katana's dispatchable, for example in other libraries.
- parameter dispatchable: the item to dispatch
- returns: a promise that is resolved when the dispatchable is handled by the store, resolving to a value associated with the
dispatchable
*/
@discardableResult
func anyDispatch(_ dispatchable: Dispatchable) -> Promise<Any>
/**
Dispatches an `AnyStateUpdater` item
- parameter dispatchable: the State Updater to dispatch
- returns: a promise that is resolved when the dispatchable is handled by the store
*/
@discardableResult
func dispatch<T: AnyStateUpdater>(_ dispatchable: T) -> Promise<Void>
/**
Dispatches an `AnySideEffect` item
- parameter dispatchable: the State Updater to dispatch
- returns: a promise that is resolved when the dispatchable is handled by the store
*/
@discardableResult
func dispatch<T: AnySideEffect>(_ dispatchable: T) -> Promise<Void>
/**
Dispatches a `ReturningSideEffect` item
- parameter dispatchable: the Returning Side Effect to dispatch
- returns: a promise parameterized to the side effect's return value, that is resolved when the dispatchable is handled by the
store
*/
@discardableResult
func dispatch<T: ReturningSideEffect>(_ dispatchable: T) -> Promise<T.ReturnValue>
/**
Adds a listener to the store. A listener is basically a closure that is invoked every time the Store's state changes.
- warning: The listener is always invoked in the main queue, and hence the provided `newState` might be older than the state
accessible with `self.anyState`.
- parameter listener: the listener closure
- returns: a closure that can be used to remove the listener
*/
func addAnyListener(_ listener: @escaping AnyStoreListener) -> StoreUnsubscribe
}
/**
Helper Store type that is used as a partial type.
This type is very helpful when you want to pass the store to pieces of your application
that must be aware of the type of state that the app manages but they should not care about
the logic part (that is, the dependency container). A very common case is when you want to
pass the store to the UI of your application. The UI shouldn't access to the dependency container
directly (it should dispatch a `SideEffect` instead) but you can still have type-safety over the
state type that is managed.
- warning: you should not create this class directly. The class is meant to be used as a partial type
erasure system over `Store`
*/
open class PartialStore<S: State>: AnyStore {
/// Closure that is used to initialize the state
public typealias StateInitializer<T: State> = () -> T
/// The current state of the application
open fileprivate(set) var state: S
/**
Implementation of the AnyStore protocol.
- seeAlso: `AnyStore`
*/
public var anyState: State {
return self.state
}
/**
Creates an instance of the `PartialStore` with the given initial state
- parameter state: the initial state of the store
*/
internal init(state: S) {
self.state = state
}
/**
Not implemented
- warning: Not implemented. Instantiate a `Store` instead
*/
@discardableResult
public func anyDispatch(_: Dispatchable) -> Promise<Any> {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
/**
Not implemented
- warning: Not implemented. Instantiate a `Store` instead
*/
@discardableResult
public func dispatch<T: AnyStateUpdater>(_: T) -> Promise<Void> {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
/**
Not implemented
- warning: Not implemented. Instantiate a `Store` instead
*/
@discardableResult
public func dispatch<T: AnySideEffect>(_: T) -> Promise<Void> {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
/**
Not implemented
- warning: Not implemented. Instantiate a `Store` instead
*/
@discardableResult
public func dispatch<T: ReturningSideEffect>(_: T) -> Promise<T.ReturnValue> {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
/**
Not implemented
- warning: Not implemented. Instantiate a `Store` instead
*/
public func addAnyListener(_: @escaping AnyStoreListener) -> StoreUnsubscribe {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
/**
Adds a listener to the store. A listener is basically a closure that is invoked every time the Store's state changes.
- warning: The listener is always invoked in the main queue, and hence the provided `newState` might be older than the state
accessible with `self.state`.
- parameter listener: the listener closure
- returns: a closure that can be used to remove the listener
- warning: Not implemented. Instantiate a `Store` instead
*/
public func addListener(_: @escaping StoreListener<S>) -> StoreUnsubscribe {
fatalError("This should not be invoked, as PartialStore should never be used directly. Use Store instead")
}
}
/// Creates an empty state
private func emptyStateInitializer<S: State>() -> S {
return S()
}
/**
The `Store` is a sort of single entry point that handles the logic of your application.
In Katana, all the various pieces of information that your application manages should be stored
in a single atom, called state (see also `State` protocol).
The `Store`, however, doesn't really implements any application specific logic: this class
only manages operations that are requested by the application-specific logic. In particular,
you can require the `Store` to execute something by `dispatching a dispatchable item`.
Currently the store handles 2 types of dispatchable: `State Updater`, `Side Effect`
#### Update the state
As written before, in Katana every relevant information in the application should be stored in the
Store's state. The only way to update the state is to dispatch a `StateUpdater`.
At this point the `Store` will execute the following operations:
- it executes the interceptors
- it creates the new state, by invoking the `updateState` function of the `StateUpdater`
- it updates the state
- it resolves the promise
#### Handle to Business Logic
Non trivial applications require to interact with external services and/or implement complex logics.
The proper way to handle these is by dispatching a `SideEffect`.
The `Store` will execute the following operations:
- it executes the interceptors
- it executes the `SideEffect` body
- it resolves the promise
#### Listen for updates
You can attach a listener that is invoked every time the state changes by using `addListener`.
#### Intercept Dispatchable
It is possible to intercept and reshape the behaviour of the `Store` by using a `StoreInterceptor`.
A `StoreInterceptor` is executed every time something has dispatched, and before it is actually
managed by the `Store`. Here you implement behaviours like logging, blocking items before they're executed
and even change dynamically which dispatchable items arrive to the `Store` itself.
- seeAlso: `StateUpdater` for more information about how to implement an update of the state
- seeAlso: `SideEffect` for more information about how to implement a complex/asynchronous logic
*/
open class Store<S: State, D: SideEffectDependencyContainer>: PartialStore<S> {
/// Closure that is used to initialize the dependencies
public typealias DependenciesInitializer = (_ dispatch: @escaping AnyDispatch, _ getState: @escaping StateInitializer<S>) -> D
typealias ListenerID = String
/// The array of registered listeners
fileprivate var listeners: [ListenerID: StoreListener<S>]
/// The array of middleware of the store
fileprivate let interceptors: [StoreInterceptor]
/// The initialized interceptors
fileprivate var initializedInterceptors: [InitializedInterceptor]! // swiftlint:disable:this implicitly_unwrapped_optional
/// Whether the store is ready to execute operations
public private(set) var isReady: Bool
/// The dependencies used in the side effects
///
/// - seeAlso: `SideEffect`
public var dependencies: D! // swiftlint:disable:this implicitly_unwrapped_optional
/// The context passed to the side effect
private var sideEffectContext: SideEffectContext<S, D>! // swiftlint:disable:this implicitly_unwrapped_optional
/// AsyncProvider used to run all the listeners
private var listenersAsyncProvider: Executor
/// The queue used to handle the `StateUpdater` items
fileprivate var stateUpdaterQueue: DispatchQueue = {
let d = DispatchQueue(label: "katana.stateupdater", qos: .userInteractive)
// queue is initially suspended. The store will enable the queue when
// all the setup is done.
// we basically enqueue all the dispatched dispatchables until
// everything is needed to manage them is correctly sat up
d.suspend()
return d
}()
/// The queue used to handle the `SideEffect` items
fileprivate var sideEffectQueue: DispatchQueue = {
let d = DispatchQueue(label: "katana.sideEffect", qos: .userInteractive, attributes: .concurrent)
// queue is initially suspended. The store will enable the queue when
// all the setup is done.
// we basically enqueue all the dispatched dispatchables until
// everything is needed to manage them is correctly sat up
d.suspend()
return d
}()
/**
A convenience init method. The store won't have middleware nor dependencies for the side effects.
The state will be created using the default init of the state
- returns: An instance of store
*/
public convenience init() {
self.init(interceptors: [], stateInitializer: emptyStateInitializer)
}
/**
A convenience init method for the Store. The initial state will be created using the default
init of the state type.
- parameter interceptors: a list of interceptors that are executed every time something is dispatched
- returns: An instance of the store
*/
public convenience init(interceptors: [StoreInterceptor]) {
self.init(
interceptors: interceptors,
stateInitializer: emptyStateInitializer
)
}
/**
A convenience init method for the Store. The dependencies will be created using the default init of the dependency type.
- parameter interceptors: a list of interceptors that are executed every time something is dispatched
- parameter stateInitializer: a closure invoked to define the first state's value
- parameter configuration: the configuration needed by the store to start properly
- returns: An instance of the store
*/
public convenience init(
interceptors: [StoreInterceptor],
stateInitializer: @escaping StateInitializer<S>,
configuration: Configuration = .init()
) {
self.init(
interceptors: interceptors,
stateInitializer: stateInitializer,
dependenciesInitializer: { dispatch, getState in D(dispatch: dispatch, getState: getState) },
configuration: configuration
)
}
/**
The default init method for the Store.
#### Initial phases
When the store is created, it doesn't immediately start to handle dispatched items.
Before that, in fact, the `Store` will (in order)
* create the dependencies
* create the first state version by using the given `stateInitializer`
* initialise the interceptors
Accessing the state before the `Store` is ready will lead to a crash of the application, as the
state of the system is not well defined. You can check whether the `Store` is ready by leveraging the `isReady` property.
A good practice in case you have to interact with the `Store` (e.g., get the state) in the initial phases of your
application is to dispatch a `SideEffect`. When dispatching something, in fact, the `Store` guarantees that
items are managed only after that the `Store` is ready. Items dispatched during the initialization are suspended
and resumed as soon as the `Store` is ready.
- parameter interceptors: a list of interceptors that are executed every time something is dispatched
- parameter stateInitializer: a closure invoked to define the first state's value
- parameter dependenciesInitializer: a closure invoked to instantiate the dependencies
- parameter configuration: the configuration needed by the store to start properly
- returns: An instance of store
*/
public init(
interceptors: [StoreInterceptor],
stateInitializer: @escaping StateInitializer<S>,
dependenciesInitializer: @escaping DependenciesInitializer,
configuration: Configuration = .init()
) {
self.listenersAsyncProvider = configuration.listenersAsyncProvider
self.listeners = [:]
self.interceptors = interceptors
self.isReady = false
let emptyState: S = emptyStateInitializer()
super.init(state: emptyState)
self.dependencies = dependenciesInitializer(self.anyDispatchClosure, self.getStateClosure)
self.sideEffectContext = SideEffectContext<S, D>(
dependencies: self.dependencies,
getState: self.getStateClosure,
dispatch: self.anyDispatchClosure
)
/// Do the initialization operation async to avoid to block the store init caller
/// which in a standard application is the AppDelegate. WatchDog may decide to kill the app
/// if the stateInitializer function takes too much to do its job and we block the app's startup
configuration.stateInitializerAsyncProvider.executeAsync { [unowned self] in
self.initializeInternalState(using: stateInitializer)
}
}
/// The `anyDispatch` method as a closure which does not capture `self` to avoid reference loops
private var anyDispatchClosure: AnyDispatch {
return { [unowned self] dispatchable in
self.anyDispatch(dispatchable)
}
}
/// The `getState` method as a closure which does not capture `self` to avoid reference loops
private var getStateClosure: () -> S {
return { [unowned self] in
self.getState()
}
}
/**
Adds a listener to the store. A listener is basically a closure that is invoked every time the Store's state changes.
- warning: The listener is always invoked in the main queue, and hence the provided `newState` might be older than the state
accessible with `self.state`.
- parameter listener: the listener closure
- returns: a closure that can be used to remove the listener
*/
override public func addAnyListener(_ listener: @escaping AnyStoreListener) -> StoreUnsubscribe {
return self.addListener { oldState, newState in
listener(oldState, newState)
}
}
/**
Adds a typed listener to the store. A listener is basically a closure that is invoked every time the Store's state changes.
- warning: The listener is always invoked in the main queue, and hence the provided `newState` might be older than the state
accessible with `self.state`.
- parameter listener: the listener closure
- returns: a closure that can be used to remove the listener
*/
override public func addListener(_ listener: @escaping StoreListener<S>) -> StoreUnsubscribe {
let listenerID: ListenerID = UUID().uuidString
self.listenersAsyncProvider.executeSync {
self.listeners[listenerID] = listener
}
return { [weak self] in
self?.listenersAsyncProvider.executeSync { [weak self] in
self?.listeners.removeValue(forKey: listenerID)
}
}
}
/**
Dispatches a `ReturningSideEffect` item
#### Threading
The `Store` follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.
When a `ReturningSideEffect` is dispatched, Katana will handle them in a parallel queue. A `ReturningSideEffect` is executed
and considered done when its body finishes to be executed. This means that side effects are not guaranteed to be run in
isolation, and you should take into account the fact that multiple side effects can run at the same time. This decision has
been taken to greatly improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store's state) without dispatching a `ReturningSideEffect`.
#### Promise Resolution
When it comes to `ReturningSideEffect`s, the promise is resolved when the body of the `ReturningSideEffect` is executed
entirely (see `ReturningSideEffect` documentation for more information).
- parameter dispatchable: the side effect to dispatch
- returns: a promise parameterized to SideEffect's return value, that is resolved when the SideEffect is handled by the store
*/
@discardableResult
override public func dispatch<T: ReturningSideEffect>(_ dispatchable: T) -> Promise<T.ReturnValue> {
return self.enqueueSideEffect(dispatchable)
}
/**
Dispatches a `AnySideEffect` item
#### Threading
The `Store` follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.
When a `AnySideEffect` is dispatched, Katana will handle them in a parallel queue. A `AnySideEffect` is executed and considered
done when its body finishes to be executed. This means that side effects are not guaranteed to be run in isolation, and you
should take into account the fact that multiple side effects can run at the same time. This decision has been taken to greatly
improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store's state) without dispatching a `AnySideEffect`.
#### Promise Resolution
When it comes to `AnySideEffect`s, the promise is resolved when the body of the `AnySideEffect` is executed entirely (see
`AnySideEffect` documentation for more information).
- parameter dispatchable: the side effect to dispatch
- returns: a promise parameterized to SideEffect's return value, that is resolved when the SideEffect is handled by the store
*/
@discardableResult
override public func dispatch<T: AnySideEffect>(_ dispatchable: T) -> Promise<Void> {
self.enqueueSideEffect(dispatchable)
}
/**
Dispatches a `Dispatchable` item
#### Threading
The `Store` follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.
When an `AnyStateUpdater` is dispatched, the Store enqueues it in a serial and synchronous queue. This means that the Store
executes one update of the state at the time, following the order in which it has received them. This is done
to guarantee the predictability of the changes to the state and avoid any race condition. In general, using a synchronous
queue is never a big problem as any operation that goes in an `AnyStateUpdater` is very lightweight.
#### Promise Resolution
When it comes to `AnyStateUpdater`, the promise is resolved when the state is updated.
- parameter dispatchable: the state updater to dispatch
- returns: a promise parameterized to void that is resolved when the state updater is handled by the store
*/
@discardableResult
override public func dispatch<T: AnyStateUpdater>(_ dispatchable: T) -> Promise<Void> {
return self.enqueueStateUpdater(dispatchable)
}
/**
Dispatches a `Dispatchable` item
#### Threading
The `Store` follows strict rules about the parallelism with which dispatched items are handled.
At the same time, it tries to leverages as much as possible the modern multi-core systems that our
devices offer.
When a `StateUpdater` is dispatched, the Store enqueues it in a serial and synchronous queue. This means that the Store
executes one update of the state at the time, following the order in which it has received them. This is done
to guarantee the predictability of the changes to the state and avoid any race condition. In general, using a synchronous
queue is never a big problem as any operation that goes in a `StateUpdater` is very lightweight.
When it comes to `SideEffect` items, Katana will handle them in a parallel queue. A `SideEffect` is executed and considered
done when its body finishes to be executed. This means that side effects are not guaranteed to be run in isolation, and you
should take into account the fact that multiple side effects can run at the same time. This decision has been taken to greatly
improve the performances of the system. Overall, this should not be a problem as you cannot really change
the state of the system (that is, the store's state) without dispatching a `StateUpdater`.
#### Promise Resolution
When it comes to `StateUpdater`, the promise is resolved when the state is updated. For `SideEffect`,
the promise is resolved when the body of the `SideEffect` is executed entirely (see `SideEffect` documentation for
more information).
- parameter dispatchable: the dispatchable to dispatch, it can be either a StateUpdater or a SideEffect
- returns: a promise that is resolved when the dispatchable is handled by the store
*/
@discardableResult
override public func anyDispatch(_ dispatchable: Dispatchable) -> Promise<Any> {
if dispatchable as? AnyStateUpdater & AnySideEffect != nil {
fatalError("The parameter cannot implement both the state updater and the side effect")
}
if let stateUpdater = dispatchable as? AnyStateUpdater {
return self.enqueueStateUpdater(stateUpdater).then(in: .background) { _ in }
} else if let sideEffect = dispatchable as? AnySideEffect {
return self.enqueueSideEffect(sideEffect).then(in: .background) { (value: Any) in value }
}
fatalError("Invalid parameter")
}
/**
Private version of the `Dispatch` that doesn't return any promise
- parameter dispatchable: the dispatchable to dispatch
*/
fileprivate func nonPromisableDispatch(_ dispatchable: Dispatchable) {
self.anyDispatch(dispatchable)
}
/// The dependencies used to initialize katana
public struct Configuration {
/// AsyncProvider used to run the state initializer
let stateInitializerAsyncProvider: Executor
/// AsyncProvider used to run all the listeners
let listenersAsyncProvider: Executor
public init(
stateInitializerAsyncProvider: Executor = DispatchQueue.main,
listenersAsyncProvider: Executor = DispatchQueue.main
) {
self.stateInitializerAsyncProvider = stateInitializerAsyncProvider
self.listenersAsyncProvider = listenersAsyncProvider
}
}
}
// MARK: Private utilities
extension Store {
/**
Creates and initializes the internal values.
Store doesn't start to work (that is, dispatchables are not dispatched) until this function is executed
- parameter stateInitializer: the closure used to create the first configuration of the state
*/
private func initializeInternalState(using stateInitializer: StateInitializer<S>) {
self.state = stateInitializer()
self.initializedInterceptors = Store.initializedInterceptors(self.interceptors, sideEffectContext: self.sideEffectContext)
// and here we are finally able to start the queues
self.isReady = true
self.sideEffectQueue.resume()
self.stateUpdaterQueue.resume()
}
/// Invoke all the registered listeners in the configured async provider
private func invokeListeners(oldState: S, newState: S) {
self.listenersAsyncProvider.executeAsync { [weak self] () in
guard let self = self else { return }
self.listeners.values.forEach { $0(oldState, newState) }
}
}
/**
Returns the current version of the state
- returns: the current version of the state
- warning: this method should not be invoked before the state is ready. The app will crash otherwise
- seeAlso: `isReady`
*/
private func getState() -> S {
assert(self.isReady, """
The state is not ready yet. You should wait until the state is ready to invoke getState.
If you are performing operations in the dependenciesContainer's init, then the suggested way to
approach this is to dispatch a side effect. This will guarantee that this method will work correctly
""")
return self.state
}
}
// MARK: State Updater management
extension Store {
/**
Enqueues a state updater.
- parameter stateUpdater: the state updater to manage
- returns: a promise that is resolved when the state updater is managed
*/
private func enqueueStateUpdater(_ stateUpdater: AnyStateUpdater) -> Promise<Void> {
let promise = Promise<Void>(in: .custom(queue: self.stateUpdaterQueue)) { [unowned self] resolve, _, _ in
let interceptorsChain = Store.chainedInterceptors(self.initializedInterceptors, with: self.manageUpdateState)
try interceptorsChain(stateUpdater)
resolve(())
}
// triggers the execution of the promise even though no one is listening for it
promise.then(in: .background) { _ in }
return promise
}
/**
Handles the state updater. If the passed item doesn't conform to `StateUpdater`, then
the item is simply dispatched again and not handled here.
- parameter dispatchable: the item to handle
*/
private func manageUpdateState(_ dispatchable: Dispatchable) throws {
guard self.isReady else {
fatalError("Something is wrong, the state updater queue has been started before the initialization has been completed")
}
guard let stateUpdater = dispatchable as? AnyStateUpdater else {
// Interceptors changed the dispatchable type. Let's re-dispatch it
return self.nonPromisableDispatch(dispatchable)
}
let logEnd = SignpostLogger.shared.logStart(type: .stateUpdater, name: stateUpdater.debugDescription)
let oldState = self.state
let newState = stateUpdater.updatedState(currentState: oldState)
logEnd()
guard let typedNewState = newState as? S else {
preconditionFailure("StateUpdater updatedState returned a wrong state type")
}
self.state = typedNewState
self.invokeListeners(oldState: oldState, newState: typedNewState)
}
}
// MARK: Side Effect management
extension Store {
/**
Enqueues the side effect.
- parameter sideEffect: the side effect to manage
- returns: a promise parameterized to the side effect's return value that is resolved when the side effect is managed
*/
private func enqueueSideEffect<ReturnValue>(_ sideEffect: AnySideEffect) -> Promise<ReturnValue> {
let promise = async(in: .custom(queue: self.sideEffectQueue), token: nil) { [unowned self] _ -> ReturnValue in
var sideEffectValue: Any?
let executeSideEffect: StoreInterceptorNext = {
sideEffectValue = try self.manageSideEffect($0)
}
let interceptorsChain = Store.chainedInterceptors(self.initializedInterceptors, with: executeSideEffect)
try interceptorsChain(sideEffect)
guard let value = sideEffectValue as? ReturnValue else {
fatalError(
"""
It looks like you've used an interceptor that either stopped the execution of the side effect or changed the executed \
side effect.
This is not longer supported as of Katana 4.0
"""
)
}
return value
}
promise.then(in: .background) { _ in }
return promise
}
/**
Handles the side effect. If the passed item doesn't conform to `SideEffect`, then
the item is simply dispatched again and not handled here.
- parameter dispatchable: the item to handle
*/
private func manageSideEffect(_ dispatchable: Dispatchable) throws -> Any {
guard self.isReady else {
fatalError("Something is wrong, the side effect queue has been started before the initialization has been completed")
}
guard let sideEffect = dispatchable as? AnySideEffect else {
// Interceptors changed the dispatchable type. Let's re-dispatch it
return self.nonPromisableDispatch(dispatchable)
}
let logEnd = SignpostLogger.shared.logStart(type: .sideEffect, name: dispatchable.debugDescription)
let res = try sideEffect.anySideEffect(self.sideEffectContext)
logEnd()
return res
}
}
// MARK: Middleware management
extension Store {
/**
Type used internally to store partially applied interceptors.
(that is, an interceptor to which the Store has already passed the context)
*/
fileprivate typealias InitializedInterceptor = (_ next: @escaping StoreInterceptorNext)
-> (_ dispatchable: Dispatchable) throws -> Void
/// Type used to define a dispatch that can throw
fileprivate typealias ThrowingDispatch = (_: Dispatchable) throws -> Void
/**
A function that initialises the given interceptors by binding the
context.
- parameter interceptors: the interceptors to use to create the chain
- returns: an array of initialised interceptors
*/
fileprivate static func initializedInterceptors(
_ interceptors: [StoreInterceptor],
sideEffectContext: SideEffectContext<S, D>
) -> [InitializedInterceptor] {
return interceptors.map { interceptor in
return interceptor(sideEffectContext)
}
}
/**
A function that chains the given interceptors with the given last step, which
usually is the handling of the dispatchable items.
- parameter interceptors: the interceptor to chain
- parameter lastStep: the function to execute when all the interceptors have been executed
- returns: a single function that invokes all the interceptors and then the last step
*/
fileprivate static func chainedInterceptors(
_ interceptors: [InitializedInterceptor],
with lastStep: @escaping ThrowingDispatch
) -> ThrowingDispatch {
guard !interceptors.isEmpty else {
return lastStep
}
guard interceptors.count > 1 else {
return interceptors.first!(lastStep) // swiftlint:disable:this force_unwrapping
}
// reversing the chain to oppose the matryoshka effect of its execution
// so the interceptors will be executed in the same order they are given
var m = interceptors
let last = m.removeLast()
return m.reversed().reduce(last(lastStep)) { chain, middleware in
return middleware(chain)
}
}
}
``` | /content/code_sandbox/Sources/Store.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 6,758 |
```swift
//
// SideEffect.swift
// Katana
//
// See the LICENSE file for more information.
import Foundation
import Hydra
/**
Type erasure for `SideEffectContext`
- seeAlso: `SideEffectContext`
*/
public protocol AnySideEffectContext {
/// Type erased dependencies of the side effect
var anyDependencies: SideEffectDependencyContainer { get }
/**
Type erased function that returns the current configuration of the state
- returns: the type erased current configuration of the state
*/
func getAnyState() -> State
/**
Dispatches a `Dispatchable`. It will essentially call the `anyDispatch` method of the backing store.
- parameter dispatchable: the item to dispatch
- returns: a promise that is resolved when the store finishes handling the dispatched item
*/
@discardableResult
func anyDispatch(_ dispatchable: Dispatchable) -> Promise<Any>
/**
Dispatches a `AnySideEffect`.
- parameter dispatchable: the `AnySideEffect` to dispatch
- returns: a promise that is resolved with the value returned by the side effect
when the store finishes handling the dispatched item
*/
@discardableResult
func dispatch<T: AnySideEffect>(_ dispatchable: T) -> Promise<Void>
/**
Dispatches a `AnyStateUpdater`.
- parameter dispatchable: the side effect to dispatch
- returns: a promise that is resolved when the store finishes updating the state
*/
@discardableResult
func dispatch<T: AnyStateUpdater>(_ dispatchable: T) -> Promise<Void>
/**
Dispatches a `ReturningSideEffect`
- parameter dispatchable: the `ReturningSideEffect` to dispatch
- returns: a promise that is resolved with the value returned by the side effect
when the store finishes handling the dispatched item
*/
@discardableResult
func dispatch<T: ReturningSideEffect>(_ dispatchable: T) -> Promise<T.ReturnValue>
}
extension AnySideEffectContext {
/// Default implementation of the `dispatch<T: AnyStateUpdater>`
@discardableResult
public func dispatch<T: AnyStateUpdater>(_ dispatchable: T) -> Promise<Void> {
return self.anyDispatch(dispatchable).voidInBackground
}
/// Default implementation of the `dispatch<T: AnySideEffect>`
@discardableResult
public func dispatch<T: AnySideEffect>(_ dispatchable: T) -> Promise<Void> {
return self.anyDispatch(dispatchable).voidInBackground
}
/// Default implementation of the `dispatch<T: ReturningSideEffect>`
@discardableResult
public func dispatch<T: ReturningSideEffect>(_ dispatchable: T) -> Promise<T.ReturnValue> {
return self.anyDispatch(dispatchable).then(in: .background) { $0 as! T.ReturnValue } // swiftlint:disable:this force_cast
}
}
/**
Context passed to each side effect.
The context is basically a wrapper of methods and utilities that the side effect
can leverage to implement its functionalities
*/
public struct SideEffectContext<S, D> where S: State, D: SideEffectDependencyContainer {
/**
The dependencies passed to the `Store`. You can use this as a mechanism for
dependencies injection.
*/
public let dependencies: D
/// The closure used to get the current version of the state
private let getStateClosure: () -> S
/// The closure that dispatches an item
private let dispatchClosure: AnyDispatch
/**
Creates a new context.
- parameter dependencies: the dependencies of the side effect
- parameter getState: a closure that returns the current configuration of the state
- parameter dispatch: a closure that dispatches an item
*/
init(dependencies: D, getState: @escaping () -> S, dispatch: @escaping AnyDispatch) {
self.dependencies = dependencies
self.dispatchClosure = dispatch
self.getStateClosure = getState
}
/**
Function that returns the current configuration of the state
- returns: the current configuration of the state
*/
public func getState() -> S {
return self.getStateClosure()
}
/**
Dispatches a `Dispatchable` item. This is the equivalent of the `Store` `anyDispatch`.
- seeAlso: `Store` implementation of `anyDispatch`
*/
@discardableResult
public func anyDispatch(_ dispatchable: Dispatchable) -> Promise<Any> {
return self.dispatchClosure(dispatchable)
}
}
/// `SideEffectContext` conformance to `AnySideEffectContext`
extension SideEffectContext: AnySideEffectContext {
/// Implementation of the `anyDependencies` requirement for `AnySideEffectContext`
public var anyDependencies: SideEffectDependencyContainer {
return self.dependencies
}
/// Implementation of the `getAnyState` requirement for `AnySideEffectContext`
public func getAnyState() -> State {
return self.getState()
}
}
/**
Type erasure for `SideEffect` and `ReturningSideEffect`
- seeAlso: `SideEffect`, `ReturningSideEffect`
*/
public protocol AnySideEffect: Dispatchable {
/**
Block that implements the logic of the side effect.
- parameter context: the context of the side effect
- throws: if the logic has an error. The related promise will be rejected
- returns: the side effect return value, if applicable
- seeAlso: `SideEffect`, `ReturningSideEffect`
*/
func anySideEffect(_ context: AnySideEffectContext) throws -> Any
}
/**
A `AnySideEffect` that is capable of returning a typed value.
In order to promote reusability of the logic written using this type, both the state and
the dependencies are erased. This helps tremendously when writing libraries and generic
logic, and it can also be extended to be used in the apps.
For example, if the app needs to use a typed returning side effect it can define something like:
```
protocol AppReturningSideEffect: ReturningSideEffect {
typealias StateType = AppState
typealias Dependencies = AppDependencies
func sideEffect(_ context: SideEffectContext<StateType, Dependencies>) throws -> ReturnType
}
extension AppReturningSideEffect {
func sideEffect(_ context: AnySideEffectContext) throws -> ReturnValue {
guard let typedContext = context as? SideEffectContext<StateType, Dependencies> else {
fatalError("Invalid context passed to side effect")
}
return try self.sideEffect(typedContext)
}
}
```
- seeAlso: `AnySideEffect`, `SideEffect`
*/
public protocol ReturningSideEffect: AnySideEffect {
/// The type of the return value
associatedtype ReturnValue
/**
Implements the logic of the side effect.
- parameter context: the context of the side effect
- throws: if the logic has an error. The related promise will be rejected
- returns: the side effect return value, if applicable
- seeAlso: `AnySideEffect`
*/
func sideEffect(_ context: AnySideEffectContext) throws -> ReturnValue
}
/// Conformance of `ReturningSideEffect` to `AnySideEffect`
extension ReturningSideEffect {
/// Implementation of the `anySideEffect` requirement for `ReturningSideEffectContext`
public func anySideEffect(_ context: AnySideEffectContext) throws -> Any {
return try self.sideEffect(context)
}
}
/**
A side effect is a single atom of the logic of your application.
While you can actually use them as you desire, the idea is to implement in each side effect
a meaningful, self contained, piece of logic that can be used from other pieces of you application
(e.g., dispatched by a View Controller or by another side effect).
The `SideEffect` is strongly tied to the state that it handles and the dependencies it has.
This greatly simplifies the code written in normal situations.
However, if you need to create updaters that are not strictly tied to a concrete types (e.g., in a library)
you can use `AnySideEffect`.
### App Tips & Tricks
To further simplify the usage of a `SideEffect` you can add to your application a helper protocol
```swift
/// assuming `AppState` is the type of your application's state and `DependenciesContainer` is the
/// container of your dependencies
protocol AppSideEffect: SideEffect where StateType == AppState, Dependencies == DependenciesContainer {}
```
By conforming to `AppSideEffect`, you will get better autocompletion
*/
public protocol SideEffect: AnySideEffect {
/// The type of the state of the store
associatedtype StateType: State
/// The type of the dependencies container that is used to pass dependencies to the side effect
associatedtype Dependencies: SideEffectDependencyContainer
/**
Block that implements the logic of the side effect.
You can implement the logic, leveraging the technology you desire for threading and flow management.
However, there are two patterns that Katana suggests to use: synchronous side effects and asynchronous side effects
#### Synchronous
A synchronous side effect is a side effect that finishes its execution when the `sideEffect(:)` method
is completed. Since the related promise (that is, the promise that is returned when the side effect is dispatched)
is resolved when this method ends, it means that the caller can safely assume that the operations are completed.
The easier way to achieve this behaviour is by using `Hydra.await` offered by the `Hydra` library. You can use `Hydra.await`
with any API that returns a promise (e.g., the dispatch) and it blocks the execution of the method until the
promise is resolved (you can find more documentation here path_to_url#awaitasync).
This should be the default approach you take for your side effects
#### Asynchronous
An asynchronous side effect is a side effect that continues to propagate its effect even after the `sideEffect(:)` method
has been completed. This can be very helpful for very long running operations where you don't want to block
other side effects in the queue.
In order to do use this approach, you can simply apply any asynchronous technique you know that does not block the method
(e.g.: promise, callback).
This approach is not suggested and should be used only in rare cases
- parameter context: the context of the side effect
- returns: the side effect return value that will be used to parameterize the related promise
- throws: if the logic has an error. The related promise will be rejected
- seeAlso: path_to_url#awaitasync
*/
func sideEffect(_ context: SideEffectContext<StateType, Dependencies>) throws
}
extension SideEffect {
/// Conformance of `SideEffect` to `ReturningSideEffect`
public func anySideEffect(_ context: AnySideEffectContext) throws -> Any {
guard let typedSideEffect = context as? SideEffectContext<StateType, Dependencies> else {
fatalError("Invalid context passed to side effect")
}
try self.sideEffect(typedSideEffect)
return ()
}
}
extension Promise {
/// Maps a promise hiding the return type. Note that this new promise
/// runs in the background
fileprivate var voidInBackground: Promise<Void> {
return self.then(in: .background) { _ in }
}
}
``` | /content/code_sandbox/Sources/SideEffect.swift | swift | 2016-08-09T08:09:22 | 2024-08-10T03:34:45 | katana-swift | BendingSpoons/katana-swift | 2,251 | 2,397 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.