vuex-help
Version:
a utilies library reduce boilerplate for vuex
647 lines (356 loc) • 28.4 kB
HTML
<html lang="kr" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>API 레퍼런스 · Vuex</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-vuejs/vue.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="prev" href="hot-reload.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=vuejs" id="_carbonads_js"></script>
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" >
<a target="_blank" href="https://github.com/vuejs/vuex/tree/1.0/docs">
1.0 버전 문서를 보려면?
</a>
</li>
<li class="chapter " data-level="1.3" >
<a target="_blank" href="https://github.com/vuejs/vuex/releases">
릴리즈 노트
</a>
</li>
<li class="chapter " data-level="1.4" data-path="installation.html">
<a href="installation.html">
설치
</a>
</li>
<li class="chapter " data-level="1.5" data-path="intro.html">
<a href="intro.html">
Vuex가 무엇인가요?
</a>
</li>
<li class="chapter " data-level="1.6" data-path="getting-started.html">
<a href="getting-started.html">
시작하기
</a>
</li>
<li class="chapter " data-level="1.7" >
<span>
핵심 컨셉
</span>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="state.html">
<a href="state.html">
상태
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="getters.html">
<a href="getters.html">
Getters
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="mutations.html">
<a href="mutations.html">
변이
</a>
</li>
<li class="chapter " data-level="1.7.4" data-path="actions.html">
<a href="actions.html">
액션
</a>
</li>
<li class="chapter " data-level="1.7.5" data-path="modules.html">
<a href="modules.html">
모듈
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="structure.html">
<a href="structure.html">
애플리케이션 구조
</a>
</li>
<li class="chapter " data-level="1.9" data-path="plugins.html">
<a href="plugins.html">
플러그인
</a>
</li>
<li class="chapter " data-level="1.10" data-path="strict.html">
<a href="strict.html">
Strict 모드
</a>
</li>
<li class="chapter " data-level="1.11" data-path="forms.html">
<a href="forms.html">
폼 핸들링
</a>
</li>
<li class="chapter " data-level="1.12" data-path="testing.html">
<a href="testing.html">
테스팅
</a>
</li>
<li class="chapter " data-level="1.13" data-path="hot-reload.html">
<a href="hot-reload.html">
핫 리로딩
</a>
</li>
<li class="chapter active" data-level="1.14" data-path="api.html">
<a href="api.html">
API 레퍼런스
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >API 레퍼런스</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="api-레퍼런스">API 레퍼런스</h1>
<h3 id="vuexstore">Vuex.Store</h3>
<pre class="language-"><code class="lang-js"><span class="token keyword">import</span> Vuex <span class="token keyword">from</span> <span class="token string">'vuex'</span>
<span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span> <span class="token operator">...</span>options <span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<h3 id="vuexstore-생성자-옵션">Vuex.Store 생성자 옵션</h3>
<ul>
<li><p><strong>state</strong></p>
<ul>
<li><p>자료형: <code>Object</code></p>
<p>Vuex 저장소의 루트 상태 객체 입니다.</p>
<p><a href="state.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>mutations</strong></p>
<ul>
<li><p>자료형: <code>{ [type: string]: Function }</code></p>
<p>저장소에 변이를 등록하십시오. 핸들러 함수는 항상 첫 번째 전달인자로 <code>state</code>를 받습니다 (모듈에 정의 된 경우 모듈 로컬 상태가됩니다). 두 번째 <code>payload</code> 전달인자가 있으면 처리합니다.</p>
<p><a href="mutations.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>actions</strong></p>
<ul>
<li><p>자료형: <code>{ [type: string]: Function }</code></p>
<p>저장소에 액션을 등록하십시오. 핸들러 함수는 다음 속성을 노출하는 <code>context</code> 객체를받습니다.</p>
<pre class="language-"><code class="lang-js"><span class="token punctuation">{</span>
state<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// store.state와 같습니다. 또는 모듈에 있는 경우 로컬 상태</span>
rootState<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// store.state와 같습니다. 모듈 안에만 존재합니다</span>
commit<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// store.commit와 같습니다.</span>
dispatch<span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// store.dispatch와 같습니다.</span>
getters <span class="token comment" spellcheck="true">// store.getters와 같습니다.</span>
<span class="token punctuation">}</span>
</code></pre>
<p><a href="actions.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>getters</strong></p>
<ul>
<li><p>자료형: <code>{ [key: string]: Function }</code></p>
<p>저장소에 getter를 등록하십시오. getter 함수는 다음 전달인자를 받습니다.</p>
<pre class="language-"><code>state, // 모듈에 정의 된 경우 모듈 로컬 상태가됩니다.
getters, // store.getters와 같습니다.
rootState // store.state와 같습니다.
</code></pre><p>등록된 getter는 <code>store.getters</code>에 노출됩니다.</p>
<p><a href="getters.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>modules</strong></p>
<ul>
<li><p>자료형: <code>Object</code></p>
<p>저장소에 병합될 하위 모듈을 포함하는 객체 입니다.</p>
<pre class="language-"><code class="lang-js"><span class="token punctuation">{</span>
key<span class="token punctuation">:</span> <span class="token punctuation">{</span>
state<span class="token punctuation">,</span>
mutations<span class="token punctuation">,</span>
actions<span class="token operator">?</span><span class="token punctuation">,</span>
getters<span class="token operator">?</span><span class="token punctuation">,</span>
modules<span class="token operator">?</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token operator">...</span>
<span class="token punctuation">}</span>
</code></pre>
<p>각 모듈은 루트 옵션과 비슷한 <code>state</code> 와 <code>mutations</code> 를 포함 할 수 있습니다. 모듈의 상태는 모듈의 키를 사용하여 저장소의 루트 상태에 연결됩니다. 모듈의 변이와 getter는 모듈의 로컬 상태를 루트 상태 대신 첫 번째 전달인자로 받으며 모듈 액션의 <code>context.state</code>도 로컬 상태를 가리 킵니다.</p>
<p><a href="modules.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>plugins</strong></p>
<ul>
<li><p>자료형: <code>Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>Function</span><span class="token punctuation">></span></span></code></p>
<p>저장소에 적용 할 플러그인 함수의 배열입니다. 플러그인은 저장소를 유일한 전달인자로 받아들이고 아웃바운드 데이터 지속성, 로깅 또는 디버깅을 위한 변이를 감시하거나 (인바운드 데이터 (예: 웹 소켓 또는 관찰 가능 항목)의 디스패치 변이) 감시할 수 있습니다.</p>
<p><a href="plugins.html">상세</a></p>
</li>
</ul>
</li>
<li><p><strong>strict</strong></p>
<ul>
<li>자료형: <code>Boolean</code></li>
<li><p>기본값: <code>false</code></p>
<p>Vuex 저장소를 strict 모드로 변경합니다. strict 모드에서 변이 핸들러 외부의 Vuex 상태에 대한 임의의 변이는 오류를 발생시킵니다.</p>
<p><a href="strict.html">상세</a></p>
</li>
</ul>
</li>
</ul>
<h3 id="vuexstore-인스턴스-속성">Vuex.Store 인스턴스 속성</h3>
<ul>
<li><p><strong>state</strong></p>
<ul>
<li><p>자료형: <code>Object</code></p>
<p>루트 상태. 읽기 전용</p>
</li>
</ul>
</li>
<li><p><strong>getters</strong></p>
<ul>
<li><p>자료형: <code>Object</code></p>
<p>등록된 getters 입니다. 읽기 전용.</p>
</li>
</ul>
</li>
</ul>
<h3 id="vuexstore-인스턴스-메소드">Vuex.Store 인스턴스 메소드</h3>
<ul>
<li><p><strong><code>commit(type: string, payload?: any) | commit(mutation: Object)</code></strong></p>
<p>변이를 커밋합니다. <a href="mutations.html">상세</a></p>
</li>
<li><p><strong><code>dispatch(type: string, payload?: any) | dispatch(action: Object)</code></strong></p>
<p>액션을 디스패치 합니다. 모든 트리거된 액션 핸들러를 처리하는 Promise를 반환합니다. <a href="actions.html">상세</a></p>
</li>
<li><p><strong><code>replaceState(state: Object)</code></strong></p>
<p>저장소의 루트 상태를 바꿉니다. 상태에 대한 상호작용/시점 변경 목적으로 만 사용하십시오.</p>
</li>
<li><p><strong><code>watch(getter: Function, cb: Function, options?: Object)</code></strong></p>
<p>getter 함수의 반환 값을 반응적으로 지켜보고 값이 변경되면 콜백을 호출합니다. getter는 저장소의 상태를 유일한 인수로받습니다. Vue의 <code>vm.$watch</code> 메소드와 같은 옵션을 취하는 옵션 객체를 받아들입니다.</p>
<p>감시를 중단하려면 반환된 핸들 함수를 호출하십시오.</p>
</li>
<li><p><strong><code>subscribe(handler: Function)</code></strong></p>
<p>저장소 변이를 구독합니다. <code>handler</code>는 모든 변이 이후 호출되고 변이 디스크립터와 변이 상태를 전달인자로 받습니다.</p>
<pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span><span class="token punctuation">(</span>mutation<span class="token punctuation">,</span> state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>mutation<span class="token punctuation">.</span>type<span class="token punctuation">)</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>mutation<span class="token punctuation">.</span>payload<span class="token punctuation">)</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<p>플러그인에서 가장 일반적으로 사용됩니다. <a href="plugins.html">상세</a></p>
</li>
<li><p><strong><code>registerModule(path: string | Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span>, module: Module)</code></strong></p>
<p>동적 모듈을 등록합니다. <a href="modules.html#dynamic-module-registration">상세</a></p>
</li>
<li><p><strong><code>unregisterModule(path: string | Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span>)</code></strong></p>
<p>동적 모듈을 해제 합니다. <a href="modules.html#dynamic-module-registration">상세</a></p>
</li>
<li><p><strong><code>hotUpdate(newOptions: Object)</code></strong></p>
<p>새 액션과 변이를 핫 스왑 합니다. <a href="hot-reload.html">상세</a></p>
</li>
</ul>
<h3 id="컴포넌트-바인딩-헬퍼">컴포넌트 바인딩 헬퍼</h3>
<ul>
<li><p><strong><code>mapState(map: Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span> | Object): Object</code></strong></p>
<p>Vuex 저장소의 하위 트리를 반환하는 컴포넌트 계산 옵션을 만듭니다. <a href="state.html#the-mapstate-helper">상세</a></p>
</li>
<li><p><strong><code>mapGetters(map: Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span> | Object): Object</code></strong></p>
<p>getter의 평가된 값을 반환하는 컴포넌트 계산 옵션을 만듭니다. <a href="getters.html#the-mapgetters-helper">상세</a></p>
</li>
<li><p><strong><code>mapActions(map: Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span> | Object): Object</code></strong></p>
<p>액션을 전달하는 컴포넌트 메소드 옵션을 만듭니다. <a href="actions.html#dispatching-actions-in-components">상세</a></p>
</li>
<li><p><strong><code>mapMutations(map: Array<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span><span class="token punctuation">></span></span> | Object): Object</code></strong></p>
<p>변이를 커밋하는 컴포넌트 메소드 옵션을 만듭니다. <a href="mutations.html#commiting-mutations-in-components">상세</a></p>
</li>
</ul>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
<script src="//m.servedby-buysellads.com/monetization.js" type="text/javascript"></script>
<div class="bsa-cpc"></div>
<script>
(function(){
if(typeof _bsa !== 'undefined' && _bsa) {
_bsa.init('default', 'CKYD62QM', 'placement:vuejsorg', {
target: '.bsa-cpc',
align: 'horizontal',
disable_css: 'true'
});
}
})();
</script>
</div>
<a href="hot-reload.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: 핫 리로딩">
<i class="fa fa-angle-left"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"API 레퍼런스","level":"1.14","depth":1,"previous":{"title":"핫 리로딩","level":"1.13","depth":1,"path":"hot-reload.md","ref":"hot-reload.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","prism","-highlight","github","-highlight","github"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/vuejs/vuex/"},"livereload":{},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/vuejs/vuex/tree/dev/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Vuex","language":"kr","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"2.x.x"},"file":{"path":"api.md","mtime":"2018-02-17T07:20:49.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-03-02T20:43:43.208Z"},"basePath":".","book":{"language":"kr"}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-livereload/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
</body>
</html>