codeclient with codmclient interfaces
This commit is contained in:
night0721
parent
c877947430
commit
679b9f7352
21 changed files with 487 additions and 201 deletions
566
LICENSE
566
LICENSE
|
|
@ -1,201 +1,429 @@
|
||||||
Apache License
|
Attribution-NonCommercial-ShareAlike 4.0 International
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
=======================================================================
|
||||||
|
|
||||||
1. Definitions.
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
Using Creative Commons Public Licenses
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
the copyright owner that is granting the License.
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
Considerations for licensors: Our public licenses are
|
||||||
other entities that control, are controlled by, or are under common
|
intended for use by those authorized to give the public
|
||||||
control with that entity. For the purposes of this definition,
|
permission to use material in ways otherwise restricted by
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
copyright and certain other rights. Our licenses are
|
||||||
direction or management of such entity, whether by contract or
|
irrevocable. Licensors should read and understand the terms
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
and conditions of the license they choose before applying it.
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
Considerations for the public: By using one of our public
|
||||||
exercising permissions granted by this License.
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More_considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
=======================================================================
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
|
||||||
transformation or translation of a Source form, including but
|
Public License
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
Object form, made available under the License, as indicated by a
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
copyright notice that is included in or attached to the work
|
Attribution-NonCommercial-ShareAlike 4.0 International Public License
|
||||||
(an example is provided in the Appendix below).
|
("Public License"). To the extent this Public License may be
|
||||||
|
interpreted as a contract, You are granted the Licensed Rights in
|
||||||
|
consideration of Your acceptance of these terms and conditions, and the
|
||||||
|
Licensor grants You such rights in consideration of benefits the
|
||||||
|
Licensor receives from making the Licensed Material available under
|
||||||
|
these terms and conditions.
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
Section 1 -- Definitions.
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
the original version of the Work and any modifications or additions
|
Rights that is derived from or based upon the Licensed Material
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
and in which the Licensed Material is translated, altered,
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
permission under the Copyright and Similar Rights held by the
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
means any form of electronic, verbal, or written communication sent
|
Material is a musical work, performance, or sound recording,
|
||||||
to the Licensor or its representatives, including but not limited to
|
Adapted Material is always produced where the Licensed Material is
|
||||||
communication on electronic mailing lists, source code control systems,
|
synched in timed relation with a moving image.
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
subsequently incorporated within the Work.
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
c. BY-NC-SA Compatible License means a license listed at
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
creativecommons.org/compatiblelicenses, approved by Creative
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
Commons as essentially the equivalent of this Public License.
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
closely related to copyright including, without limitation,
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
(except as stated in this section) patent license to make, have made,
|
Rights, without regard to how the rights are labeled or
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
categorized. For purposes of this Public License, the rights
|
||||||
where such license applies only to those patent claims licensable
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
by such Contributor that are necessarily infringed by their
|
Rights.
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
e. Effective Technological Measures means those measures that, in the
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
absence of proper authority, may not be circumvented under laws
|
||||||
modifications, and in Source or Object form, provided that You
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
meet the following conditions:
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
Derivative Works a copy of this License; and
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
g. License Elements means the license attributes listed in the name
|
||||||
stating that You changed the files; and
|
of a Creative Commons Public License. The License Elements of this
|
||||||
|
Public License are Attribution, NonCommercial, and ShareAlike.
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
h. Licensed Material means the artistic or literary work, database,
|
||||||
that You distribute, all copyright, patent, trademark, and
|
or other material to which the Licensor applied this Public
|
||||||
attribution notices from the Source form of the Work,
|
License.
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
i. Licensed Rights means the rights granted to You subject to the
|
||||||
distribution, then any Derivative Works that You distribute must
|
terms and conditions of this Public License, which are limited to
|
||||||
include a readable copy of the attribution notices contained
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
within such NOTICE file, excluding those notices that do not
|
Licensed Material and that the Licensor has authority to license.
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
may provide additional or different license terms and conditions
|
under this Public License.
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
k. NonCommercial means not primarily intended for or directed towards
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
commercial advantage or monetary compensation. For purposes of
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
this Public License, the exchange of the Licensed Material for
|
||||||
this License, without any additional terms or conditions.
|
other material subject to Copyright and Similar Rights by digital
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
file-sharing or similar means is NonCommercial provided there is
|
||||||
the terms of any separate license agreement you may have executed
|
no payment of monetary compensation in connection with the
|
||||||
with Licensor regarding such Contributions.
|
exchange.
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
l. Share means to provide material to the public by any means or
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
process that requires permission under the Licensed Rights, such
|
||||||
except as required for reasonable and customary use in describing the
|
as reproduction, public display, public performance, distribution,
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
m. Sui Generis Database Rights means rights other than copyright
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
as amended and/or succeeded, as well as other essentially
|
||||||
implied, including, without limitation, any warranties or conditions
|
equivalent rights anywhere in the world.
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
n. You means the individual or entity exercising the Licensed Rights
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
under this Public License. Your has a corresponding meaning.
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
Section 2 -- Scope.
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
a. License grant.
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
in part, for NonCommercial purposes only; and
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
b. produce, reproduce, and Share Adapted Material for
|
||||||
|
NonCommercial purposes only.
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
you may not use this file except in compliance with the License.
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
You may obtain a copy of the License at
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
4. Media and formats; technical modifications allowed. The
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
all media and formats whether now known or hereafter created,
|
||||||
See the License for the specific language governing permissions and
|
and to make technical modifications necessary to do so. The
|
||||||
limitations under the License.
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. Additional offer from the Licensor -- Adapted Material.
|
||||||
|
Every recipient of Adapted Material from You
|
||||||
|
automatically receives an offer from the Licensor to
|
||||||
|
exercise the Licensed Rights in the Adapted Material
|
||||||
|
under the conditions of the Adapter's License You apply.
|
||||||
|
|
||||||
|
c. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties, including when
|
||||||
|
the Licensed Material is used other than for NonCommercial
|
||||||
|
purposes.
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.
|
||||||
|
|
||||||
|
In addition to the conditions in Section 3(a), if You Share
|
||||||
|
Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter's License You apply must be a Creative Commons
|
||||||
|
license with the same License Elements, this version or
|
||||||
|
later, or a BY-NC-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the
|
||||||
|
Adapter's License You apply. You may satisfy this condition
|
||||||
|
in any reasonable manner based on the medium, means, and
|
||||||
|
context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms
|
||||||
|
or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, Adapted Material that restrict exercise of the
|
||||||
|
rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database for NonCommercial purposes
|
||||||
|
only;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material,
|
||||||
|
including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public
|
||||||
|
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||||
|
its public licenses to material it publishes and in those instances
|
||||||
|
will be considered the “Licensor.” The text of the Creative Commons
|
||||||
|
public licenses is dedicated to the public domain under the CC0 Public
|
||||||
|
Domain Dedication. Except for the limited purpose of indicating that
|
||||||
|
material is shared under a Creative Commons public license or as
|
||||||
|
otherwise permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the
|
||||||
|
public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
<h1 align="center"> CATH </h1>
|
<h1 align="center"> CATH </h1>
|
||||||
|
|
||||||
<!-- header -->
|
<!-- header -->
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
|
@ -14,7 +14,6 @@
|
||||||
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
**Cath** is a powerful [Node.js](https://nodejs.org) module that can easily interact and get data from the Cath API
|
**Cath** is a powerful [Node.js](https://nodejs.org) module that can easily interact and get data from the Cath API
|
||||||
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> **Star** and **fork** this repository.<br><br>
|
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> **Star** and **fork** this repository.<br><br>
|
||||||
|
|
||||||
|
|
@ -22,13 +21,13 @@ If you like this package, feel free to <img src = "https://discord.com/assets/14
|
||||||
|
|
||||||
Download from npm
|
Download from npm
|
||||||
|
|
||||||
```cli
|
```powershell
|
||||||
npm install cath
|
npm install cath
|
||||||
```
|
```
|
||||||
|
|
||||||
Download from yarn
|
Download from yarn
|
||||||
|
|
||||||
```cli
|
```powershell
|
||||||
yarn add cath
|
yarn add cath
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
:root {
|
:root {
|
||||||
--light-hl-0: #0000FF;
|
--light-hl-0: #000000;
|
||||||
--dark-hl-0: #569CD6;
|
--dark-hl-0: #D4D4D4;
|
||||||
--light-hl-1: #000000;
|
--light-hl-1: #0000FF;
|
||||||
--dark-hl-1: #D4D4D4;
|
--dark-hl-1: #569CD6;
|
||||||
--light-hl-2: #0070C1;
|
--light-hl-2: #0070C1;
|
||||||
--dark-hl-2: #4FC1FF;
|
--dark-hl-2: #4FC1FF;
|
||||||
--light-hl-3: #795E26;
|
--light-hl-3: #795E26;
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CODMClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CODMClient.html">CODMClient</a></li></ul><h1>Class CODMClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>APIClient</p>
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CODMClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CODMClient.html">CODMClient</a></li></ul><h1>Class CODMClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>APIClient</p>
|
||||||
</dd><dt>kind</dt><dd><p>constructor</p>
|
</dd><dt>kind</dt><dd><p>constructor</p>
|
||||||
</dd><dt>param key</dt><dd><p>Authorization Key for API (Only for CODM commands)</p>
|
</dd><dt>param key</dt><dd><p>Authorization Key for API (Only for CODM commands)</p>
|
||||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CODMClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new CODMClient<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:9</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="key" class="tsd-anchor"></a><h3>key</h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getperk" class="tsd-anchor"></a><h3>getperk</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getperk<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CODMClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new CODMClient<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:10</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CODMClient.html" class="tsd-signature-type" data-tsd-kind="Class">CODMClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="key" class="tsd-anchor"></a><h3>key</h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getperk" class="tsd-anchor"></a><h3>getperk</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getperk<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PerkData.html" class="tsd-signature-type" data-tsd-kind="Interface">PerkData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CODMClient/codmclient.ts:19</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends a CODM perk object</p>
|
<p>Sends a CODM perk object</p>
|
||||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CODMClient.html" class="tsd-kind-icon">CODMClient</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/PerkData.html" class="tsd-signature-type" data-tsd-kind="Interface">PerkData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CODMClient.html" class="tsd-kind-icon">CODMClient</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CODMClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CODMClient.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CODMClient.html#getperk" class="tsd-kind-icon">getperk</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
6
docs/classes/CodeClient.html
Normal file
6
docs/classes/CodeClient.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CodeClient | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CodeClient.html">CodeClient</a></li></ul><h1>Class CodeClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>name</dt><dd><p>CodeClient</p>
|
||||||
|
</dd><dt>kind</dt><dd><p>constructor</p>
|
||||||
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CodeClient</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CodeClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CodeClient.html#createBin" class="tsd-kind-icon">create<wbr/>Bin</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Code<wbr/>Client<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CodeClient.html" class="tsd-signature-type" data-tsd-kind="Class">CodeClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.ts:9</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="CodeClient.html" class="tsd-signature-type" data-tsd-kind="Class">CodeClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="createBin" class="tsd-anchor"></a><h3>create<wbr/>Bin</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Bin<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span>, description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CodeData.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeData</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.ts:17</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
|
<p>Sends the link of the code</p>
|
||||||
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">String</span></h5></li><li><h5>description: <span class="tsd-signature-type">String</span></h5></li><li><h5>code: <span class="tsd-signature-type">String</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CodeData.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CodeClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CodeClient.html#createBin" class="tsd-kind-icon">create<wbr/>Bin</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><h1 align="center"> CATH </h1>
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><h1 align="center"> CATH </h1>
|
||||||
|
|
||||||
<!-- header -->
|
<!-- header -->
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
|
@ -14,7 +14,6 @@
|
||||||
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
<a href="https://npmjs.org/package/cath" target="_blank"><img alt='Node Package' src="https://nodei.co/npm/cath.png"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<p><strong>Cath</strong> is a powerful <a href="https://nodejs.org">Node.js</a> module that can easily interact and get data from the Cath API
|
<p><strong>Cath</strong> is a powerful <a href="https://nodejs.org">Node.js</a> module that can easily interact and get data from the Cath API
|
||||||
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> <strong>Star</strong> and <strong>fork</strong> this repository.<br><br></p>
|
If you like this package, feel free to <img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16"> <strong>Star</strong> and <strong>fork</strong> this repository.<br><br></p>
|
||||||
|
|
||||||
|
|
@ -22,10 +21,10 @@ If you like this package, feel free to <img src = "https://discord.com/assets/14
|
||||||
<h1>Install the package ✔</h1>
|
<h1>Install the package ✔</h1>
|
||||||
</a>
|
</a>
|
||||||
<p>Download from npm</p>
|
<p>Download from npm</p>
|
||||||
<pre><code class="language-cli">npm install cath
|
<pre><code class="language-powershell"><span class="hl-0">npm install cath</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Download from yarn</p>
|
<p>Download from yarn</p>
|
||||||
<pre><code class="language-cli">yarn add cath
|
<pre><code class="language-powershell"><span class="hl-0">yarn add cath</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
||||||
|
|
@ -35,7 +34,7 @@ If you like this package, feel free to <img src = "https://discord.com/assets/14
|
||||||
<a href="#launch-of-the-module" id="launch-of-the-module" style="color: inherit; text-decoration: none;">
|
<a href="#launch-of-the-module" id="launch-of-the-module" style="color: inherit; text-decoration: none;">
|
||||||
<h3>Launch of the module</h3>
|
<h3>Launch of the module</h3>
|
||||||
</a>
|
</a>
|
||||||
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">cath</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">"cath"</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">reddit_data</span><span class="hl-1"> = </span><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">cath</span><span class="hl-1">.</span><span class="hl-3">getreddit</span><span class="hl-1">(</span><span class="hl-4">"meme"</span><span class="hl-1">);</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">reddit_data</span><span class="hl-1">); </span><span class="hl-7">// returns an object</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">answer</span><span class="hl-1"> = </span><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">cath</span><span class="hl-1">.</span><span class="hl-3">random8ball</span><span class="hl-1">();</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">answer</span><span class="hl-1">); </span><span class="hl-7">// a random answer from 8ball</span>
|
<pre><code class="language-js"><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">cath</span><span class="hl-0"> = </span><span class="hl-3">require</span><span class="hl-0">(</span><span class="hl-4">"cath"</span><span class="hl-0">);</span><br/><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">reddit_data</span><span class="hl-0"> = </span><span class="hl-5">await</span><span class="hl-0"> </span><span class="hl-6">cath</span><span class="hl-0">.</span><span class="hl-3">getreddit</span><span class="hl-0">(</span><span class="hl-4">"meme"</span><span class="hl-0">);</span><br/><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-6">reddit_data</span><span class="hl-0">); </span><span class="hl-7">// returns an object</span><br/><br/><span class="hl-1">const</span><span class="hl-0"> </span><span class="hl-2">answer</span><span class="hl-0"> = </span><span class="hl-5">await</span><span class="hl-0"> </span><span class="hl-6">cath</span><span class="hl-0">.</span><span class="hl-3">random8ball</span><span class="hl-0">();</span><br/><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-3">log</span><span class="hl-0">(</span><span class="hl-6">answer</span><span class="hl-0">); </span><span class="hl-7">// a random answer from 8ball</span>
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<a href="#support-feature-request-amp-bug-reports" id="support-feature-request-amp-bug-reports" style="color: inherit; text-decoration: none;">
|
<a href="#support-feature-request-amp-bug-reports" id="support-feature-request-amp-bug-reports" style="color: inherit; text-decoration: none;">
|
||||||
|
|
@ -55,4 +54,4 @@ To Request new features contact us on Discord using the support server.</p>
|
||||||
<p align = "center">
|
<p align = "center">
|
||||||
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
|
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
|
||||||
</p>
|
</p>
|
||||||
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
||||||
1
docs/interfaces/CodeData.html
Normal file
1
docs/interfaces/CodeData.html
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CodeData | cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cath</a></li><li><a href="CodeData.html">CodeData</a></li></ul><h1>Interface CodeData</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CodeData</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CodeData.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in CodeClient/codeclient.interface.ts:2</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CodeData.html#url" class="tsd-kind-icon">url</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||||
1
docs/interfaces/PerkData.html
Normal file
1
docs/interfaces/PerkData.html
Normal file
File diff suppressed because one or more lines are too long
1
docs/interfaces/RedditObject.html
Normal file
1
docs/interfaces/RedditObject.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
||||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="getreddit" class="tsd-anchor"></a><h3>getreddit</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">getreddit<span class="tsd-signature-symbol">(</span>sub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/reddit.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="getreddit" class="tsd-anchor"></a><h3>getreddit</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">getreddit<span class="tsd-signature-symbol">(</span>sub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/RedditObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RedditObject</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/reddit.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends an embed of reddit</p>
|
<p>Sends an embed of reddit</p>
|
||||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sub: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sub: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/RedditObject.html" class="tsd-signature-type" data-tsd-kind="Interface">RedditObject</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||||
<p>Sends a 8ball response</p>
|
<p>Sends a 8ball response</p>
|
||||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/CodeClient.html" class="tsd-kind-icon">Code<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/CodeData.html" class="tsd-kind-icon">Code<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/PerkData.html" class="tsd-kind-icon">Perk<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/RedditObject.html" class="tsd-kind-icon">Reddit<wbr/>Object</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "cath",
|
"name": "cath",
|
||||||
"version": "1.3.0",
|
"version": "1.3.2-dev",
|
||||||
"description": "A powerful package that can interact with Cath API",
|
"description": "A powerful package that can interact with Cath API",
|
||||||
"main": "./dist/index.js",
|
"main": "./dist/index.js",
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
|
|
|
||||||
|
|
@ -4,3 +4,9 @@ export interface CODMClientOptions {
|
||||||
*/
|
*/
|
||||||
key: string;
|
key: string;
|
||||||
}
|
}
|
||||||
|
export interface PerkData {
|
||||||
|
name: string;
|
||||||
|
perk: string;
|
||||||
|
effects: string;
|
||||||
|
type: string;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
import axios from "axios";
|
import axios from "axios";
|
||||||
import config from "../utils/config.json";
|
import config from "../utils/config.json";
|
||||||
|
import { PerkData } from "./codmclient.interface";
|
||||||
/**
|
/**
|
||||||
* @name APIClient
|
* @name APIClient
|
||||||
* @kind constructor
|
* @kind constructor
|
||||||
|
|
@ -12,10 +13,10 @@ export class CODMClient {
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Sends a CODM perk object
|
* Sends a CODM perk object
|
||||||
* @return {Promise<Object>}
|
* @return {Promise<PerkData>}
|
||||||
* @param {String} name
|
* @param {String} name
|
||||||
*/
|
*/
|
||||||
public async getperk(name: string): Promise<object> {
|
public async getperk(name: string): Promise<PerkData> {
|
||||||
const data = await axios
|
const data = await axios
|
||||||
.get(`${config.api}/api/v1/codm/perks?name=${name}`, {
|
.get(`${config.api}/api/v1/codm/perks?name=${name}`, {
|
||||||
headers: {
|
headers: {
|
||||||
|
|
|
||||||
|
|
@ -1,2 +1,2 @@
|
||||||
export { CODMClientOptions } from "./codmclient.interface";
|
export { CODMClientOptions, PerkData } from "./codmclient.interface";
|
||||||
export { CODMClient } from "./codmclient";
|
export { CODMClient } from "./codmclient";
|
||||||
|
|
|
||||||
3
src/CodeClient/codeclient.interface.ts
Normal file
3
src/CodeClient/codeclient.interface.ts
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
export interface CodeData {
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
31
src/CodeClient/codeclient.ts
Normal file
31
src/CodeClient/codeclient.ts
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
import axios from "axios";
|
||||||
|
import config from "../utils/config.json";
|
||||||
|
import { CodeData } from "./codeclient.interface";
|
||||||
|
/**
|
||||||
|
* @name CodeClient
|
||||||
|
* @kind constructor
|
||||||
|
*/
|
||||||
|
export class CodeClient {
|
||||||
|
constructor() {}
|
||||||
|
/**
|
||||||
|
* Sends the link of the code
|
||||||
|
* @return {Promise<Data>}
|
||||||
|
* @param {String} title
|
||||||
|
* @param {String} description
|
||||||
|
* @param {String} code
|
||||||
|
*/
|
||||||
|
public async createBin(
|
||||||
|
title: String,
|
||||||
|
description: String,
|
||||||
|
code: String
|
||||||
|
): Promise<CodeData> {
|
||||||
|
const data = await axios
|
||||||
|
.post(`${config.code}/botcreate`, {
|
||||||
|
title,
|
||||||
|
description,
|
||||||
|
code,
|
||||||
|
})
|
||||||
|
.then(res => res.data);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
}
|
||||||
2
src/CodeClient/index.ts
Normal file
2
src/CodeClient/index.ts
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
export { CodeData } from "./codeclient.interface";
|
||||||
|
export { CodeClient } from "./codeclient";
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
import axios from "axios";
|
import axios from "axios";
|
||||||
/**
|
/**
|
||||||
* Sends an embed of reddit
|
* Sends an embed of reddit
|
||||||
* @return {Promise<Object>}
|
* @return {Promise<RedditObject>}
|
||||||
*/
|
*/
|
||||||
export async function getreddit(sub: string): Promise<object> {
|
export async function getreddit(sub: string): Promise<RedditObject> {
|
||||||
const content = await axios
|
const content = await axios
|
||||||
.get(`https://www.reddit.com/r/${sub}/random/.json`)
|
.get(`https://www.reddit.com/r/${sub}/random/.json`)
|
||||||
.then(res => res.data);
|
.then(res => res.data);
|
||||||
|
|
@ -14,11 +14,17 @@ export async function getreddit(sub: string): Promise<object> {
|
||||||
let memeUpvotes = content[0].data.children[0].data.ups;
|
let memeUpvotes = content[0].data.children[0].data.ups;
|
||||||
let memeDownvotes = content[0].data.children[0].data.downs;
|
let memeDownvotes = content[0].data.children[0].data.downs;
|
||||||
let memeNumComments = content[0].data.children[0].data.num_comments;
|
let memeNumComments = content[0].data.children[0].data.num_comments;
|
||||||
const obj: object = {
|
const obj: RedditObject = {
|
||||||
title: `A cat image | ${memeTitle}`,
|
title: memeTitle,
|
||||||
url: `${memeURL}`,
|
url: memeURL,
|
||||||
image: memeImage,
|
image: memeImage,
|
||||||
footer: ` 👍 ${memeUpvotes} 💬 ${memeNumComments}`,
|
footer: ` 👍 ${memeUpvotes} 💬 ${memeNumComments}`,
|
||||||
};
|
};
|
||||||
return obj;
|
return obj;
|
||||||
}
|
}
|
||||||
|
export interface RedditObject {
|
||||||
|
title: String;
|
||||||
|
url: String;
|
||||||
|
image: String;
|
||||||
|
footer: String;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
export { CODMClient, CODMClientOptions } from "./CODMClient/index";
|
export { CODMClient, CODMClientOptions, PerkData } from "./CODMClient/index";
|
||||||
export {
|
export {
|
||||||
StarboardClient,
|
StarboardClient,
|
||||||
StarboardClientOptions,
|
StarboardClientOptions,
|
||||||
|
|
@ -6,5 +6,6 @@ export {
|
||||||
StarboardGuildOptions,
|
StarboardGuildOptions,
|
||||||
starMessageData,
|
starMessageData,
|
||||||
} from "./StarboardClient/index";
|
} from "./StarboardClient/index";
|
||||||
|
export { CodeClient, CodeData } from "./CodeClient/index";
|
||||||
export { random8ball } from "./functions/8ball";
|
export { random8ball } from "./functions/8ball";
|
||||||
export { getreddit } from "./functions/reddit";
|
export { getreddit, RedditObject } from "./functions/reddit";
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
{
|
{
|
||||||
"api": "https://api.cath.gq"
|
"api": "https://api.cath.gq",
|
||||||
|
"code": "https://code.cath.gq"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue