https://github.com/artdecocode/medium

The Posts On Medium.
https://github.com/artdecocode/medium

Last synced: 3 months ago
JSON representation

The Posts On Medium.

• Host: GitHub
• URL: https://github.com/artdecocode/medium
• Owner: artdecocode
• License: mit
• Created: 2019-02-04T09:06:19.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-07T20:26:45.000Z (almost 7 years ago)
• Last Synced: 2025-01-08T06:32:26.432Z (about 1 year ago)
• Language: CSS
• Homepage: https://artdecocode.github.io/medium/
• Size: 1.21 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @artdeco/medium

[![npm version](https://badge.fury.io/js/@artdeco/medium.svg)](https://npmjs.org/package/@artdeco/medium)

`@artdeco/medium` is The Posts On Medium.

```sh

yarn add -E @artdeco/medium

```

## Table Of Contents

- [Table Of Contents](#table-of-contents)

- [API](#api)

- [`medium(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)

  * [`Config`](#type-config)

- [Copyright](#copyright)



## API

The package is available by importing its default function:

```js

import medium from '@artdeco/medium'

```



## `medium(`
  `arg1: string,`
  `arg2?: boolean,`
`): void`

Call this function to get the result you want.

__`Config`__: Options for the program.

|   Name    |   Type    |    Description    | Default |

| --------- | --------- | ----------------- | ------- |

| shouldRun | _boolean_ | A boolean option. | `true`  |

| __text*__ | _string_  | A text to return. | -       |

```js

/* yarn example/ */

import medium from '@artdeco/medium'

(async () => {

  const res = await medium({

    text: 'example',

  })

  console.log(res)

})()

```

```

example

```



## Copyright

(c) [Art Deco][1] 2019

[1]: https://artd.eco