Function

Static Public Summary
public	AuthApp(props: Object): ReactDOM Generate an user log in component
public	AuthForm(props: Object): ReactDOM Generate a form
public	FilterLink(props: Object): ReactDOM Generate a link to change filter value
public	HomePage(): ReactDOM Temporary home page
public	MainApp(props: Object): ReactDOM Main wrapper
public	Menu(): ReactDOM Generate site navigation
public	NotFound(): ReactDOM Error 404 fallback page
public	Todo(props: Object): ReactDOM Generate a clickable todo item with a label and an delete button
public	TodoApp(props: Object): ReactDOM Generate the whole todo application
public	TodoFilterLinks(props: Object): ReactDOM Generate a list of todo filter links
public	TodoFooter(props: Object): ReactDOM Generate a footer for the todo list
public	TodoForm(props: Object): ReactDOM Generate a form to submit a new todo
public	TodoList(props: Object): ReactDOM Generate a list of todos
public	User(props: userObj): ReactDOM Generate user item with a picture and a link to the profile
public	UserApp(props: Object): ReactDOM Generate a header to display list title and button to launch user query
public	UserError(props: Object): ReactDOM Generate a visual error when request fails
public	UserHeader(props: Object): ReactDOM Generate a header to display list title and button to launch user query
public	UserList(props: Object): ReactDOM Generate a list of users
public	addTodo(label: string): Object action to add a todo
public	authReducer(state: Object, action: Object): Object reducer for auth actions
public	clearTodo(): Object action to clear completed todos
public	fetchUsers(since: number, perPage: number): Object action to fetch user
public	fetchUsersEpic(action$: Object): Array<userObj> \| Object Epic observer that query user API when triggered
public	fetchUsersError(error: *): Object action to provide users error logs to state
public	fetchUsersSuccess(data: Array<userObj>): Object action to provide users data to the state
public	getFilteredTodos(todos: Array<todoObj>, filter: string): Array<todoObj> filter a list of given todos
public	logIn(login: string, password: string): Object action to log user in
public	logInEpic(action$: Object): Object Epic observer that query auth API when triggered
public	logInFailure(error: Object): Object action to notify user log in failure
public	logInSuccess(user: Object): Object action to notify user log in success
public	logOut(): Object action to log user out
public	removeTodo(id: number): Object action to remove a todo
public	setTodoFilter(filter: string): Object action to set a filter
public	todoFiltersReducer(state: string, action: string): string reducer for filter actions
public	todosReducer(state: Array<todoObj>, action: Object): Array<todoObj> reducer for todo actions
public	toggleTodo(id: number): Object action to toggle a todo
public	usersReducer(state: Object, action: Object): Object reducer for users actions

Static Public

public AuthApp(props: Object): ReactDOM source

import {AuthApp} from 'redux/app/modules/auth/AuthApp.component.js'

Generate an user log in component

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.onLoginFormSubmit	function	nullable: false	the function to perform when the auth form is submitted, here logIn

Return:

ReactDOM

generate <section class="authApp"/> markup

Test:

components

public AuthForm(props: Object): ReactDOM source

import {AuthForm} from 'redux/app/modules/auth/AuthApp.component.js'

Generate a form

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.onSubmit	function	nullable: false	the function to perform when the form is submitted, here logIn

Return:

ReactDOM

generate <form class="authForm"/> markup

Test:

components

public FilterLink(props: Object): ReactDOM source

import {FilterLink} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a link to change filter value

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.active	boolean	nullable: false	whether the link is already active or not
props.filter	string	nullable: false	constant representing the filter value
props.onClick	function(filter: string)	nullable: false	function to perform when link is clicked, here setTodoFilter

Return:

ReactDOM

generate <a class="filterList_item"> markup

Test:

components

public HomePage(): ReactDOM source

import {HomePage} from 'redux/app/modules/main/MainApp.component.js'

Temporary home page

Return:

ReactDOM

generate <div class="homePage"/> markup

public MainApp(props: Object): ReactDOM source

import MainApp from 'redux/app/modules/main/MainApp.component.js'

Main wrapper

Params:

Name	Type	Attribute	Description
props	Object		react props object
props.children	ReactDOM		all components called from router

Return:

ReactDOM

generate <div class="notFound"/> markup

import {Menu} from 'redux/app/modules/main/MainApp.component.js'

Generate site navigation

Return:

ReactDOM

generate <nav class="appMenu"/> markup

public NotFound(): ReactDOM source

import {NotFound} from 'redux/app/modules/main/MainApp.component.js'

Error 404 fallback page

Return:

ReactDOM

generate <div class="notFound"/> markup

public Todo(props: Object): ReactDOM source

import {Todo} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a clickable todo item with a label and an delete button

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.completed	boolean	nullable: false	whether the todo is completed or not
props.label	string	nullable: false	the todo label
props.onClick	function	nullable: false	the function to perform when the todo label is clicked, here toggleTodo
props.onButtonClick	function	nullable: false	the function to perform when the todo button is clicked, here removeTodo

Return:

ReactDOM

generate <li class="todoList_item"/> markup

Test:

components

public TodoApp(props: Object): ReactDOM source

import {TodoApp} from 'redux/app/modules/todos/TodoApp.component.js'

Generate the whole todo application

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.todos	Array<todoObj>	nullable: false	list of all available todos
props.filter	string	nullable: false	current active filter
props.filterList	Array<string>	nullable: false	list of all todo filters
props.onTodoFormSubmit	function	nullable: false	function to perform when the todo form is submitted
props.onTodoClick	function	nullable: false	function to perform when the todo label is clicked
props.onTodoButtonClick	function	nullable: false	function to perform when the todo button is clicked
props.onTodoClearClick	function	nullable: false	function to perform when the clear button is clicked
props.onLinkClick	function	nullable: false	function to perform when a filter link is clicked

Return:

ReactDOM

generate <section class="todoApp" /> markup

Test:

components

public TodoFilterLinks(props: Object): ReactDOM source

import {TodoFilterLinks} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a list of todo filter links

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.filterList	Array<string>	nullable: false	list of all available filters
props.currentFilter	string	nullable: false	constant representing the currently active filter in the list
props.onLinkClick	function()	nullable: false	function to perform when a filter link is clicked

Return:

ReactDOM

generate <div class="filterList" /> markup

Test:

components

public TodoFooter(props: Object): ReactDOM source

import {TodoFooter} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a footer for the todo list

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.todos	Array<todoObj>	nullable: false	list of all todos
props.onTodoClearClick	function()	nullable: false	function to perform when the clear button is clicked

Return:

ReactDOM

generate <p class="todoFooter" /> markup

Test:

components

public TodoForm(props: Object): ReactDOM source

import {TodoForm} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a form to submit a new todo

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.onTodoFormSubmit	function(label: string)	nullable: false	function to perform on form submit

Return:

ReactDOM

generate <form class="todoForm"/> markup

Test:

components

public TodoList(props: Object): ReactDOM source

import {TodoList} from 'redux/app/modules/todos/TodoApp.component.js'

Generate a list of todos

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.filteredTodos	Array<todoObj>	nullable: false	pre-filtered list of todos depending on the actual selected filter
props.onTodoClick	function(id: number)	nullable: false	function to perform when a todo label is clicked, here toggleTodo
props.onTodoButtonClick	function(id: number)	nullable: false	function to perform when a todo button is clicked, here removeTodo

Return:

ReactDOM

generate <ul class="todoList"/> markup

Test:

components

public User(props: userObj): ReactDOM source

import {User} from 'redux/app/modules/users/UserApp.component.js'

Generate user item with a picture and a link to the profile

Params:

Name	Type	Attribute	Description
props	userObj	nullable: false	user object

Return:

ReactDOM

generate <li class="userList_item"/> markup

Test:

components

public UserApp(props: Object): ReactDOM source

import {UserApp} from 'redux/app/modules/users/UserApp.component.js'

Generate a header to display list title and button to launch user query

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.users	Array<userObj>	nullable: false	list of user object
props.error	Object	nullable: false	error object to display
props.error.message	string	nullable: false	error message
props.onRefreshButtonClick	Object	nullable: false	function to run when refresh button is clicked

Return:

ReactDOM

generate <section class="userApp"/> markup

Test:

components

public UserError(props: Object): ReactDOM source

import {UserError} from 'redux/app/modules/users/UserApp.component.js'

Generate a visual error when request fails

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.error	Object	nullable: false	error object to display
props.error.message	string	nullable: false	error message

Return:

ReactDOM

generate <p class="userError"/> markup

Test:

components

public UserHeader(props: Object): ReactDOM source

import {UserHeader} from 'redux/app/modules/users/UserApp.component.js'

Generate a header to display list title and button to launch user query

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.onClick	Object	nullable: false	function to run when refresh button is clicked

Return:

ReactDOM

generate <div class="userHeader"/> markup

Test:

components

public UserList(props: Object): ReactDOM source

import {UserList} from 'redux/app/modules/users/UserApp.component.js'

Generate a list of users

Params:

Name	Type	Attribute	Description
props	Object	nullable: false	react props object
props.users	Array<userObj>	nullable: false	list of user object

Return:

ReactDOM

generate <ul class="userList"/> markup

Test:

components

public addTodo(label: string): Object source

import {addTodo} from 'redux/app/modules/todos/reducers/todos.reducer.js'

action to add a todo

Params:

Name	Type	Attribute	Description
label	string	nullable: false

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
label	string		label of the todo to create

Test:

actions addTodo()

public authReducer(state: Object, action: Object): Object source

import authReducer from 'redux/app/modules/auth/reducers/auth.reducer.js'

reducer for auth actions

Params:

Name	Type	Attribute	Description
state	Object		current state value
state.isFetching	boolean		whether auth process is pending or not
state.isAuthenticated	boolean		whether user is authenticated or not
state.user	Object		user data
state.error	Object		error data
action	Object		action to perform on the state
action.type	string		describe the action type

Return:

Object

Return Properties:

Name	Type	Attribute	Description
state.isFetching	boolean		whether auth process is pending or not
state.isAuthenticated	boolean		whether user is authenticated or not
state.user	Object		user data
state.error	Object		error data

Test:

reducers authReducer()

public clearTodo(): Object source

import {clearTodo} from 'redux/app/modules/todos/reducers/todos.reducer.js'

action to clear completed todos

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type

Test:

actions clearTodo()

public fetchUsers(since: number, perPage: number): Object source

import {fetchUsers} from 'redux/app/modules/users/reducers/users.reducer.js'

action to fetch user

Params:

Name	Type	Attribute	Description
since	number	optional default: RANDOM nullable: true	id from where to get users, default is a random number
perPage	number	optional default: 10 nullable: true	number of user to get, default is 10

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
since	number		id from where to get users
perPage	number		number of user to get

Test:

actions fetchUsers()

public fetchUsersEpic(action$: Object): Array<userObj> | Object source

import {fetchUsersEpic} from 'redux/app/modules/users/reducers/users.reducer.js'

Epic observer that query user API when triggered

Params:

Name	Type	Attribute	Description
action$	Object		action object that trigger the user API request
action$.type	string		action type

Return:

Array<userObj> | Object

public fetchUsersError(error: *): Object source

import {fetchUsersError} from 'redux/app/modules/users/reducers/users.reducer.js'

action to provide users error logs to state

Params:

Name	Type	Attribute	Description
error	*		error from failed API request

Return:

Object

Return Properties:

Name	Type	Attribute	Description
action	type		type
error	Object		error from failed API request

Test:

actions fetchUsersError()

public fetchUsersSuccess(data: Array<userObj>): Object source

import {fetchUsersSuccess} from 'redux/app/modules/users/reducers/users.reducer.js'

action to provide users data to the state

Params:

Name	Type	Attribute	Description
data	Array<userObj>		user list from API

Return:

Object

Return Properties:

Name	Type	Attribute	Description
action	type		type
data	Array<userObj>		user list from API

Test:

actions fetchUsersSuccess()

public getFilteredTodos(todos: Array<todoObj>, filter: string): Array<todoObj> source

import {getFilteredTodos} from 'redux/app/modules/todos/reducers/todoFilter.reducer.js'

filter a list of given todos

Params:

Name	Type	Attribute	Description
todos	Array<todoObj>		list of todos to filter
filter	string		filter value

Return:

Array<todoObj>

a list of filtered todos

import {logIn} from 'redux/app/modules/auth/reducers/auth.reducer.js'

action to log user in

Params:

Name	Type	Attribute	Description
login	string	nullable: false	user login
password	string	nullable: false	user password

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
login	string		user login
password	string		user password

Test:

actions logIn()

public logInEpic(action$: Object): Object source

import {logInEpic} from 'redux/app/modules/auth/reducers/auth.reducer.js'

Epic observer that query auth API when triggered

Params:

Name	Type	Attribute	Description
action$	Object		action object that trigger the auth API request
action$.type	string		action type

Return:

Object

public logInFailure(error: Object): Object source

import {logInFailure} from 'redux/app/modules/auth/reducers/auth.reducer.js'

action to notify user log in failure

Params:

Name	Type	Attribute	Description
error	Object	nullable: false	error object related to the failure

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
error	string		error data

Test:

actions logInFailure()

public logInSuccess(user: Object): Object source

import {logInSuccess} from 'redux/app/modules/auth/reducers/auth.reducer.js'

action to notify user log in success

Params:

Name	Type	Attribute	Description
user	Object	nullable: false	data to associate to the current user

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
user	string		user data

Test:

actions logInSuccess()

public logOut(): Object source

import {logOut} from 'redux/app/modules/auth/reducers/auth.reducer.js'

action to log user out

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type

Test:

actions logOut()

public removeTodo(id: number): Object source

import {removeTodo} from 'redux/app/modules/todos/reducers/todos.reducer.js'

action to remove a todo

Params:

Name	Type	Attribute	Description
id	number	nullable: false

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
id	number		id of the todo to remove

Test:

actions removeTodo()

public setTodoFilter(filter: string): Object source

import {setTodoFilter} from 'redux/app/modules/todos/reducers/todoFilter.reducer.js'

action to set a filter

Params:

Name	Type	Attribute	Description
filter	string		label of the filter to set

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
filter	string		label of the filter to set

Test:

actions setTodoFilter()

public todoFiltersReducer(state: string, action: string): string source

import todoFiltersReducer from 'redux/app/modules/todos/reducers/todoFilter.reducer.js'

reducer for filter actions

Params:

Name	Type	Attribute	Description
state	string		current state value
action	string		action to perform on the state
action.type	string		describe the action type

Return:

string

new state value after performing the action

Test:

reducers todoFiltersReducer()

public todosReducer(state: Array<todoObj>, action: Object): Array<todoObj> source

import todosReducer from 'redux/app/modules/todos/reducers/todos.reducer.js'

reducer for todo actions

Params:

Name	Type	Attribute	Description
state	Array<todoObj>	optional default: []	current state value
action	Object		action to perform on the state
action.type	string		action type constant
action.label	string		todo label
action.id	number		todo id

Return:

Array<todoObj>

new state value after performing action

Test:

reducers todosReducer()

public toggleTodo(id: number): Object source

import {toggleTodo} from 'redux/app/modules/todos/reducers/todos.reducer.js'

action to toggle a todo

Params:

Name	Type	Attribute	Description
id	number	nullable: false

Return:

Object

Return Properties:

Name	Type	Attribute	Description
type	string		action type
id	number		id of the todo to toggle

Test:

actions toggleTodo()

public usersReducer(state: Object, action: Object): Object source

import usersReducer from 'redux/app/modules/users/reducers/users.reducer.js'

reducer for users actions

Params:

Name	Type	Attribute	Description
state	Object		current state value
state.requestState	string		user request state
state.data	Array<userObj>		data gotten from user request
state.error	Object	nullable: true	error object from failed user request
state.error.message	string		error object if an error occurred
action	Object		action to perform on the state
action.type	string		describe the action type

Return:

Object

Return Properties:

Name	Type	Attribute	Description
state.requestState	string		user request state
state.data	Array<userObj>		data gotten from user request
state.error	Object	nullable: true	error object from failed user request

Test:

reducers usersReducer()

Function

Static Public

public AuthApp(props: Object): ReactDOM source

Params:

Return:

Test:

public AuthForm(props: Object): ReactDOM source

Params:

Return:

Test:

public FilterLink(props: Object): ReactDOM source

Params:

Return:

Test:

public HomePage(): ReactDOM source

Return:

public MainApp(props: Object): ReactDOM source

Params:

Return:

public Menu(): ReactDOM source

Return:

public NotFound(): ReactDOM source

Return:

public Todo(props: Object): ReactDOM source

Params:

Return:

Test:

public TodoApp(props: Object): ReactDOM source

Params:

Return:

Test:

public TodoFilterLinks(props: Object): ReactDOM source

Params:

Return:

Test:

public TodoFooter(props: Object): ReactDOM source

Params:

Return:

Test:

public TodoForm(props: Object): ReactDOM source

Params:

Return:

Test:

public TodoList(props: Object): ReactDOM source

Params:

Return:

Test:

public User(props: userObj): ReactDOM source

Params:

Return:

Test:

public UserApp(props: Object): ReactDOM source

Params:

Return:

Test:

public UserError(props: Object): ReactDOM source

Params:

Return:

Test:

public UserHeader(props: Object): ReactDOM source

Params:

Return:

Test:

public UserList(props: Object): ReactDOM source

Params:

Return:

Test:

public addTodo(label: string): Object source

Params:

Return:

Return Properties:

Test:

public authReducer(state: Object, action: Object): Object source

Params:

Return:

Return Properties:

Test:

public clearTodo(): Object source

Return:

Return Properties: