@publish-cms/type
Version:
Publish CMS Core Type
193 lines (156 loc) • 5.75 kB
Markdown
<div id="top"></div>
<!-- PROJECT SHIELDS -->
<div align="center">
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
</div>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://publish.vn">
<img src="logo.png" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Publish CMS Const</h3>
<p align="center">
<br />
<a href="#"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://publish.vn">Website</a>
·
<a href="https://github.com/publish-cms/type/issues">Report Bug</a>
·
<a href="https://github.com/publish-cms/type/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<summary>Table of Contents</summary>
<ol>
<li><a href="#install">Install</a></li>
<li><a href="#app">App</a></li>
<li><a href="#auth">Auth</a></li>
<li><a href="#banner">Banner</a></li>
<li><a href="#category">Category</a></li>
<li><a href="#followalong">Followalong</a></li>
<li><a href="#global">Global</a></li>
<li><a href="#hashtag">Hashtag</a></li>
<li><a href="#link">Link</a></li>
<li><a href="#media">Media</a></li>
<li><a href="#menu">Menu</a></li>
<li><a href="#option">Option</a></li>
<li><a href="#party">Party</a></li>
<li><a href="#post">Post</a></li>
<li><a href="#subscriber">Subscriber</a></li>
<li><a href="#user">User</a></li>
</ol>
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Install
- npm
```sh
npm install @publish-cms/type
```
## App
<ul>
<li><a href="/src/app/index.ts#L3">IApp</a></li>
<li><a href="/src/app/index.ts#L20">IAppMeta</a></li>
<li><a href="/src/app/index.ts#L28">IAppRole</a></li>
<li><a href="/src/app/index.ts#L42">IAppRoleUser</a></li>
<li><a href="/src/app/index.ts#L50">IAppPermission</a></li>
<li><a href="/src/app/index.ts#L59">EAppStatus</a></li>
<li><a href="/src/app/index.ts#L64">EAppPermissionKey</a></li>
</ul>
## Auth
<ul>
<li><a href="/src/auth/index.ts#L1">EAppPatternName</a></li>
<li><a href="/src/auth/index.ts#L12">EAuthPatternName</a></li>
<li><a href="/src/auth/index.ts#L27">EnumEmailPatternName</a></li>
<li><a href="/src/auth/index.ts#L36">ERolePatternName</a></li>
<li><a href="/src/auth/index.ts#L46">EUserPatternName</a></li>
</ul>
## Banner
<ul>
<li><a href="/src/banner/index.ts#L3">IBanner</a></li>
<li><a href="/src/banner/index.ts#L15">IBannerMeta</a></li>
<li><a href="/src/banner/index.ts#L24">IBannerNative</a></li>
<li><a href="/src/banner/index.ts#L31">IBannerContent</a></li>
<li><a href="/src/banner/index.ts#L37">EBannerKey</a></li>
<li><a href="/src/banner/index.ts#L43">EBannerPosition</a></li>
<li><a href="/src/banner/index.ts#L49">EBannerType</a></li>
</ul>
## Category
<ul>
<li><a href="/src/category/index.ts#L5">ICategory</a></li>
</ul>
## Followalong
<ul>
<li><a href="/src/followalong/index.ts#L6">IFollowAlong</a></li>
<li><a href="/src/followalong/index.ts#L25">IFollowAlongMeta</a></li>
</ul>
## Global
<ul>
<li><a href="/src/global/index.ts">ISiteInfo</a></li>
<li><a href="/src/global/index.ts">IHeadContent</a></li>
<li><a href="/src/global/index.ts">ITopSearch</a></li>
</ul>
## Hashtag
<ul>
<li><a href="/src/hashtag/index.ts">IHashtag</a></li>
</ul>
## Link
<ul>
<li><a href="/src/link/index.ts">ILink</a></li>
<li><a href="/src/link/index.ts">ILinkMeta</a></li>
<li><a href="/src/link/index.ts">ELinkType</a></li>
</ul>
## Media
<ul>
<li>
<a href="/src/media/index.ts">IMedia</a>
</li>
</ul>
## Option
<ul>
<li><a href="/src/option/index.ts">IOption</a></li>
<li><a href="/src/option/index.ts">ICallToAction</a></li>
<li><a href="/src/option/index.ts">EOptionKey</a></li>
<li><a href="/src/option/index.ts">ICustomGrid</a></li>
<li><a href="/src/option/index.ts">ECustomGridType</a></li>
</ul>
## Party
<ul>
<li><a href="/src/party/index.ts">IParty</a></li>
<li><a href="/src/party/index.ts">EPartyType</a></li>
<li><a href="/src/party/index.ts">EPartyStatus</a></li>
</ul>
## Post
<ul>
<li><a href="/src/post/index.ts">IPost</a></li>
<li><a href="/src/post/index.ts">IPostMeta</a></li>
<li><a href="/src/post/index.ts">IPostRelated</a></li>
<li><a href="/src/post/index.ts">IPostRelationCategory</a></li>
</ul>
## Subscriber
<ul>
<li><a href="/src/subscriber/index.ts">ISubscriber</a></li>
</ul>
## User
<ul>
<li><a href="/src/user/index.ts">IUser</a></li>
<li><a href="/src/user/index.ts">IUserMeta</a></li>
<li><a href="/src/user/index.ts">IUserRole</a></li>
<li><a href="/src/user/index.ts">EUserStatus</a></li>
</ul>
[contributors-shield]: https://img.shields.io/github/contributors/publish-cms/type.svg?style=for-the-badge
[contributors-url]: https://github.com/publish-cms/type/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/publish-cms/type.svg?style=for-the-badge
[forks-url]: https://github.com/publish-cms/type/network/members
[stars-shield]: https://img.shields.io/github/stars/publish-cms/type.svg?style=for-the-badge
[stars-url]: https://github.com/publish-cms/type/stargazers
[issues-shield]: https://img.shields.io/github/issues/publish-cms/type.svg?style=for-the-badge
[issues-url]: https://github.com/publish-cms/type/issues
[license-shield]: https://img.shields.io/github/license/publish-cms/type.svg?style=for-the-badge
[license-url]: https://github.com/publish-cms/type/blob/master/LICENSE