Skip to content

Commit

Permalink
docs: fix function names used in examples (#228)
Browse files Browse the repository at this point in the history
fix #227

<!-- 馃憢 Hi, thanks for sending a PR to ts-api-utils! 馃挅.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #227
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/ts-api-utils/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/ts-api-utils/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Fixes examples.
  • Loading branch information
RebeccaStevens committed Jun 16, 2023
1 parent e329c43 commit ef35c44
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion src/comments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export type ForEachCommentCallback = (
* ```ts
* declare const node: ts.Node;
*
* tsutils.forEachComment(node, (fullText, comment) => {
* forEachComment(node, (fullText, comment) => {
* console.log(`Found comment at position ${comment.pos}: '${fullText}'.`);
* });
* ```
Expand Down
24 changes: 12 additions & 12 deletions src/types/typeGuards/intrinsic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export interface IntrinsicAnyType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isAnyType(type)) {
* if (isIntrinsicAnyType(type)) {
* // ...
* }
* ```
Expand All @@ -45,7 +45,7 @@ export interface IntrinsicBooleanType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isBooleanType(type)) {
* if (isIntrinsicBooleanType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -73,7 +73,7 @@ export interface IntrinsicBigIntType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isBigIntType(type)) {
* if (isIntrinsicBigIntType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -101,7 +101,7 @@ export interface IntrinsicESSymbolType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isESSymbolType(type)) {
* if (isIntrinsicESSymbolType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -173,7 +173,7 @@ export interface IntrinsicNeverType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isNeverType(type)) {
* if (isIntrinsicNeverType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -203,7 +203,7 @@ export interface IntrinsicNonPrimitiveType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isNeverType(type)) {
* if (isIntrinsicNonPrimitiveType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -231,7 +231,7 @@ export interface IntrinsicNullType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isNullType(type)) {
* if (isIntrinsicNullType(type)) {
* // ...
* }
* ```
Expand All @@ -257,7 +257,7 @@ export interface IntrinsicNumberType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isNumberType(type)) {
* if (isIntrinsicNumberType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -285,7 +285,7 @@ export interface IntrinsicStringType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isStringType(type)) {
* if (isIntrinsicStringType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -313,7 +313,7 @@ export interface IntrinsicUndefinedType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isUndefinedType(type)) {
* if (isIntrinsicUndefinedType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -341,7 +341,7 @@ export interface IntrinsicUnknownType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isUnknownType(type)) {
* if (isIntrinsicUnknownType(type)) {
* // ...
* }
* ```
Expand Down Expand Up @@ -369,7 +369,7 @@ export interface IntrinsicVoidType extends IntrinsicType {
* ```ts
* declare const type: ts.Type;
*
* if (isVoidType(type)) {
* if (isIntrinsicVoidType(type)) {
* // ...
* }
* ```
Expand Down
2 changes: 1 addition & 1 deletion src/types/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import {
* ```ts
* declare const type: ts.Type;
*
* if (isConditionalType(type)) {
* if (isFalsyType(type)) {
* // ...
* }
* ```
Expand Down

0 comments on commit ef35c44

Please sign in to comment.