n8n/packages/nodes-base/nodes/Reddit/SubredditDescription.ts
Iván Ovejero 3a9c7acb04
refactor(nodes-base): Apply lint rule node-param-operation-option-description-wrong-for-get-many (#4064)
* 👕 Enable rule

* ⬆️ Upgrade linter

* 📦 Update `package-lock.json`

* 👕 Apply rule

* ✏️ Fix plurals

* ✏️ More typos

* ✏️ Final typos
2022-09-13 12:36:36 +02:00

139 lines
2.6 KiB
TypeScript

import { INodeProperties } from 'n8n-workflow';
export const subredditOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'get',
options: [
{
name: 'Get',
value: 'get',
description: 'Retrieve background information about a subreddit',
action: 'Get a subreddit',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Retrieve information about many subreddits',
action: 'Get many subreddits',
},
],
displayOptions: {
show: {
resource: ['subreddit'],
},
},
},
];
export const subredditFields: INodeProperties[] = [
// ----------------------------------
// subreddit: get
// ----------------------------------
{
displayName: 'Content',
name: 'content',
type: 'options',
required: true,
default: 'about',
description: 'Subreddit content to retrieve',
options: [
{
name: 'About',
value: 'about',
},
{
name: 'Rules',
value: 'rules',
},
],
displayOptions: {
show: {
resource: ['subreddit'],
operation: ['get'],
},
},
},
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'The name of subreddit to retrieve the content from',
displayOptions: {
show: {
resource: ['subreddit'],
operation: ['get'],
},
},
},
// ----------------------------------
// subreddit: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: ['subreddit'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 100,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: ['subreddit'],
operation: ['getAll'],
returnAll: [false],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Keyword',
name: 'keyword',
type: 'string',
default: '',
description: 'The keyword for the subreddit search',
},
{
displayName: 'Trending',
name: 'trending',
type: 'boolean',
default: false,
description: 'Whether to fetch currently trending subreddits in all of Reddit',
},
],
displayOptions: {
show: {
resource: ['subreddit'],
operation: ['getAll'],
},
},
},
];